Update spectator function headers

This commit is contained in:
SilentSpike 2015-10-04 18:30:07 +01:00
parent c1dc8a6493
commit 4079ca354e
4 changed files with 13 additions and 12 deletions

View File

@ -4,7 +4,7 @@
*
* Arguments:
* 0: Reason <STRING>
* 1: Interrupting <BOOL>
* 1: Interrupting <BOOL> (default: true)
*
* Return Value:
* None <NIL>

View File

@ -1,23 +1,24 @@
/*
* Author: SilentSpike
* Sets the spectator camera attributes as desired
* All values are optional and default to whatever the current value is
*
* Arguments:
* 0: Camera mode <NUMBER> <OPTIONAL>
* 0: Camera mode <NUMBER>
* - 0: Free
* - 1: Internal
* - 2: External
* 1: Camera unit (objNull for random) <OBJECT> <OPTIONAL>
* 2: Camera vision <NUMBER> <OPTIONAL>
* 1: Camera unit (objNull for random) <OBJECT>
* 2: Camera vision <NUMBER>
* - -2: Normal
* - -1: Night vision
* - 0: Thermal white hot
* - 1: Thermal black hot
* 3: Camera position (ATL) <ARRAY> <OPTIONAL>
* 4: Camera pan (0 - 360) <NUMBER> <OPTIONAL>
* 5: Camera tilt (-90 - 90) <NUMBER> <OPTIONAL>
* 6: Camera zoom (0.01 - 2) <NUMBER> <OPTIONAL>
* 7: Camera speed in m/s (0.05 - 10) <NUMBER> <OPTIONAL>
* 3: Camera position (ATL) <ARRAY>
* 4: Camera pan (0 - 360) <NUMBER>
* 5: Camera tilt (-90 - 90) <NUMBER>
* 6: Camera zoom (0.01 - 2) <NUMBER>
* 7: Camera speed in m/s (0.05 - 10) <NUMBER>
*
* Return Value:
* None <NIL>

View File

@ -7,8 +7,8 @@
* Upon unstage, units will be moved to the position they were in upon staging
*
* Arguments:
* 0: Unit to put into spectator stage <OBJECT> <OPTIONAL>
* 1: Spectator stage <BOOL> <OPTIONAL>
* 0: Unit to put into spectator stage <OBJECT> (default: player)
* 1: Unit should be staged <BOOL> (default: true)
*
* Return Value:
* None <NIL>

View File

@ -4,7 +4,7 @@
*
* Arguments:
* 0: Units to add to the whitelist <ARRAY>
* 1: Use blacklist <BOOL> <OPTIONAL>
* 1: Use blacklist <BOOL> (default: false)
*
* Return Value:
* None <NIL>