Difference between revisions of "Game"

From Vendetta Lua
Jump to: navigation, search
(SetJumpDest)
(Quit)
Line 187: Line 187:
 
=== Quit ===
 
=== Quit ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
Quit() -> ?
+
Quit()
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
Line 193: Line 193:
 
<br><br>
 
<br><br>
 
'''Arguments:''' <br>
 
'''Arguments:''' <br>
?
+
none
 
<br><br>
 
<br><br>
 
'''Returns:''' <br>
 
'''Returns:''' <br>
?
+
nothing
 
<br><br>
 
<br><br>
'''Example:'''
+
'''Example:'''<br>
 +
<source lang="lua">Game.Quit()</source>
 
<br><br>
 
<br><br>
 
 
  
 
=== SetCVar ===
 
=== SetCVar ===

Revision as of 10:35, 3 March 2009

Functions

DisableInput

Definition:
DisableInput() -> ?

Description:



Arguments:
?

Returns:
?

Example:


EnableInput

Definition:
EnableInput()

Description:



Arguments:
none

Returns:
nothing

Example:

Game.EnableInput()



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:

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

GetClientBuildNumber

Definition:
GetClientBuildNumber() -> ?

Description:



Arguments:
?

Returns:
?

Example:


GetDesiredSpeed

Definition:
GetDesiredSpeed() -> ?

Description:



Arguments:
?

Returns:
?

Example:


GetFlightMode

Definition:
GetFlightMode() -> boolean

Description:



Arguments:
?

Returns:
?

Example:

local a = Game.GetFlightMode()
print tostring(a).." ("..type(a)..")" -- outputs: true (boolean)



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:
none

Returns:
nothing

Example:

Game.Quit()



SetCVar

Definition:
SetCVar() -> ?

Description:



Arguments:
?

Returns:
?

Example:


SetDesiredSpeed

Definition:
SetDesiredSpeed() -> ?

Description:



Arguments:
?

Returns:
?

Example:


SetInputMode

Definition:
SetInputMode() -> ?

Description:



Arguments:
?

Returns:
?

Example:


SetJumpDest

Definition:
SetJumpDest(sectorid)

Description:



Arguments:
sectorid -- sectorid of jump destination.

Returns:
nothing

Example:

Game.SetJumpDest(2902)



StartLoginCinematic

Definition:
StartLoginCinematic()

Description:



Arguments:
none

Returns:
none

Example:

Game.StartLoginCinematic()



StopLoginCinematic

Definition:
StopLoginCinematic()

Description:



Arguments:
none

Returns:
none

Example:

Game.StopLoginCinematic()