CallDefaultMapScript

From Spheriki

Jump to: navigation, search

Calls a map script previously set by SetDefaultMapScript.


Contents

[edit]

Usage

CallDefaultMapScript(which_script);
  • which_script Map script constant. The script to call. One of:
    • 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


[edit]

Examples

Feel free to add an example or two here.


[edit]

Notes

  • The map engine does not need to be running to use this function.
  • Default map scripts which are set are normally called automatically by Sphere's map engine. This function allows you to run such a map script yourself if you need to.
  • A default map script is run regardless of which map is loaded, whereas regular map scripts only run when map events happen while they are loaded. If a regular map script and default map script are defined for the same map event, then the default script will be run before the map-specific script. (This needs to be verified.)


[edit]

See also

Retrieved from "http://www.spheredev.org/wiki/CallDefaultMapScript"
Personal tools