Game: Difference between revisions

From Vendetta Lua
Jump to navigationJump to search
Darkgrey (talk | contribs)
Darkgrey (talk | contribs)
Line 96: Line 96:
=== GetFlightMode ===
=== GetFlightMode ===
'''Definition:'''<br>
'''Definition:'''<br>
GetFlightMode() -> ?
GetFlightMode() -> boolean
<br><br>
<br><br>
'''Description:''' <br>
'''Description:''' <br>
Line 107: Line 107:
?
?
<br><br>
<br><br>
'''Example:'''
'''Example:'''<br>
<source lang="lua">
local a = Game.GetFlightMode()
print tostring(a).." ("..type(a)..")" -- outputs: true (boolean)
</source>
<br><br>
<br><br>


=== GetNFZMode ===
=== GetNFZMode ===

Revision as of 10:26, 3 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 print(Game.GetCVar("rHUDxscale")) -- output: 900 if Game.GetCVar("filterchannelmsgs") == 1 then print("Channel Messages are being filtered") end </source>

GetClientBuildNumber

Definition:
GetClientBuildNumber() -> ?

Description:



Arguments:
?

Returns:
?

Example:


GetDesiredSpeed

Definition:
GetDesiredSpeed() -> ?

Description:



Arguments:
?

Returns:
?

Example:


GetFlightMode

Definition:
GetFlightMode() -> boolean

Description:



Arguments:
?

Returns:
?

Example:
<source lang="lua"> local a = Game.GetFlightMode() print tostring(a).." ("..type(a)..")" -- outputs: true (boolean) </source>

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: