wiki/ScriptingPlatform.md

__NOTOC__

Summary

A Moving platform that was given a name can be controlled by scripts. It is moving along a specified path.

Instances

An instance is created by being defined in a level. It may be accessed via its name from scripts and via sector.name from the console.

Example

Example of a definition:

  (platform
    (name "PLATFORM1")
    (running #f)
    (sprite "images/objects/platforms/vertical-wood.sprite")
    (path
      (mode "circular")
      (node
        (x 832)
        (y 800)
      )
      (node
        (x 832)
        (y 704)
      )
    )
  ) 

The above object will be exposed under the name PLATFORM1 in the scripting engine. Example usage:

  PLATFORM1.goto_node(0);

From console:

  sector.PLATFORM1.goto_node(1);

Methods

goto_node(int node_no)	advance until at given node, then stop.
start_moving()	start advancing automatically
stop_moving()	stop advancing automatically

Constants

None

Template:Navbox Scripting reference

Category:Scripting Reference