StartScript: Difference between revisions

From Eternity Wiki
Jump to navigationJump to search
No edit summary
(deprecated -> obsolete)
Line 4: Line 4:
*''scriptnum'': Number of script to call.
*''scriptnum'': Number of script to call.
*''selectvm'': Virtual machine to use:
*''selectvm'': Virtual machine to use:
**{{deprecated}}0 or '''gamescript''': [[Small]] game (global) script.
**('''obsolete''')0 or '''gamescript''': [[Small]] game (global) script.
**{{deprecated}}1 or '''levelscript''': Small level (map) script.
**('''obsolete''')1 or '''levelscript''': Small level (map) script.
**2 or '''acs''': Action Code Script (inherited from Hexen). Currently the only supported script VM.
**2 or '''acs''': Action Code Script (inherited from Hexen). Currently the only supported script VM.
*''params'': Up to three parameters for the called script function.|notes=
*''params'': Up to three parameters for the called script function.|notes=
The semantic difference between '''PlayerStartScript''' and '''StartScript''' is that the former considers the call as being made from a player weapon, while this is called from a map object. Currently only '''StartScript''' can call ACS scripts.|seealso=
The semantic difference between '''PlayerStartScript''' and '''StartScript''' is that the former considers the call as being made from a player weapon, while this is called from a map object. Currently only '''StartScript''' can call ACS scripts.|seealso=
*[[PlayerStartScript]]}}
*[[PlayerStartScript]]}}

Revision as of 14:08, 5 February 2013

Description

Used from EDF frames to call scripts.

Usage

StartScript(scriptnum, selectvm, params[0], params[1], params[2])

Parameters

  • scriptnum: Number of script to call.
  • selectvm: Virtual machine to use:
    • (obsolete)0 or gamescript: Small game (global) script.
    • (obsolete)1 or levelscript: Small level (map) script.
    • 2 or acs: Action Code Script (inherited from Hexen). Currently the only supported script VM.
  • params: Up to three parameters for the called script function.

Examples

No examples given.

Notes

The semantic difference between PlayerStartScript and StartScript is that the former considers the call as being made from a player weapon, while this is called from a map object. Currently only StartScript can call ACS scripts.

See also