Difference between revisions of "Game"
(→GetCVar) |
Ravenwolf397 (Talk | contribs) (→GetFlightMode) |
||
(14 intermediate revisions by 6 users not shown) | |||
Line 20: | Line 20: | ||
=== EnableInput === | === EnableInput === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | EnableInput() -> ? | + | EnableInput() |
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | none | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | nothing | ||
+ | <br><br> | ||
+ | '''Example:'''<br> | ||
+ | <source lang="lua">Game.EnableInput()</source> | ||
+ | <br><br> | ||
+ | |||
+ | === EndPlayback === | ||
+ | '''Definition:'''<br> | ||
+ | EndPlayback() -> ? | ||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 34: | Line 51: | ||
<br><br> | <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> | ||
=== GetCVar === | === GetCVar === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | GetCVar(string name) | + | GetCVar(string name) -> result<br> |
<br> | <br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 48: | Line 111: | ||
<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 |
+ | print(Game.GetCVar("rHUDxscale")) -- output: 900 | ||
+ | if Game.GetCVar("filterchannelmsgs") == 1 then print("Channel Messages are being filtered") end | ||
</source> | </source> | ||
− | === | + | === GetDesiredSpeed === |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | GetDesiredSpeed() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 72: | Line 137: | ||
<br><br> | <br><br> | ||
+ | === GetFlightMode === | ||
+ | '''Definition:'''<br> | ||
+ | GetFlightMode() -> boolean | ||
+ | <br><br> | ||
+ | '''Description:''' Whether flight-assist mode is active | ||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' true if flight-assist mode is active, false otherwise | ||
+ | <br><br> | ||
+ | '''Example:'''<br> | ||
+ | <source lang="lua"> | ||
+ | local a = Game.GetFlightMode() | ||
+ | print tostring(a).." ("..type(a)..")" -- outputs: true (boolean) | ||
+ | </source> | ||
+ | <br><br> | ||
− | + | === GetMaxFramerate === | |
− | === | + | |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | GetMaxFramerate() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 90: | Line 171: | ||
<br><br> | <br><br> | ||
− | + | === GetNFZMode === | |
− | + | ||
− | === | + | |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | GetNFZMode() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 110: | Line 189: | ||
− | === | + | === GetObjectAtScreenPos === |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | GetObjectAtScreenPos(float x, y) -> int [[nodeid]], [[objectid]] | |
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | Returns nodeid and objectid of a targetable object at specified screen coordinates | ||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ''x'',''y'' - screen coordinates, range from 0 to 1 where 0,0 is top left corner of screen and 1,1 is bottom right | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | [[nodeid]], [[objectid]] - ids, as used by radar functions | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br> | ||
+ | <source lang="lua"> | ||
+ | radar.SetRadarSelection(Game.GetObjectAtPos(0.5, 0.5)) -- will target object directly in front (also stuff not normally targettable, like station parts) | ||
+ | </source> | ||
+ | |||
+ | === GetScreenSize === | ||
+ | === GetTurretHealth === | ||
+ | '''Definition:'''<br> | ||
+ | GetTurretHealth() -> ? | ||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 128: | Line 227: | ||
− | === | + | === GetTurretObjectID === |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | GetTurretObjectID() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 144: | Line 243: | ||
<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> | '''Definition:'''<br> | ||
− | + | IsMobiHandServiceInstalled() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 162: | Line 275: | ||
<br><br> | <br><br> | ||
+ | === OpenWebBrowser === | ||
+ | '''Definition:'''<br> | ||
+ | OpenWebBrowser(string link) -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | '''link''' link for the web browser | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
− | === | + | === PerformGoogleBilling === |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | PerformGoogleBilling() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 180: | Line 308: | ||
<br><br> | <br><br> | ||
− | + | === PerformMobiBilling === | |
− | + | ||
− | === | + | |
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | + | PerformMobiBilling() -> ? | |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 199: | Line 325: | ||
+ | === Quit === | ||
+ | '''Definition:'''<br> | ||
+ | Quit() | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | none | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | nothing | ||
+ | <br><br> | ||
+ | '''Example:'''<br> | ||
+ | <source lang="lua">Game.Quit()</source> | ||
+ | <br><br> | ||
=== SetCVar === | === SetCVar === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | SetCVar() -> ? | + | SetCVar(string name, string value) -> ? |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 208: | Line 350: | ||
<br><br> | <br><br> | ||
'''Arguments:''' <br> | '''Arguments:''' <br> | ||
− | + | ||
+ | string name - name of existing cvar | ||
+ | string value - value to set it to | ||
+ | |||
<br><br> | <br><br> | ||
'''Returns:''' <br> | '''Returns:''' <br> | ||
− | + | ||
+ | true - if the cvar is valid, false otherwise | ||
+ | |||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
− | |||
+ | <source lang="lua"> | ||
+ | if(Game.SetCVar("fov", "95") == true) then print "fov set to 95" end | ||
+ | </source> | ||
+ | <br><br> | ||
=== SetDesiredSpeed === | === SetDesiredSpeed === | ||
Line 233: | Line 383: | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
− | |||
− | |||
=== SetInputMode === | === SetInputMode === | ||
Line 256: | Line 404: | ||
=== SetJumpDest === | === SetJumpDest === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | SetJumpDest() -> ? | + | SetJumpDest([[sectorid]]) |
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | sectorid -- [[sectorid]] of jump destination. | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | nothing | ||
+ | <br><br> | ||
+ | '''Example:'''<br> | ||
+ | <source lang="lua">Game.SetJumpDest(2902)</source> | ||
+ | <br><br> | ||
+ | |||
+ | === SetMaxFramerate === | ||
+ | '''Definition:'''<br> | ||
+ | SetMaxFramerate() -> ? | ||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 269: | Line 434: | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
− | |||
=== StartLoginCinematic === | === StartLoginCinematic === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | StartLoginCinematic() -> ? | + | StartLoginCinematic() |
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | none | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | none | ||
+ | <br><br> | ||
+ | '''Example:'''<br> | ||
+ | <source lang="lua">Game.StartLoginCinematic()</source> | ||
+ | <br><br> | ||
+ | |||
+ | === StartPlayback === | ||
+ | '''Definition:'''<br> | ||
+ | StartPlayback() -> ? | ||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 288: | Line 469: | ||
<br><br> | <br><br> | ||
+ | === StartRecording === | ||
+ | '''Definition:'''<br> | ||
+ | StartRecording() -> ? | ||
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | ? | ||
+ | <br><br> | ||
+ | '''Example:''' | ||
+ | <br><br> | ||
=== StopLoginCinematic === | === StopLoginCinematic === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
− | StopLoginCinematic() -> ? | + | StopLoginCinematic() |
+ | <br><br> | ||
+ | '''Description:''' <br> | ||
+ | |||
+ | <br><br> | ||
+ | '''Arguments:''' <br> | ||
+ | none | ||
+ | <br><br> | ||
+ | '''Returns:''' <br> | ||
+ | none | ||
+ | <br><br> | ||
+ | '''Example:'''<br> | ||
+ | <source lang="lua">Game.StopLoginCinematic()</source> | ||
+ | <br><br> | ||
+ | |||
+ | === StopRecording === | ||
+ | '''Definition:'''<br> | ||
+ | StopRecording() -> ? | ||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 305: | Line 517: | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
+ | |||
+ | [[Category:Tables]] |
Latest revision as of 00:29, 2 August 2023
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 GetScreenSize
- 1.14 GetTurretHealth
- 1.15 GetTurretObjectID
- 1.16 IsInstalledFromMarket
- 1.17 IsMobiHandServiceInstalled
- 1.18 OpenWebBrowser
- 1.19 PerformGoogleBilling
- 1.20 PerformMobiBilling
- 1.21 Quit
- 1.22 SetCVar
- 1.23 SetDesiredSpeed
- 1.24 SetInputMode
- 1.25 SetJumpDest
- 1.26 SetMaxFramerate
- 1.27 StartLoginCinematic
- 1.28 StartPlayback
- 1.29 StartRecording
- 1.30 StopLoginCinematic
- 1.31 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: Whether flight-assist mode is active
Arguments:
?
Returns: true if flight-assist mode is active, false otherwise
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)
GetScreenSize
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(string link) -> ?
Description:
Arguments:
link link for the web browser
?
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: