Game: Difference between revisions
→GetCVar: changed examples, as i think they should be actually runnable code |
|||
| Line 38: | Line 38: | ||
=== GetCVar === | === GetCVar === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
GetCVar(string name) | GetCVar(string name) -> result<br> | ||
<br> | <br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
| Line 48: | Line 48: | ||
<br> | <br> | ||
'''Returns:''' <br> | '''Returns:''' <br> | ||
The value or nil | The value or nil | ||
<br> | <br> | ||
'''Example:''' | '''Example:''' | ||
<source lang="lua"> | <source lang="lua"> | ||
Game.GetCVar( | print(Game.GetCVar("rRenderStationInMenu")) -- output: 1 or 0, ie. true/false | ||
Game.GetCVar( | if Game.GetCVar("autoaim") == 1 then print("autoaim is on") end | ||
</source> | </source> | ||
Revision as of 19:39, 2 March 2009
Functions
DisableInput
Definition:
DisableInput() -> ?
Description:
Arguments:
?
Returns:
?
Example:
EnableInput
Definition:
EnableInput() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetCVar
Definition:
GetCVar(string name) -> result
Description:
Returns the value of a C variable(?)
I'm assuming that the term CVar refers to an ingame variable not directly accessible by Lua
Arguments:
name name of the variable.
Returns:
The value or nil
Example:
<source lang="lua">
print(Game.GetCVar("rRenderStationInMenu")) -- output: 1 or 0, ie. true/false
if Game.GetCVar("autoaim") == 1 then print("autoaim is on") end
</source>
GetClientBuildNumber
Definition:
GetClientBuildNumber() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetDesiredSpeed
Definition:
GetDesiredSpeed() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetFlightMode
Definition:
GetFlightMode() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetNFZMode
Definition:
GetNFZMode() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetObjectAtScreenPos
Definition:
GetObjectAtScreenPos() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetTurretHealth
Definition:
GetTurretHealth() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetTurretObjectID
Definition:
GetTurretObjectID() -> ?
Description:
Arguments:
?
Returns:
?
Example:
Quit
Definition:
Quit() -> ?
Description:
Arguments:
?
Returns:
?
Example:
SetCVar
Definition:
SetCVar() -> ?
Description:
Arguments:
?
Returns:
?
Example:
SetDesiredSpeed
Definition:
SetDesiredSpeed() -> ?
Description:
Arguments:
?
Returns:
?
Example:
SetInputMode
Definition:
SetInputMode() -> ?
Description:
Arguments:
?
Returns:
?
Example:
SetJumpDest
Definition:
SetJumpDest() -> ?
Description:
Arguments:
?
Returns:
?
Example:
StartLoginCinematic
Definition:
StartLoginCinematic() -> ?
Description:
Arguments:
?
Returns:
?
Example:
StopLoginCinematic
Definition:
StopLoginCinematic() -> ?
Description:
Arguments:
?
Returns:
?
Example:
