Legacy:Functions/Map

From Spherical
< Legacy:Functions
Revision as of 23:49, 1 June 2013 by Apollolux (talk | contribs) (Reformat for new convention)
Jump to: navigation, search

Map and map engine control

  • MapEngine(map_filename, fps): Start the map engine at map_filename at speed fps.
  • GetCurrentMap(): Get the filename of the loaded map.
  • ChangeMap(map_filename): Change the current map of the map engine.
  • IsMapEngineRunning(): Check if the map engine is running or not.
  • UpdateMapEngine(): Update state of map entities, animations and events in map engine.
  • ExitMapEngine(): Flag the map engine to exit on the next update.

Map object

  • Sphere Map object: Holds map data.

Map scripts

  • API:CallMapScript(map_event): Call map script associated with the current map.
  • API:CallDefaultMapScript(map_event): Call map script set by SetDefaultMapScript().
  • API:SetDefaultMapScript(map_event, script): Set map engine to run script when map_event occurs for any map.
    • Map event constants:
      SCRIPT_ON_ENTER_MAP
      SCRIPT_ON_LEAVE_MAP
      SCRIPT_ON_LEAVE_MAP_NORTH
      SCRIPT_ON_LEAVE_MAP_EAST
      SCRIPT_ON_LEAVE_MAP_SOUTH
      SCRIPT_ON_LEAVE_MAP_WEST

Within the map engine

  • API:SetColorMask(color, frames): Draws color over the map engine for frames duration.

Maps

API:Functions/Map/Zones

API:Functions/Map/Triggers

API:Functions/Map/Layers

API:Functions/Map/Tiles

Input

API:Functions/Map/Input

Camera

API:Functions/Map/Camera

Persons

API:Functions/Map/Entities