Game: Difference between revisions
Ravenwolf397 (talk | contribs) |
|||
(6 intermediate revisions by 5 users not shown) | |||
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> | |||
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> | |||
GetMaxFramerate() -> ? | |||
<br><br> | |||
'''Description:''' <br> | |||
<br><br> | |||
'''Arguments:''' <br> | |||
? | |||
<br><br> | |||
'''Returns:''' <br> | |||
? | |||
<br><br> | |||
'''Example:''' | |||
<br><br> | |||
=== | === GetNFZMode === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
GetNFZMode() -> ? | |||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 93: | Line 189: | ||
=== | === GetObjectAtScreenPos === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
GetObjectAtScreenPos(float x, y) -> int [[nodeid]], [[objectid]] | |||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Returns nodeid and objectid of a targetable object at specified screen coordinates | |||
<br><br> | <br><br> | ||
'''Arguments:''' <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> | <br><br> | ||
'''Returns:''' <br> | '''Returns:''' <br> | ||
[[nodeid]], [[objectid]] - ids, as used by radar functions | |||
<br><br> | <br><br> | ||
'''Example:'''<br> | '''Example:''' | ||
<br> | |||
<source lang="lua"> | <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> | </source> | ||
=== | === GetScreenSize === | ||
=== GetTurretHealth === | |||
'''Definition:'''<br> | '''Definition:'''<br> | ||
GetTurretHealth() -> ? | |||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 131: | Line 227: | ||
=== | === GetTurretObjectID === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
GetTurretObjectID() -> ? | |||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 147: | 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 165: | 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 183: | Line 308: | ||
<br><br> | <br><br> | ||
=== PerformMobiBilling === | |||
'''Definition:'''<br> | |||
PerformMobiBilling() -> ? | |||
<br><br> | |||
'''Description:''' <br> | |||
<br><br> | |||
'''Arguments:''' <br> | |||
? | |||
<br><br> | |||
'''Returns:''' <br> | |||
? | |||
<br><br> | |||
'''Example:''' | |||
<br><br> | |||
Line 204: | Line 344: | ||
=== SetCVar === | === SetCVar === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
SetCVar() -> ? | SetCVar(string name, string value) -> ? | ||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
Line 210: | 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 235: | Line 383: | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
=== SetInputMode === | === SetInputMode === | ||
Line 272: | 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 288: | 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 306: | Line 501: | ||
<source lang="lua">Game.StopLoginCinematic()</source> | <source lang="lua">Game.StopLoginCinematic()</source> | ||
<br><br> | <br><br> | ||
=== StopRecording === | |||
'''Definition:'''<br> | |||
StopRecording() -> ? | |||
<br><br> | |||
'''Description:''' <br> | |||
<br><br> | |||
'''Arguments:''' <br> | |||
? | |||
<br><br> | |||
'''Returns:''' <br> | |||
? | |||
<br><br> | |||
'''Example:''' | |||
<br><br> | |||
[[Category:Tables]] |
Latest revision as of 00:29, 2 August 2023
Functions
DisableInput
Definition:
DisableInput() -> ?
Description:
Arguments:
?
Returns:
?
Example:
EnableInput
Definition:
EnableInput()
Description:
Arguments:
none
Returns:
nothing
Example:
<source lang="lua">Game.EnableInput()</source>
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:
<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>
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:
<source lang="lua">
local a = Game.GetFlightMode()
print tostring(a).." ("..type(a)..")" -- outputs: true (boolean)
</source>
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:
<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:
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:
<source lang="lua">Game.Quit()</source>
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:
<source lang="lua"> if(Game.SetCVar("fov", "95") == true) then print "fov set to 95" end </source>
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:
<source lang="lua">Game.SetJumpDest(2902)</source>
SetMaxFramerate
Definition:
SetMaxFramerate() -> ?
Description:
Arguments:
?
Returns:
?
Example:
StartLoginCinematic
Definition:
StartLoginCinematic()
Description:
Arguments:
none
Returns:
none
Example:
<source lang="lua">Game.StartLoginCinematic()</source>
StartPlayback
Definition:
StartPlayback() -> ?
Description:
Arguments:
?
Returns:
?
Example:
StartRecording
Definition:
StartRecording() -> ?
Description:
Arguments:
?
Returns:
?
Example:
StopLoginCinematic
Definition:
StopLoginCinematic()
Description:
Arguments:
none
Returns:
none
Example:
<source lang="lua">Game.StopLoginCinematic()</source>
StopRecording
Definition:
StopRecording() -> ?
Description:
Arguments:
?
Returns:
?
Example: