Game: Difference between revisions

From Vendetta Lua
Jump to navigationJump to search
← Older edit
Darkgrey (talk | contribs)
28 edits
 
(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>
'''Description:''' <br>
 
<br><br>
'''Arguments:''' <br>
?
<br><br>
'''Returns:''' <br>
?
<br><br>
'''Example:'''
<br><br>
 
=== GetClientBuildNumber ===
'''Definition:'''<br>
GetClientBuildNumber() -> ?
<br><br>
<br><br>
'''Description:''' <br>
'''Description:''' <br>
Line 34: Line 67:
<br><br>
<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) => result<br>
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('rRenderStationInMenu') = 1
print(Game.GetCVar("rRenderStationInMenu")) -- output: 1 or 0, ie. true/false
Game.GetCVar('autoaim') = 1
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>


=== GetClientBuildNumber ===
=== GetDesiredSpeed ===
'''Definition:'''<br>
'''Definition:'''<br>
GetClientBuildNumber() -> ?
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 ===
=== GetDesiredSpeed ===
'''Definition:'''<br>
'''Definition:'''<br>
GetDesiredSpeed() -> ?
GetMaxFramerate() -> ?
<br><br>
<br><br>
'''Description:''' <br>
'''Description:''' <br>
Line 90: Line 171:
<br><br>
<br><br>


 
=== GetNFZMode ===
 
=== GetFlightMode ===
'''Definition:'''<br>
'''Definition:'''<br>
GetFlightMode() -> ?
GetNFZMode() -> ?
<br><br>
<br><br>
'''Description:''' <br>
'''Description:''' <br>
Line 110: Line 189:




=== GetNFZMode ===
=== GetObjectAtScreenPos ===
'''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>
'''Definition:'''<br>
GetNFZMode() -> ?
GetTurretHealth() -> ?
<br><br>
<br><br>
'''Description:''' <br>
'''Description:''' <br>
Line 128: Line 227:




=== GetObjectAtScreenPos ===
=== GetTurretObjectID ===
'''Definition:'''<br>
'''Definition:'''<br>
GetObjectAtScreenPos() -> ?
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>


=== GetTurretHealth ===
=== IsMobiHandServiceInstalled ===
'''Definition:'''<br>
'''Definition:'''<br>
GetTurretHealth() -> ?
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>


=== GetTurretObjectID ===
=== PerformGoogleBilling ===
'''Definition:'''<br>
'''Definition:'''<br>
GetTurretObjectID() -> ?
PerformGoogleBilling() -> ?
<br><br>
<br><br>
'''Description:''' <br>
'''Description:''' <br>
Line 180: Line 308:
<br><br>
<br><br>


 
=== PerformMobiBilling ===
 
=== Quit ===
'''Definition:'''<br>
'''Definition:'''<br>
Quit() -> ?
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:'''
<br><br>


<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 271: Line 436:




=== StartLoginCinematic ===
'''Definition:'''<br>
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>


=== StartLoginCinematic ===
=== StartPlayback ===
'''Definition:'''<br>
'''Definition:'''<br>
StartLoginCinematic() -> ?
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

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:

Retrieved from "https://vo-wiki.com/racecar2/index.php?title=Game&oldid=14136"