Difference between revisions of "Game"
(→GetObjectAtScreenPos) |
|||
Line 33: | Line 33: | ||
'''Example:'''<br> | '''Example:'''<br> | ||
<source lang="lua">Game.EnableInput()</source> | <source lang="lua">Game.EnableInput()</source> | ||
+ | <br><br> | ||
+ | |||
+ | === EndPlayback === | ||
+ | '''Definition:'''<br> | ||
+ | EndPlayback() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
+ | === GetClientBuildNumber === | ||
+ | '''Definition:'''<br> | ||
+ | GetClientBuildNumber() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
+ | === GetClientVersion === | ||
+ | '''Definition:'''<br> | ||
+ | GetClientVersion() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
+ | === GetCommandForBind === | ||
+ | '''Definition:'''<br> | ||
+ | GetCommandForBind() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
<br><br> | <br><br> | ||
Line 57: | Line 121: | ||
</source> | </source> | ||
− | === | + | === GetDesiredSpeed === |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | GetDesiredSpeed() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 73: | Line 137: | ||
<br><br> | <br><br> | ||
− | + | === GetFlightMode === | |
− | + | ||
− | === | + | |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | GetFlightMode() -> boolean | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 88: | Line 150: | ||
? | ? | ||
<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> | ||
− | + | === GetMaxFramerate === | |
− | + | ||
− | === | + | |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | GetMaxFramerate() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 106: | Line 170: | ||
? | ? | ||
<br><br> | <br><br> | ||
− | '''Example:''' | + | '''Example:''' |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
<br><br> | <br><br> | ||
Line 184: | Line 244: | ||
<br><br> | <br><br> | ||
+ | === IsInstalledFromMarket === | ||
+ | '''Definition:'''<br> | ||
+ | IsInstalledFromMarket() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
+ | === IsMobiHandServiceInstalled === | ||
+ | '''Definition:'''<br> | ||
+ | IsMobiHandServiceInstalled() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
+ | === OpenWebBrowser === | ||
+ | '''Definition:'''<br> | ||
+ | OpenWebBrowser() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
+ | === PerformGoogleBilling === | ||
+ | '''Definition:'''<br> | ||
+ | PerformGoogleBilling() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
+ | === PerformMobiBilling === | ||
+ | '''Definition:'''<br> | ||
+ | PerformMobiBilling() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
Line 244: | Line 383: | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
− | |||
− | |||
=== SetInputMode === | === SetInputMode === | ||
Line 281: | Line 418: | ||
<source lang="lua">Game.SetJumpDest(2902)</source> | <source lang="lua">Game.SetJumpDest(2902)</source> | ||
<br><br> | <br><br> | ||
+ | |||
+ | === SetMaxFramerate === | ||
+ | '''Definition:'''<br> | ||
+ | SetMaxFramerate() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
=== StartLoginCinematic === | === StartLoginCinematic === | ||
Line 297: | Line 451: | ||
'''Example:'''<br> | '''Example:'''<br> | ||
<source lang="lua">Game.StartLoginCinematic()</source> | <source lang="lua">Game.StartLoginCinematic()</source> | ||
+ | <br><br> | ||
+ | |||
+ | === StartPlayback === | ||
+ | '''Definition:'''<br> | ||
+ | StartPlayback() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
+ | |||
+ | === StartRecording === | ||
+ | '''Definition:'''<br> | ||
+ | StartRecording() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
<br><br> | <br><br> | ||
Line 314: | Line 500: | ||
'''Example:'''<br> | '''Example:'''<br> | ||
<source lang="lua">Game.StopLoginCinematic()</source> | <source lang="lua">Game.StopLoginCinematic()</source> | ||
+ | <br><br> | ||
+ | |||
+ | === StopRecording === | ||
+ | '''Definition:'''<br> | ||
+ | StopRecording() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
<br><br> | <br><br> | ||
[[Category:Tables]] | [[Category:Tables]] |
Revision as of 06:17, 1 August 2011
Contents
- 1 Functions
- 1.1 DisableInput
- 1.2 EnableInput
- 1.3 EndPlayback
- 1.4 GetClientBuildNumber
- 1.5 GetClientVersion
- 1.6 GetCommandForBind
- 1.7 GetCVar
- 1.8 GetDesiredSpeed
- 1.9 GetFlightMode
- 1.10 GetMaxFramerate
- 1.11 GetNFZMode
- 1.12 GetObjectAtScreenPos
- 1.13 GetTurretHealth
- 1.14 GetTurretObjectID
- 1.15 IsInstalledFromMarket
- 1.16 IsMobiHandServiceInstalled
- 1.17 OpenWebBrowser
- 1.18 PerformGoogleBilling
- 1.19 PerformMobiBilling
- 1.20 Quit
- 1.21 SetCVar
- 1.22 SetDesiredSpeed
- 1.23 SetInputMode
- 1.24 SetJumpDest
- 1.25 SetMaxFramerate
- 1.26 StartLoginCinematic
- 1.27 StartPlayback
- 1.28 StartRecording
- 1.29 StopLoginCinematic
- 1.30 StopRecording
Functions
DisableInput
Definition:
DisableInput() -> ?
Description:
Arguments:
?
Returns:
?
Example:
EnableInput
Definition:
EnableInput()
Description:
Arguments:
none
Returns:
nothing
Example:
Game.EnableInput()
EndPlayback
Definition:
EndPlayback() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetClientBuildNumber
Definition:
GetClientBuildNumber() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetClientVersion
Definition:
GetClientVersion() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetCommandForBind
Definition:
GetCommandForBind() -> ?
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:
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
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)
GetMaxFramerate
Definition:
GetMaxFramerate() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetNFZMode
Definition:
GetNFZMode() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetObjectAtScreenPos
Definition:
GetObjectAtScreenPos(float x, y) -> int nodeid, objectid
Description:
Returns nodeid and objectid of a targetable object at specified screen coordinates
Arguments:
x,y - screen coordinates, range from 0 to 1 where 0,0 is top left corner of screen and 1,1 is bottom right
Returns:
nodeid, objectid - ids, as used by radar functions
Example:
radar.SetRadarSelection(Game.GetObjectAtPos(0.5, 0.5)) -- will target object directly in front (also stuff not normally targettable, like station parts)
GetTurretHealth
Definition:
GetTurretHealth() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetTurretObjectID
Definition:
GetTurretObjectID() -> ?
Description:
Arguments:
?
Returns:
?
Example:
IsInstalledFromMarket
Definition:
IsInstalledFromMarket() -> ?
Description:
Arguments:
?
Returns:
?
Example:
IsMobiHandServiceInstalled
Definition:
IsMobiHandServiceInstalled() -> ?
Description:
Arguments:
?
Returns:
?
Example:
OpenWebBrowser
Definition:
OpenWebBrowser() -> ?
Description:
Arguments:
?
Returns:
?
Example:
PerformGoogleBilling
Definition:
PerformGoogleBilling() -> ?
Description:
Arguments:
?
Returns:
?
Example:
PerformMobiBilling
Definition:
PerformMobiBilling() -> ?
Description:
Arguments:
?
Returns:
?
Example:
Quit
Definition:
Quit()
Description:
Arguments:
none
Returns:
nothing
Example:
Game.Quit()
SetCVar
Definition:
SetCVar(string name, string value) -> ?
Description:
Arguments:
string name - name of existing cvar string value - value to set it to
Returns:
true - if the cvar is valid, false otherwise
Example:
if(Game.SetCVar("fov", "95") == true) then print "fov set to 95" end
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)
SetMaxFramerate
Definition:
SetMaxFramerate() -> ?
Description:
Arguments:
?
Returns:
?
Example:
StartLoginCinematic
Definition:
StartLoginCinematic()
Description:
Arguments:
none
Returns:
none
Example:
Game.StartLoginCinematic()
StartPlayback
Definition:
StartPlayback() -> ?
Description:
Arguments:
?
Returns:
?
Example:
StartRecording
Definition:
StartRecording() -> ?
Description:
Arguments:
?
Returns:
?
Example:
StopLoginCinematic
Definition:
StopLoginCinematic()
Description:
Arguments:
none
Returns:
none
Example:
Game.StopLoginCinematic()
StopRecording
Definition:
StopRecording() -> ?
Description:
Arguments:
?
Returns:
?
Example: