Onset Developer Wiki - User contributions [en]

GetPlayerEquippedWeaponSlot

2019-12-22T16:47:56Z

Justus: typo

{{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 ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

GetTimeSeconds

2019-12-22T16:46:51Z

Justus: GetTimeSeconds edits

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

{{FuncDescription|Returns the amount of time since the game started up}}

{{FuncSyntax|GetTimeSeconds()}}

{{FuncParameters}}
{{FuncNoParam}}

{{FuncReturnValue|Returns a float value of the amount of time passed since the game strarted}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

GetPlayerEquippedWeaponSlot

2019-12-22T16:46:01Z

Justus: info fill for GetPlayerEquippedWeaponSlot

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

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

{{FuncSyntax|GetPlayerEquippedWeaponSlot(player)}}

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

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

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

GetTerrainHeight

2019-12-22T16:44:58Z

Justus: terriain heiught edit

{{Info|Function|Client|1.0}}

{{FuncDescription|Creates a linetrace from the given coordiantes facing downwards and returns the Z value of the first hit object.}}

{{FuncSyntax|GetTerrainHeight(sX, sY, sZ)}}

{{FuncParameters}}
{{FuncParam|sX|X float value}}
{{FuncParam|sY|Y float value}}
{{FuncParam|sZ|Z float value}}

{{FuncReturnValue|Returns Z value of first hit object, else returns false}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

SetPlayerRotationRate

2019-12-22T16:43:15Z

Justus: minor adjustment

{{Info|Function|Client|1.0}}

{{FuncDescription|Sets the speed of the players rotation.}}

{{FuncSyntax|SetPlayerRotationRate(RotationRate)}}

{{FuncParameters}}
{{FuncParam|RotationRate|Float value between -720.0 and 720.0}}

{{FuncReturnValue|True on success}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

IsFloatNearlyZero

2019-12-21T17:50:34Z

Justus: more see also links

{{Info|Function|Client|1.0}}

{{FuncDescription|Checks if a float value is nearly zero.}}

{{FuncSyntax|IsFloatNearlyZero(Value)}}

{{FuncParameters}}
{{FuncParam|Value|The float value}}

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

== Example ==
<syntaxhighlight lang="Lua">
if IsFloatNearlyZero(GetPlayerHealth()) then
AddPlayerChat("You are about to die")
end
</syntaxhighlight>

{{RelatedFunctions}}
* [[RandomFloat]]
* [[Base64Encode]]
* [[Base64Decode]]
* [[GetPlayerHealth]]
* [[SetPlayerHealth]]
* [[GetPlayerArmor]]
* [[SetPlayerArmor]]

IsFloatNearlyZero

2019-12-21T17:48:08Z

Justus: basic example

SetNearClipPlane

2019-12-20T18:01:47Z

Justus: Minor addition

{{Info|Function|Client|1.0}}

{{FuncDescription|This function culls triangles in a certain distance. Useful for the first person mode to hide head attachments.}}

{{FuncSyntax|SetNearClipPlane(distance)}}

{{FuncParameters}}
{{FuncParam|distance|The distance in which you have to cull the objects. Set to zero (0) to reset back to defaults.}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
function OnKeyPress(key)
if key == "P" then
local bEnable = not IsFirstPersonCamera()
EnableFirstPersonCamera(bEnable)
SetNearClipPlane(15)
end
end
AddEvent("OnKeyPress", OnKeyPress)
</syntaxhighlight>

{{RelatedFunctions}}
{{ClientPlayerFunctions}}

DestroyDoor

2019-12-19T23:38:01Z

Justus: Simple destroydoor example

{{Info|Function|Server|1.0}}

{{FuncDescription|Destroys a door that was earlier created by [[CreateDoor]].}}

{{FuncSyntax|DestroyDoor(door)}}

{{FuncParameters}}
{{FuncParam|door|The door to destroy.}}

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

== Example ==
<syntaxhighlight lang="Lua">
function cmd_destroydoor(player, door)
if (IsValidDoor(door)) then
return DestroyDoor(door)
end
AddPlayerChat(player, "Invalid door")
end
AddCommand("destroydoor", cmd_destroydoor)
</syntaxhighlight>

{{RelatedFunctions}}
* [[IsValidDoor]]
* [[GetDoorCount]]
* [[GetDoorLocation]]
* [[GetStreamedDoors]]
* [[GetSoundCount]]

CreateFireworks

2019-12-19T19:25:20Z

Justus: Updated description

{{Info|Function|Client|1.0}}

{{FuncDescription|Creates fireworks that shoot upwards and explode. ModelId presets contain various shapes/styles of fireworks.}}

{{FuncSyntax|CreateFireworks(modelid, x, y, z, rx, ry, rz)}}
<div class="noprint" style="float:right;">
[[File:fireworks.png|400px]]
</div>
{{FuncParameters}}
{{FuncParam|modelid|Id for fireworks preset (1-13).}}
{{FuncParam|x|World X location.}}
{{FuncParam|y|World Y location.}}
{{FuncParam|z|World Z location.}}
{{FuncParam|rx|Pitch rotation. Should be 90.0 to have the fireworks shoot up.}}
{{FuncParam|ry|Yaw rotation.}}
{{FuncParam|rz|Roll rotation.}}

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

== Example ==
'''Client:'''
<syntaxhighlight lang="Lua>
function ClientCreateFireworks(type)
local x, y, z = GetPlayerLocation()
CreateFireworks(type, x, y, z + 150, 90, 0, 0)
end
AddRemoteEvent("ClientCreateFireworks", ClientCreateFireworks)
</syntaxhighlight>

'''Server:'''
<syntaxhighlight lang="Lua>
function cmd_fireworks(player, type)
if (type == nil) then
return AddPlayerChat(player, "Usage: /fireworks <type 1-13>")
end

type = tonumber(type)

if (type < 0 or type > 13) then
return AddPlayerChat(player, "Parameter \"type\" 1-13")
end

CallRemoteEvent(player, "ClientCreateFireworks", type)
AddPlayerChat(player, "Fireworks created!")
end
AddCommand("fireworks", cmd_fireworks)
</syntaxhighlight>

{{RelatedFunctions}}
*[[CreateExplosion]]
*[[CreateFireworks]]

CreateFireworks

2019-12-19T19:24:03Z

Justus: Added a create firework command example

{{Info|Function|Client|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|CreateFireworks(modelid, x, y, z, rx, ry, rz)}}
<div class="noprint" style="float:right;">
[[File:fireworks.png|400px]]
</div>
{{FuncParameters}}
{{FuncParam|modelid|Id for fireworks preset (1-13).}}
{{FuncParam|x|World X location.}}
{{FuncParam|y|World Y location.}}
{{FuncParam|z|World Z location.}}
{{FuncParam|rx|Pitch rotation. Should be 90.0 to have the fireworks shoot up.}}
{{FuncParam|ry|Yaw rotation.}}
{{FuncParam|rz|Roll rotation.}}

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

== Example ==
'''Client:'''
<syntaxhighlight lang="Lua>
function ClientCreateFireworks(type)
local x, y, z = GetPlayerLocation()
CreateFireworks(type, x, y, z + 150, 90, 0, 0)
end
AddRemoteEvent("ClientCreateFireworks", ClientCreateFireworks)
</syntaxhighlight>

'''Server:'''
<syntaxhighlight lang="Lua>
function cmd_fireworks(player, type)
if (type == nil) then
return AddPlayerChat(player, "Usage: /fireworks <type 1-13>")
end

type = tonumber(type)

if (type < 0 or type > 13) then
return AddPlayerChat(player, "Parameter \"type\" 1-13")
end

CallRemoteEvent(player, "ClientCreateFireworks", type)
AddPlayerChat(player, "Fireworks created!")
end
AddCommand("fireworks", cmd_fireworks)
</syntaxhighlight>

{{RelatedFunctions}}
*[[CreateExplosion]]
*[[CreateFireworks]]

SetObjectEmissiveColor

2019-12-19T19:02:43Z

Justus: Added image of in game example

{{Info|Function|Client|1.0}}

{{FuncDescription|Makes an object glow with a specified hexadecimal value, intensity and material slot on the object}}

{{FuncSyntax|SetObjectEmissiveColor(object, ColorHex, EmissiveStrength [, MaterialSlot])}}
<div class="noprint" style="float:right;">
[[File:glowing hat example.png|thumb|right|Glowing Hat Example (0x000FF)]]
</div>
{{FuncParameters}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|ColorHex|Hexadecimal color value}}
{{FuncParam|EmissiveStrength|The strength/brightness of the glow}}
{{FuncParamOptional|MaterialSlot|The material slot of the object model}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
function OnObjectStreamIn(object)
local glow = GetObjectPropertyValue(object, "glow") -- 0x0000FF

if glow ~= nil then
local intensity = 30
SetObjectEmissiveColor(object, glow, intensity )
end
end
AddEvent("OnObjectStreamIn", OnObjectStreamIn)
</syntaxhighlight>

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

File:glowing hat example.png

2019-12-19T19:01:33Z

Justus:

Setting the EmissiveColor of a hat object

SetObjectEmissiveColor

2019-12-19T18:56:10Z

Justus: Added more info regarding EmissiveColor with a barebones example

{{Info|Function|Client|1.0}}

{{FuncDescription|Makes an object glow with a specified hexadecimal value, intensity and material slot on the object}}

{{FuncSyntax|SetObjectEmissiveColor(object, ColorHex, EmissiveStrength [, MaterialSlot])}}

{{FuncParameters}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|ColorHex|Hexadecimal color value}}
{{FuncParam|EmissiveStrength|The strength/brightness of the glow}}
{{FuncParamOptional|MaterialSlot|The material slot of the object model}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
function OnObjectStreamIn(object)
local glow = GetObjectPropertyValue(object, "glow") -- 0x0000FF

if glow ~= nil then
local intensity = 30
SetObjectEmissiveColor(object, glow, intensity )
end
end
AddEvent("OnObjectStreamIn", OnObjectStreamIn)
</syntaxhighlight>

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

OnPlayerStreamIn

2019-12-19T18:45:26Z

Justus: /* Added an basic example of syncing clothing presets on stream in */

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

{{FuncDescription|Called when another user is streamed in (rendered) for the player.}}

{{FuncSyntax|OnPlayerStreamIn(player, otherplayer)}}
{{FuncSyntaxClient|OnPlayerStreamIn(player)}}

{{FuncParameters}}
{{FuncParam|player|The player for the other player is streamed in.}}
{{FuncParam|otherplayer|The player that streams in for player.}}

== Example ==
'''A barebones example of syncing player clothing presets:'''
<syntaxhighlight lang="Lua>
function OnPlayerStreamIn(player)
-- Assuming `_modelPreset` is the player's clothing preset id,
-- set their clothing so the client doesn't see them naked.
local _modelPreset = GetPlayerPropertyValue(player, "_modelPreset")
if (_modelPreset ~= nil and _modelPreset > 0) then
SetPlayerClothingPreset(player, _modelPreset)
end
end
AddEvent("OnPlayerStreamIn", OnPlayerStreamIn)
</syntaxhighlight>

{{RelatedFunctions}}
{{ServerEvents}}

OnPlayerStreamIn

2019-12-19T18:39:27Z

Justus: Updated description

GetGameVersion

2019-12-19T18:31:58Z

Justus: /* GetGameVersion Client & Server examples */

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

{{FuncDescription|Returns the server/ client's game version}}

{{FuncSyntax|GetGameVersion()}}

{{FuncParameters}}
{{FuncNoParam}}

{{FuncReturnValue|Returns the server/ client's game version}}

== Example ==
'''Client:'''
<syntaxhighlight lang="Lua">
local function OnPackageStart()
AddPlayerChat("Your game version is: "..GetGameVersion())
end
AddEvent("OnPackageStart", OnPackageStart)
</syntaxhighlight>

'''Server:'''
<syntaxhighlight lang="Lua">
local function OnPlayerJoin(player)
AddPlayerChat(player, "This server runs on game version: "..GetGameVersion())
end
AddEvent("OnPlayerJoin", OnPlayerJoin)
</syntaxhighlight>

{{RelatedFunctions}}
* [[GetGameVersionString]]

SetPlayerLocation

2019-12-19T18:19:55Z

Justus: /* Added TeleportTo function example */

{{Info|Function|Server|1.0}}

{{FuncDescription|Set the specified client's location.}}

{{FuncSyntax|SetPlayerLocation(player, x, y, z)}}

{{FuncParameters}}
{{FuncParam|player|The client identifier}}
{{FuncParam|x|The X coordinate of position to put the player at.}}
{{FuncParam|y|The Y coordinate of position to put the player at.}}
{{FuncParam|z|The Z coordinate of position to put the player at.}}

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

== Example ==
<syntaxhighlight lang="Lua">
AddCommand("town", function(player)
SetPlayerLocation(player, -182821.00, -41675.00, 1160.00)
AddPlayerChat(player, "Teleported to town.")
end)
</syntaxhighlight>

(server) '''Teleport function example:'''
<syntaxhighlight lang="Lua">
function TeleportTo(player, x, y, z, h)
-- if the player is in a vehicle it will teleport the vehicle with them.
-- h = player heading
h = h or -1.0

if (GetPlayerVehicleSeat(player) == 1) then
local vehicle = GetPlayerVehicle(player)
SetVehicleLocation(vehicle, x, y, z)
if (h ~= -1.0) then
SetVehicleHeading(vehicle, h)
end

-- Reset velocity
SetVehicleLinearVelocity(vehicle, 0.0, 0.0, 0.0, true)
SetVehicleAngularVelocity(vehicle, 0.0, 0.0, 0.0, true)
local rx, ry, rz = GetVehicleRotation(vehicle)
-- Reset pitch and roll, leave yaw alone
SetVehicleRotation(vehicle, 0.0, ry, 0.0)
else
SetPlayerLocation(player, x, y, z)
if (h ~= -1.0) then
SetPlayerHeading(player, h)
end
end
--ResetPlayerCamera(player)
end
</syntaxhighlight>

{{RelatedFunctions}}
* [[GetPlayerLocation]]