PlayerStartScript: Difference between revisions
From Eternity Wiki
Jump to navigationJump to search
(Created page with '{{codepointer|description= Used from player weapon frames to call scripts.|usage= '''PlayerStartScript'''(''scriptnum'', ''selectvm'', ''params[0]'', ''params[1]'', ''params[2]''…') |
(not used now) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{codepointer|description= | {{codepointer|description= | ||
'''Currently disabled'''. Was used from player weapon frames to call scripts.|usage= | |||
'''PlayerStartScript'''(''scriptnum'', ''selectvm'', ''params[0]'', ''params[1]'', ''params[2]'')|parameters= | '''PlayerStartScript'''(''scriptnum'', ''selectvm'', ''params[0]'', ''params[1]'', ''params[2]'')|parameters= | ||
*''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. | **{{deprecated}}0 or '''gamescript''': [[Small]] game (global) script. | ||
**{{deprecated}}1 or '''levelscript''': Small level (map) script.|notes= | **{{deprecated}}1 or '''levelscript''': Small level (map) script. | ||
*''params'': Up to three parameters for the called script function.|notes= | |||
Since Small scripting has been removed from Eternity, this codepointer has no effect. To be able to call ACS scripts (which use ''selectvm'' = 2, which isn't supported by this function), use '''[[StartScript]]''' instead. | |||
The semantic difference between '''PlayerStartScript''' and '''StartScript''' is that this one considers the call being made from a player weapon, the latter is called from a map object.|seealso= | The semantic difference between '''PlayerStartScript''' and '''StartScript''' is that this one considers the call being made from a player weapon, the latter is called from a map object.|seealso= | ||
*[[StartScript]]}} | *[[StartScript]]}} | ||
Latest revision as of 16:58, 7 August 2013
Description
Currently disabled. Was used from player weapon frames to call scripts.
Usage
PlayerStartScript(scriptnum, selectvm, params[0], params[1], params[2])
Parameters
- scriptnum: Number of script to call.
- selectvm: Virtual machine to use:
- (deprecated)0 or gamescript: Small game (global) script.
- (deprecated)1 or levelscript: Small level (map) script.
- params: Up to three parameters for the called script function.
Examples
No examples given.
Notes
Since Small scripting has been removed from Eternity, this codepointer has no effect. To be able to call ACS scripts (which use selectvm = 2, which isn't supported by this function), use StartScript instead.
The semantic difference between PlayerStartScript and StartScript is that this one considers the call being made from a player weapon, the latter is called from a map object.
