StartScript: Difference between revisions

From Eternity Wiki
Jump to navigationJump to search
(not just three params)
m (mention)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{codepointer|description=
{{codepointer|description=
Used from EDF frames to call scripts.|usage=
Used from EDF frames to call scripts.|usage=
'''StartScript'''(''scriptnum'', ''selectvm'', ''params[0]'', ''params[1]'', ''params[2]'')|parameters=
'''StartScript'''(''scriptnum'', ''selectvm'', ''params'', ...)|parameters=
*''scriptnum'': Number of script to call.
*''scriptnum'': Number of script to call.
*''selectvm'': Virtual machine to use:
*''selectvm'': Virtual machine to use:
**('''obsolete''')0 or '''gamescript''': [[Small]] game (global) script.
**('''obsolete''')0 or '''gamescript''': no effect.
**('''obsolete''')1 or '''levelscript''': Small level (map) script.
**('''obsolete''')1 or '''levelscript''': no effect.
**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 thirteen parameters for the called script function.|notes=
*''params'': Up to fourteen 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''' and '''StartScriptNamed''' can call ACS scripts.|seealso=
*[[StartScriptNamed]]
*[[PlayerStartScript]]}}
*[[PlayerStartScript]]}}

Latest revision as of 17:32, 7 August 2013

Description

Used from EDF frames to call scripts.

Usage

StartScript(scriptnum, selectvm, params, ...)

Parameters

  • scriptnum: Number of script to call.
  • selectvm: Virtual machine to use:
    • (obsolete)0 or gamescript: no effect.
    • (obsolete)1 or levelscript: no effect.
    • 2 or acs: Action Code Script (inherited from Hexen). Currently the only supported script VM.
  • params: Up to fourteen 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 and StartScriptNamed can call ACS scripts.

See also