Onset Developer Wiki - User contributions [en]

Main Page

2021-12-23T21:10:43Z

FlyingFork: /* Other */

__NOTOC__
===Getting started===
<html>
<div class="card">
<a href="/wiki/DedicatedServer">
<img src="/images/1/19/CardServer.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Server</b></h4>
<p>Learn how to setup your own local or dedicated server.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/packages">
<img src="/images/c/ce/CardScripting.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Packages</b></h4>
<p>Creating script packages for your server.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/server_config">
<img src="/images/b/b7/CardServerConfig.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Server Configuration</b></h4>
<p>Documentation about configuring your server.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/weapons_config">
<img src="/images/f/fb/CardWeaponsConfig.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Weapons Configuration</b></h4>
<p>Documentation about configuring custom weapons.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Modding">
<img src="/images/6/62/CardModdingAssets.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Modding</b></h4>
<p>Modding tutorial for importing custom 3D models, levels and more.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Custom_Connect_Screen">
<img src="/images/4/4d/CardCustomConnectScreen.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Custom Connect Screen</b></h4>
<p>Setting up your own custom connect screen for your server.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Custom_Maps">
<img src="/images/3/3e/CardCustomMap.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Custom Maps</b></h4>
<p>Learn how to create custom maps for Onset.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Debugging">
<img src="/images/8/81/CardDebugging.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Debugging</b></h4>
<p>Debugging your Onset scripts and user interfaces.</p>
</div>
</a>
</div>
<div style="clear: both;"></div>
</html>

===Lua Functions and Events===
<html>
<div class="card">
<a href="/wiki/Template:ServerFunctions">
<img src="/images/c/ce/CardScripting.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Server Functions</b></h4>
<p>See a list of server functions.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Template:ClientFunctions">
<img src="/images/c/ce/CardScripting.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Client Functions</b></h4>
<p>See a list of client functions.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Template:ServerEvents">
<img src="/images/c/ce/CardScripting.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Server Events</b></h4>
<p>See a list of server events.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Template:ClientEvents">
<img src="/images/c/ce/CardScripting.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Client Events</b></h4>
<p>See a list of client events.</p>
</div>
</a>
</div>
<div style="clear: both;"></div>
</html>

===Game models and more===
<html>
<div class="card">
<a href="/wiki/Vehicles">
<img src="/images/4/48/CardVehicles.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Vehicles</b></h4>
<p>List of vehicles to spawn.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Objects">
<img src="/images/4/46/CardObjects.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Objects</b></h4>
<p>List of objects to spawn.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Weapons">
<img src="/images/6/6c/CardWeapons.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Weapons</b></h4>
<p>List of weapons for players.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/AnimationList">
<img src="/images/c/ca/CardAnimations.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Animation List</b></h4>
<p>Player and NPC animations.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Doors">
<img src="/images/7/7e/CardDoors.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Doors</b></h4>
<p>List of working doors.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Clothing">
<img src="/images/2/20/CardClothing.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Clothing</b></h4>
<p>Learn how to use clothing items.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Apartment_Interior">
<img src="/images/3/36/Apartment_Card.jpg" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Apartments</b></h4>
<p>Spawn a premade apartment interior.</p>
</div>
</a>
</div>
<div style="clear: both;"></div>
</html>

===Constants===
* [[HitType|Hit type]]
* [[PlayerState|Player State types]]
* [[InputModes|Input mode]]
* [[EditModes|Edit modes]]
* [[WebVisibility|Web Visibility]]
* [[AttachType|Attach type]]
* [[FloorTypes|Floor types]]
* [[MovementModes|Movement Modes]]

===Other===
* [[ClientParameters|Client parameters and folders]]
* [[LuaHelper|Useful Lua helper functions]]
* [[UnrealLua]]
* [[Debugging|Debugging, crash handling and client console]]
* [[UpdateDiscordActivity|Custom Discord client id]]
* [[Template:HttpFunctions|Serverside HTTP client]]
* [https://github.com/alexandregv/awesome-onset Gamemodes, Packages, Scripts and Libraries for Onset]
* [[Limitations]]
* [[OnsetDocker|Onset with Docker]]
* [[Getting_Started_with_CSharp_(Server-Side)|Getting Started with C#]]

===Plugins and Database===
<html>
<div class="card">
<a href="/wiki/MariaDB">
<img src="/images/b/b0/CardMariaDB.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>MariaDB</b></h4>
<p>MariaDB (MySQL) setup for Onset.</p>
</div>
</a>
</div>
<div class="card">
<a href="/wiki/Template:MariaDBFunctions">
<img src="/images/b/b0/CardMariaDB.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>MariaDB Functions</b></h4>
<p>How use databases in Lua.</p>
</div>
</a>
</div>
<div class="card">
<a href="https://playonset.com/monetization">
<img src="/images/d/d2/CardMonetization.png" alt="CardImage" style="width:100%;">
<div class="cardcontainer">
<h4><b>Monetization</b></h4>
<p>Monetizing your server using Tebex service.</p>
</div>
</a>
</div>
</html>

GetDistance2D

2021-08-02T16:00:43Z

FlyingFork: /* Example */

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Calculates the distance between 2 points.}}

{{FuncSyntax|GetDistance2D(x, y, x2, y2)}}

{{FuncParameters}}
{{FuncParam|x|x of the first point.}}
{{FuncParam|y|y of the first point.}}
{{FuncParam|x2|x of the second point.}}
{{FuncParam|y2|y of the second point.}}

{{FuncReturnValue|The distance between the 2 points.}}

== Example ==
<syntaxhighlight lang="Lua">
local distance = GetDistance2D(0, 0, 100, 100) -- Returns 100
</syntaxhighlight>

{{RelatedFunctions}}
* [[GetDistance3D]]
* [[GetDistanceSquared3D]]

Base64Decode

2021-08-02T15:59:08Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Decodes the Base64 into text.}}

{{FuncSyntax|Base64Decode(base64)}}

{{FuncParameters}}
{{FuncParam|base64|The base64 string.}}

{{FuncReturnValue|Text string.}}

== Example ==
<syntaxhighlight lang="lua">
local encoded = Base64Encode("Placeholder") -- encodes string "Placeholder"
local decoded = Base64Decode(encoded) -- returns "Placeholder"
</syntaxhighlight>

{{RelatedFunctions}}
* [[Base64Encode]]

Base64Decode

2021-08-02T15:58:57Z

FlyingFork:

Base64Encode

2021-08-02T15:58:03Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Encodes the specified text in the Base64 format.}}

{{FuncSyntax|Base64Encode(text)}}

{{FuncParameters}}
{{FuncParam|text|the text.}}

{{FuncReturnValue|}}
The base64 string

== Example ==
<syntaxhighlight lang="lua">
local encoded = Base64Encode("Placeholder")
</syntaxhighlight>

{{RelatedFunctions}}
* [[Base64Decode]]

GetDeltaSeconds

2021-06-27T15:58:13Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Gets the time between game ticks/frames.}}

{{FuncSyntax|GetDeltaSeconds()}}

{{FuncParameters}}
{{FuncNoParam}}

{{FuncReturnValue|Returns the delta time between the last game ticks/frames.}}

== Example ==
<syntaxhighlight lang="Lua>
print("Delta Seconds: " .. GetDeltaSeconds())
</syntaxhighlight>

{{RelatedFunctions}}
*[[GetTimeSeconds]]
*[[GetDeltaSeconds]]
*[[GetTickCount]]

GetNetworkStats

2021-06-26T14:54:06Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Gets the clients' NetworkStats}}

{{FuncSyntax|GetNetworkStats()}}

{{FuncParameters}}
{{FuncNoParam}}

{{FuncReturnValue|packetlossTotal, packetlossLastSecond, messagesInResendBuffer, bytesInResendBuffer, bytesSend, bytesReceived, bytesResent, bytesSendTotal, bytesReceivedTotal, bytesResentTotal, isLimitedByCongestionControl, isLimitedByOutgoingBandwidthLimit}}

== Example ==
<syntaxhighlight lang="Lua>
for name, value in pairs(GetNetworkStats())
print(name .. " -> " .. value)
do
</syntaxhighlight>

{{RelatedFunctions}}
* [[GetPlayerNetworkStats]]
* [[GetNetworkStats]]

GetPlayerNetworkStats

2021-06-26T14:53:42Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Gets the clients' NetworkStats}}

{{FuncSyntax|GetPlayerNetworkStats(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier}}

{{FuncReturnValue|packetlossTotal, packetlossLastSecond, messagesInResendBuffer, bytesInResendBuffer, bytesSend, bytesReceived, bytesResent, bytesSendTotal, bytesReceivedTotal, bytesResentTotal, isLimitedByCongestionControl, isLimitedByOutgoingBandwidthLimit}}

== Example ==
<syntaxhighlight lang="Lua>
for name, value in pairs(GetPlayerNetworkStats(player))
print(name .. " -> " .. value)
do
</syntaxhighlight>

{{RelatedFunctions}}
* [[GetPlayerNetworkStats]]
* [[GetNetworkStats]]

GetPlayerNetworkStats

2021-06-26T14:53:28Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Gets the clients' NetworkStats}}

{{FuncSyntax|GetPlayerNetworkStats(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier}}

{{FuncReturnValue|packetlossTotal, packetlossLastSecond, messagesInResendBuffer, bytesInResendBuffer, bytesSend, bytesReceived, bytesResent, bytesSendTotal, bytesReceivedTotal, bytesResentTotal, isLimitedByCongestionControl, isLimitedByOutgoingBandwidthLimit}}

== Example ==
for name, value in pairs(GetPlayerNetworkStats(player))
print(name .. " -> " .. value)
do

{{RelatedFunctions}}
* [[GetPlayerNetworkStats]]
* [[GetNetworkStats]]

GetVehicleHealth

2021-06-26T14:52:27Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Returns the specified vehicle health in float.}}

{{FuncSyntax|GetVehicleHealth(vehicle)}}

{{FuncParameters}}
{{FuncParam|vehicle|The vehicle identifier}}

{{FuncReturnValue|Vehicle health in float value between 0 to 10000}}

== Example ==
<syntaxhighlight lang="Lua">
print("Vehicle Health: " .. GetVehicleHealth(vehicle)/10000 .. "%"
</syntaxhighlight>

{{RelatedFunctions}}
{{VehicleFunctions}}

GetVehicleCount

2021-06-26T14:51:48Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Returns the number of vehicles.}}

{{FuncSyntax|GetVehicleCount()}}

{{FuncParameters}}
{{FuncNoParam}}

{{FuncReturnValue|Returns the number of vehicles.}}

== Example ==
<syntaxhighlight lang="Lua>
print("Vehicles: " .. GetVehicleCount())
</syntaxhighlight>

{{RelatedFunctions}}
{{VehicleFunctions}}

SetPlayerHeadSize

2021-06-26T14:51:24Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Sets the player's head size.}}

{{FuncSyntax|SetPlayerHeadSize(player, size)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier}}
{{FuncParam|size|The size in floating point value (range 0.0 - 3.0)}}

{{FuncReturnValue|This function returs nothing.}}

== Example ==
<syntaxhighlight lang="Lua>
local ts12 = 0
function cmd_tscene12(player)
ts12 = CreateTimer(IncreaseHeadSize, 10, player)
end
AddCommand("tscene12", cmd_tscene12)

function IncreaseHeadSize(player)
local size = GetPlayerHeadSize(player) + 0.1
SetPlayerHeadSize(player, size)
if (size > 3.0) then
DestroyTimer(ts12)
end
end
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

SetPlayerHealth

2021-06-26T14:51:10Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|You can set the player's health in a range of 0 to 100 units.}}

{{FuncSyntax|SetPlayerHealth(player, health)}}

{{FuncParameters}}
{{FuncParam|player|Player you want to set health of}}
{{FuncParam|health|New health value you want to set player to}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight lang="Lua">
function heal(player)
SetPlayerHealth(player, 100)
AddPlayerChat(player, "You've healed yourself")
end
AddCommand('heal', heal)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

IsPlayerDead

2021-06-26T14:50:46Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Check if a player is dead.}}

{{FuncSyntax|IsPlayerDead(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight lang="Lua">
AddCommand("acceptdeath", function(playerid)
if not IsPlayerDead(player) then
return AddPlayerChat(playerid, "You are not dead.")
end

AddPlayerChat(playerid, "You have accepted death and will respawn shortly.")
end)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

SetPlayerSpectate

2021-06-26T14:50:33Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Toggle the player spectate mode.}}

{{FuncSyntax|SetPlayerSpectate(player, bSpectate)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}
{{FuncParam|bSpectate|The boolean status.}}

{{FuncReturnValue|This function returns nothing.}}

== Example ==
<syntaxhighlight lang="Lua>
function cmd_spec(player, disable)
local _disable = false
if disable ~= nil then
_disable = true
end
_disable = not _disable
SetPlayerSpectate(player, _disable)
end
AddCommand("spec", cmd_spec)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetPlayerHeading

2021-06-26T14:50:20Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Get the specified player's heading (rotation).}}

{{FuncSyntax|GetPlayerHeading(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}

{{FuncReturnValue|This function returns heading in float.}}

== Example ==
<syntaxhighlight lang='Lua'>
local heading = GetPlayerHeading(playerId)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetPlayerEquippedWeapon

2021-06-26T14:50:10Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Get the specified player's equiped weapon Id.}}

{{FuncSyntax|GetPlayerEquippedWeapon(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}

{{FuncReturnValue|This function returns the weapon ID.}}

== Example ==
<syntaxhighlight lang="Lua">
if GetPlayerEquippedWeapon(playerId) == 21 then
print("Player has equipped a taser.")
end
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetPlayerEquippedWeaponSlot

2021-06-26T14:49:57Z

FlyingFork:

{{Info|Function|Client & Server|1.0}}

{{FuncDescription|Returns the slot the player currently has equiped}}

{{FuncSyntax|GetPlayerEquippedWeaponSlot(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier}}

{{FuncReturnValue|The weapon slot the player currently has equipped}}

== Example ==
<syntaxhighlight lang="Lua>
print("Equipped Weapon Slot: " .. GetPlayerEquippedWeaponSlot(player))
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetPlayerWeapon

2021-06-26T14:49:29Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Returns the specified player's weapon id, ammo, ammo in magazine in the specified weapon slot.}}

{{FuncSyntax|GetPlayerWeapon(player [, weaponslot])}}
{{FuncSyntaxClient|GetPlayerWeapon(weaponslot)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}
{{FuncParamOptional|weaponslot|The weapon slot.}}

{{FuncReturnValue|Returns weapon id, ammo.}}
{{FuncReturnValueClient|Returns weapon id, ammo, ammo in magazine.}}

== Example ==
<syntaxhighlight lang="Lua">
print("Weapon: " .. GetPlayerWeapon(player))
</syntaxhighlight>

{{RelatedFunctions}}
* [[SetPlayerWeapon]]

SetPlayerWeaponStat

2021-06-26T14:49:01Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Modifies a weapon stat per player.}}

{{FuncSyntax|SetPlayerWeaponStat(player, weaponid, stat, value)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}
{{FuncParam|weaponid|The weapon model identifier.}}
{{FuncParam|stat|The stat name.}}
{{FuncParam|value|New stat value}}

{{FuncReturnValue|Returns '''true''' on success.}}

{| class="wikitable" style="text - align: center; "
!colspan = "6" | Weapon stats
|-
|Stat name
|Values
|-
|Range
|1.0-50000.0
|-
|Recoil
|0.0-2.0
|-
|CameraShake
|0.0-5.0
|-
|CameraShakeCrouching
|0.0-5.0
|-
|SpreadMin
|0.0-1.0
|-
|SpreadMax
|0.0-5.0
|-
|CameraShake
|0.0-5.0
|-
|SpreadMovementModifier
|''-''1.0-1.0
|-
|SpreadCrouchingModifier
|''-''1.0-1.0
|-
|RateOfFire
|1.0-1000.0
|-
|MagazineSize
|0.0-100.0
|-
|}

== Example ==
<syntaxhighlight lang="Lua">
SetPlayerWeaponStat(player, 5, "MagazineSize", 50.0) -- set their magazine size to 50% of whats in weapons JSON, can be used to make modifications like Double Mags and what not
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetPlayerVehicleSeat

2021-06-26T14:48:49Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Gets the vehicle seat a player is.}}

{{FuncSyntax|GetPlayerVehicleSeat(player)}}

{{FuncParameters}}
{{FuncParam|player|Player whos seat you want to get}}

{{FuncReturnValue|ID of the vehicle seat player is in}}

== Example ==
<syntaxhighlight lang="Lua">
function shuff(player)
local veh = GetPlayerVehicle(player)
--Check if player is inside a vehicle
if veh ~= 0 then
--if driver seat is empty
if GetVehicleDriver(veh) == 0 or not GetVehicleDriver(veh) then
if GetPlayerVehicleSeat(player) == 2 then --check if player is in passenger seat
SetPlayerInVehicle(player, veh, 1)
end
end
end
end
AddCommand('shuff', shuff)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

IsPlayerReloading

2021-06-26T14:48:33Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Check if a player is reloading a gun or not.}}

{{FuncSyntax|IsPlayerReloading(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight lang="Lua>
print("Reloading: " .. IsPlayerReloading(player) and "Yes" or "No")
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

IsPlayerAiming

2021-06-26T14:48:13Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Check if a player is aiming or not.}}

{{FuncSyntax|IsPlayerAiming(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight>
print("Aiming: " .. IsPlayerAiming(player) and "Yes" or "No")
</syntaxhighlight>

{{RelatedFunctions}}
* [[IsPlayerTalking]]
* [[IsPlayerAiming]]

GetPlayerMovementMode

2021-06-26T14:47:41Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Returns the players movement mode}}

{{FuncSyntax|GetPlayerMovementMode(player)}}

{{FuncParameters}}
{{FuncParam|player|The player}}

{{FuncReturnValue|Returns the [[MovementModes]]}}

== Example ==
<syntaxhighlight lang="Lua>
print("Player Movement Mode: " .. GetPlayerMovementMode(player))
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetPlayerState

2021-06-26T14:47:14Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Get the player ped state.}}

{{FuncSyntax|GetPlayerState(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}

{{FuncReturnValue|Returns an integer. See [[PlayerState]].}}

== Example ==
<syntaxhighlight lang='Lua'>
if GetPlayerState(playerid) == PS_DRIVER then
print("This player state is driver.")
end
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

IsPlayerTalking

2021-06-26T14:47:00Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Check if a player is talking or not.}}

{{FuncSyntax|IsPlayerTalking(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight>
print("Talking: " .. IsPlayerTalking(player) and "Yes" or "No")
</syntaxhighlight>

{{RelatedFunctions}}
* [[IsPlayerTalking]]
* [[IsPlayerAiming]]

SetPlayerVoiceEnabled

2021-06-26T14:46:20Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Enable a player's voice chat.}}

{{FuncSyntax|SetPlayerVoiceEnabled(playerid, bEnable)}}

{{FuncParameters}}
{{FuncParam|playerid|The player identifier.}}
{{FuncParam|bEnable|The boolean enable status.}}

{{FuncReturnValue|Returns '''true''' if the change was succesfull, otherwise '''false'''.}}

== Example ==
<syntaxhighlight lang="Lua">
SetPlayerVoiceEnabled(player, false) -- mute
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:VoiceFunctions}}

IsPlayerStreamedIn

2021-06-26T14:45:14Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Check if the player B (otherid) is streamed in for player A (player).}}

{{FuncSyntax|IsPlayerStreamedIn(player, otherid)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier for which the other player should be streamed in.}}
{{FuncParam|otherid|The player identifier for the player which will be streamed in.}}

{{FuncReturnValue|The function returns '''true''' on success.}}

== Example ==
<syntaxhighlight lang="Lua">
if IsPlayerStreamedIn(playerId, otherId) then
AddPlayerChat(playerId, "You have just streamed in other player.")
end
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetStreamedPlayersForPlayer

2021-06-26T14:45:00Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Returns the list of players streamed to the specified player.}}

{{FuncSyntax|GetStreamedPlayersForPlayer(player)}}

{{FuncParameters}}
{{FuncParam|player|The player identifier.}}

{{FuncReturnValue|The array of players streamed to the client.}}

== Example ==
<syntaxhighlight lang="Lua>
local streamedPlayers = GetStreamedPlayersForPlayer(playerid)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetNearestPlayer2D

2021-06-26T14:41:57Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Gets the closest player in the specified range of XY. An important function which replaces the use of looping through all players and then checking if they are the closest.}}

{{FuncSyntax|GetNearestPlayer2D(x, y)}}

{{FuncParameters}}
{{FuncParam|x|The X axis}}
{{FuncParam|y|The Y axis}}

{{FuncReturnValue|Returns the player identifier or '''false'''}}

== Example ==
<syntaxhighlight lang="Lua">
AddCommand("closest", function(player)
local x, y, z = GetPlayerLocation(player)
local target = GetNearestPlayer2D(x, y)

return AddPlayerChat(player, "Closest player is: " .. GetPlayerName(target))
end)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

GetAllPlayers

2021-06-26T14:38:35Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Get all players on the server. Useful for loops.}}

{{FuncSyntax|GetAllPlayers()}}

{{FuncParameters}}
{{FuncNoParam}}

{{FuncReturnValue|Returns a table of all players.}}

== Example ==
<syntaxhighlight lang="Lua">
function cmd_healall(player)
if (PlayerData[player].admin < 4) then
return AddPlayerChat(player, "Insufficient permission")
end

for _, v in pairs(GetAllPlayers()) do
SetPlayerHealth(v, 100.0)
end

AddPlayerChatAll("Admin "..GetPlayerName(player).." has healed all players!")
end
AddCommand("healall", cmd_healall)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

IsValidPlayer

2021-06-26T14:38:15Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Checks whether the specified player is connected to the server or not.}}

{{FuncSyntax|IsValidPlayer(player)}}

{{FuncParameters}}
{{FuncParam|player|The player id}}

{{FuncReturnValue|Returns '''true''' if the player is connected, otherwise '''false'''.}}

== Example ==
<syntaxhighlight lang="Lua>
print("Valid Player: " .. IsValidPlayer(player) and "Yes" or "No")
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerPlayerFunctions}}

IsValidPlayer

2021-06-26T14:37:50Z

FlyingFork:

SetPickupLocation

2021-06-26T14:37:00Z

FlyingFork:

{{Info|Function|Server|1.1.0}}

{{FuncDescription|Set a new location for a pickup.}}

{{FuncSyntax|SetPickupLocation(pickup, x, y, z)}}

{{FuncParameters}}
{{FuncParam|pickup|The pickup identifier.}}
{{FuncParam|x|The X coordinate}}
{{FuncParam|y|The Y coordinate}}
{{FuncParam|z|The Z coordinate}}

{{FuncReturnValue|Returns '''true''' on success..}}

== Example ==
<syntaxhighlight lang="Lua>
SetPickupLocation(pickup, 0, 0, 1000)
</syntaxhighlight>
{{RelatedFunctions}}
{{Template:ObjectFunctions}}

GetPickupDimension

2021-06-26T14:36:34Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Gets the dimension of this pickup.}}

{{FuncSyntax|GetPickupDimension(pickup)}}

{{FuncParameters}}
{{FuncParam|pickup|The pickup identifier.}}

{{FuncReturnValue|Returns the dimension.}}

== Example ==
<syntaxhighlight lang="Lua>
print("Pickup Dimension: " .. GetPickupDimension(pickup))
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:PickupFunctions}}

IsPackageStarted

2021-06-26T14:35:56Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Checks whether a package is started.}}

{{FuncSyntax|IsPackageStarted(PackageName)}}

{{FuncParameters}}
{{FuncParam|PackageName|The name of the package.}}

{{FuncReturnValue|Returns '''true''' if the package is started.}}

== Example ==
<syntaxhighlight lang="Lua>
local packageName = "dev"
print("Package state: " .. (IsPackageStarted(packageName) and "ON" or "OFF"))
</syntaxhighlight>

{{RelatedFunctions}}
*[[ImportPackage]]
*[[StartPackage]]
*[[StopPackage]]
*[[GetAllPackages]]
*[[GetPackageName]]
*[[IsPackageStarted]]
*[[GetPackageFiles]]

SetObjectRotateAxis

2021-06-26T14:34:57Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Sets the object to rotate around its own axis.}}

{{FuncSyntax|SetObjectRotateAxis(object, x, y, z)}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|x|The X axis}}
{{FuncParam|y|The Y axis}}
{{FuncParam|z|The Z axis}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua>
SetObjectRotateAxis(object, 90, 90, 90)
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:ObjectFunctions}}

SetObjectMoveTo

2021-06-26T14:32:07Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Set the object to move to the specified coordinates.}}

{{FuncSyntax|SetObjectMoveTo(object, x, y, z [, speed])}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|x|The X axis}}
{{FuncParam|y|The Y axis}}
{{FuncParam|z|The Z axis}}
{{FuncParamOptional|speed|The speed as a floating point number. (Centimeter per second)}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight lang="Lua>
SetObjectMoveTo(object, 100, 100, 100, 2)
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:ObjectFunctions}}

IsObjectMoving

2021-06-26T14:31:42Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Check if an object is moving or not.}}

{{FuncSyntax|IsObjectMoving(object)}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight lang="Lua>
if IsObjectMoving(object) then
StopObjectMove(object)
end
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:ObjectFunctions}}

GetObjectAttachmentInfo

2021-06-26T14:31:10Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Gets information on this attached object.}}

{{FuncSyntax|GetObjectAttachmentInfo(object)}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}

{{FuncReturnValue|Returns two integers. First one being the attach type (ie ATTACH_VEHICLE, [[AttachType]]) and the second one the identifier to what this object is attached to. See [[SetObjectAttached]].}}

== Example ==
<syntaxhighlight lang="Lua>
print("Object Attach Information: " .. GetObjectAttachmentInfo(object))
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:ObjectFunctions}}

IsObjectAttached

2021-06-26T14:30:30Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Check if the specified object is attached or not.}}

{{FuncSyntax|IsObjectAttached(object)}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight lang="Lua>
if IsObjectAttached(object) then
SetObjectDetached(object)
end
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:ObjectFunctions}}

SetObjectDetached

2021-06-26T14:30:08Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Detach an already attached object.}}

{{FuncSyntax|SetObjectDetached(object)}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}

{{FuncReturnValue|This function returns nothing.}}

== Example ==
<syntaxhighlight lang="Lua>
if IsObjectAttached(object) then
SetObjectDetached(object)
end
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:ObjectFunctions}}

SetObjectLocation

2021-06-26T14:29:31Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Change the specified object's location.}}

{{FuncSyntax|SetObjectLocation(object, x, y, z)}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|x|The X axis}}
{{FuncParam|y|The Y axis}}
{{FuncParam|z|The Z axis}}

{{FuncReturnValue|This function returns nothing.}}

== Example ==
<syntaxhighlight lang="Lua>
SetObjectLocation(object, 0, 0, 1000)
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:ObjectFunctions}}

GetObjectModel

2021-06-26T14:29:06Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Get the object model number ob a spawned object. See [[Objects]].}}

{{FuncSyntax|GetObjectModel(object)}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}

{{FuncReturnValue|Returns the object model number as an integer.}}

== Example ==
<syntaxhighlight lang="Lua>
print("Object Model: " .. GetObjectModel(object))
</syntaxhighlight>

{{RelatedFunctions}}
* [[GetObjectCount]]
* [[GetObjectModelCount]]
* [[GetObjectModelGroup]]
* [[GetObjectModelName]]
* [[GetStreamedObjects]]
* [[GetObjectLocation]]
* [[GetObjectRotation]]
* [[GetObjectScale]]
* [[GetObjectBoundingBox]]
* [[GetObjectSize]]
* [[EnableObjectHitEvents]]
* [[GetObjectMass]]
* [[SetObjectEditorSpeed]]
* [[SetObjectEditable]]
* [[SetObjectOutline]]
* [[SetObjectCastShadow]]
* [[SetObjectColor]]
* [[SetObjectEmissiveColor]]
* [[SetObjectTexture]]
* [[SetObjectAnimatedTexture]]

GetObjectCount

2021-06-26T14:28:46Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Get the number of spawned object instances from [[CreateObject]].}}

{{FuncSyntax|GetObjectCount()}}

{{FuncParameters}}
{{FuncNoParam}}

{{FuncReturnValue|Returns total object count.}}

== Example ==
<syntaxhighlight lang="Lua>
print("Objects: " .. GetObjectCount())
</syntaxhighlight>

{{RelatedFunctions}}
* [[GetObjectModelCount]]
* [[GetObjectModelGroup]]
* [[GetObjectModelName]]
* [[GetStreamedObjects]]
* [[GetObjectModel]]
* [[GetObjectLocation]]
* [[GetObjectRotation]]
* [[GetObjectScale]]
* [[GetObjectBoundingBox]]
* [[GetObjectSize]]
* [[EnableObjectHitEvents]]
* [[GetObjectMass]]
* [[SetObjectEditorSpeed]]
* [[SetObjectEditable]]
* [[SetObjectOutline]]
* [[SetObjectCastShadow]]
* [[SetObjectColor]]
* [[SetObjectEmissiveColor]]
* [[SetObjectTexture]]
* [[SetObjectAnimatedTexture]]

GetObjectDimension

2021-06-26T14:28:34Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Gets the dimension of this object.}}

{{FuncSyntax|GetObjectDimension(object)}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}

{{FuncReturnValue|Returns the dimension.}}

== Example ==
<syntaxhighlight lang="Lua>
print("Object Dimension: " .. GetObjectDimension(object))
</syntaxhighlight>

{{RelatedFunctions}}
* [[GetObjectModelCount]]
* [[GetObjectModelGroup]]
* [[GetObjectModelName]]
* [[GetStreamedObjects]]
* [[GetObjectModel]]
* [[GetObjectLocation]]
* [[GetObjectRotation]]
* [[GetObjectScale]]
* [[GetObjectBoundingBox]]
* [[GetObjectSize]]
* [[EnableObjectHitEvents]]
* [[GetObjectMass]]
* [[SetObjectEditorSpeed]]
* [[SetObjectEditable]]
* [[SetObjectOutline]]
* [[SetObjectCastShadow]]
* [[SetObjectColor]]
* [[SetObjectEmissiveColor]]
* [[SetObjectTexture]]
* [[SetObjectAnimatedTexture]]

SetNPCFollowVehicle

2021-06-26T14:27:39Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Make a NPC follow the vehicle.}}

{{FuncSyntax|SetNPCFollowVehicle(npc, vehicle [, speed])}}

{{FuncParameters}}
{{FuncParam|npc|The NPC identifier.}}
{{FuncParam|vehicle |The vehicle identifier.}}
{{FuncParamOptional|speed|The speed in floating point.}}

{{FuncReturnValue|This function returns nothing.}}

== Example ==
<syntaxhighlight lang="Lua">
AddCommand("follow", function(player)
local vehicle = GetPlayerVehicle(player)

if (not vehicle) then
return AddPlayerChat(player, "You must be in a vehicle!")
end

SetNPCFollowVehicle(npc, vehicle)
end)
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:NPCFunctions}}

SetNPCFollowPlayer

2021-06-26T14:26:20Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Set a NPC to follow the specified player.}}

{{FuncSyntax|SetNPCFollowPlayer(npc, player [, speed])}}

{{FuncParameters}}
{{FuncParam|npc|The NPC identifier.}}
{{FuncParam|player |The player identifier.}}
{{FuncParamOptional|speed|The speed.}}

{{FuncReturnValue|This function returns nothing.}}

== Example ==
<syntaxhighlight lang="Lua">
AddCommand("follow", function(player)
SetNPCFollowPlayer(npc, player)
end)
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:NPCFunctions}}

SetNPCLocation

2021-06-26T14:25:25Z

FlyingFork:

{{Info|Function|Server|1.0}}

{{FuncDescription|Sets the location of this npc}}

{{FuncSyntax|SetNPCLocation(npc, x, y, z)}}

{{FuncParameters}}
{{FuncParam|npc|NPC which you want to teleport}}
{{FuncParam|x|X coordinate}}
{{FuncParam|y|Y coordinate}}
{{FuncParam|z|Z coordinate}}

{{FuncReturnValue|Returns '''true''' on success.}}

== Example ==
<syntaxhighlight lang="Lua">
function bringNPC(player, npc)
local x,y,z = GetPlayerLocation(player)
SetNPCLocation(tonumber(npc), x,y,z)
end
AddCommand('bringnpc', bringNPC)
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:NPCFunctions}}

GetNPCPropertyValue

2021-06-26T14:24:33Z

FlyingFork:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Gets a property value for this entity.}}

{{FuncSyntax|GetNPCPropertyValue(npc, PropertyName)}}

{{FuncParameters}}
{{FuncParam|npc|The npc identifier}}
{{FuncParam|PropertyName|Name of the property variable}}

{{FuncReturnValue|Returns the value.}}

== Example ==
<syntaxhighlight lang="Lua>
print("NPC Name: " .. GetNPCPropertyValue(npc, "npc:name"))
</syntaxhighlight>

{{RelatedFunctions}}
{{Template:NPCFunctions}}