Onset Developer Wiki - User contributions [en]

SetCameraRotation

2019-11-25T21:00:37Z

Kuzkay:

{{Info|Function|Client|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|SetCameraRotation(pitch, yaw, roll [, bWorldSpace])}}

{{FuncParameters}}
{{FuncParam|pitch|__EDIT_ME__}}
{{FuncParam|yaw|__EDIT_ME__}}
{{FuncParam|roll |__EDIT_ME__}}
{{FuncParamOptional|bWorldSpace|'''true''' for world space, '''false''' for relative location.}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

SetCameraLocation

2019-11-25T21:00:21Z

Kuzkay:

{{Info|Function|Client|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|SetCameraLocation(x, y, z [, bWorldSpace])}}

{{FuncParameters}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|z|__EDIT_ME__}}
{{FuncParamOptional|bWorldSpace|'''true''' for world space, '''false''' for relative location.}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

CreateNPC

2019-11-15T20:14:08Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|CreateNPC(x, y, z, h)}}

{{FuncParameters}}
{{FuncParam|x|X location}}
{{FuncParam|y|Y location}}
{{FuncParam|z|Z location}}
{{FuncParam|h|Heading of the npc}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

SetPickupVisibleForPlayers

2019-11-13T21:46:48Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Set pickup visible only for a certain array of players}}

{{FuncSyntax|SetPickupVisibleForPlayers(Pickup, Players)}}

{{FuncParameters}}
{{FuncParam|Pickup|ID of the pickup}}
{{FuncParam|Players|Player list in a form of an array}}

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

== Example ==
<syntaxhighlight lang="Lua">
function OnPackageStart()
local pickup = CreatePickup(2, 1000, 5330, 1503)

local players = {}
for _, v in pairs(GetAllPlayers()) do
--Only players who's property tag of "team" has been set to "zombie"
if GetPlayerPropertyValue(v, "team") == "zombie" then
table.insert(players, v)
end
end

SetPickupVisibleForPlayers(pickup, players)

end
AddEvent('OnPackageStart', OnPackageStart)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetPickupVisibleForPlayers

2019-11-13T21:44:49Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Set pickup visible only for a certain array of players}}

{{FuncSyntax|SetPickupVisibleForPlayers(Pickup, Players)}}

{{FuncParameters}}
{{FuncParam|Pickup|ID of the pickup}}
{{FuncParam|Players|Player list in a form of an array}}

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

== Example ==
<syntaxhighlight lang="Lua">
function OnPackageStart()
local pickup = CreatePickup(2, 1000, 5330, 1503)

local players = {}
for _, v in pairs(GetAllPlayers()) do
--Only players who's property tag of "team" has been set to "zombie"
if GetPlayerPropertyValue(v, 'team') == "zombie" then
table.insert(players, v)
end
end

SetPickupVisibleForPlayers(pickup, players)

end
AddEvent('OnPackageStart', OnPackageStart)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetPickupVisibleForPlayers

2019-11-13T21:44:03Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Set pickup visible only for a certain array of players}}

{{FuncSyntax|SetPickupVisibleForPlayers(Pickup, Players)}}

{{FuncParameters}}
{{FuncParam|Pickup|ID of the pickup}}
{{FuncParam|Players|Player list in a form of an array}}

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

== Example ==
<syntaxhighlight lang="Lua">
function OnPackageStart()
local pickup = CreatePickup(2, 1000, 5330, 1503)

local players = {}
for _, v in pairs(GetAllPlayers()) do
if GetPlayerPropertyValue(v, 'team') == "zombie" then
table.insert(players, v)
end
end

SetPickupVisibleForPlayers(pickup, players)

end
AddEvent('OnPackageStart', OnPackageStart)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetPickupVisibleForPlayers

2019-11-13T21:43:30Z

Kuzkay: Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|Set pickup visible only for a certain array of players}} {{FuncSyntax|StartPackage(PackageName)}} {{FuncParameters}} {{FuncPa..."

{{Info|Function|Server|1.0}}

{{FuncDescription|Set pickup visible only for a certain array of players}}

{{FuncSyntax|StartPackage(PackageName)}}

{{FuncParameters}}
{{FuncParam|Pickup|ID of the pickup}}
{{FuncParam|Players|Player list in a form of an array}}

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

== Example ==
<syntaxhighlight lang="Lua">
function OnPackageStart()
local pickup = CreatePickup(2, 1000, 5330, 1503)

local players = {}
for _, v in pairs(GetAllPlayers()) do
if GetPlayerPropertyValue(v, 'team') == "zombie" then
table.insert(players, v)
end
end

SetPickupVisibleForPlayers(pickup, players)

end
AddEvent('OnPackageStart', OnPackageStart)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetPlayerRespawnTime

2019-11-13T20:29:19Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Sets the time it takes for player to respawn after their death}}

{{FuncSyntax|SetPlayerRespawnTime(player, mstime)}}

{{FuncParameters}}
{{FuncParam|player|Player ID}}
{{FuncParam|mstime|Time in milliseoncds}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
--All players default Respawn time will be set to 30 seconds when they join the server
AddEvent("OnPlayerJoin", function (player)
SetPlayerRespawnTime(player, 30000)
end)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

GetPlayerIP

2019-11-13T20:27:34Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Returns players IP address}}

{{FuncSyntax|GetPlayerIP(player)}}

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

{{FuncReturnValue|Players IP Address}}

== Example ==
<syntaxhighlight lang="Lua">
--Do not use this without verifying if user using this command is an admin!!
function getIP(player, otherplayer)
local otherplayer = tonumber(otherplayer)
AddPlayerChat(player, GetPlayerName(otherplayer) .. "'s IP address is: " .. GetPlayerIP(otherplayer))
end
AddCommand('getip', getIP)

</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

StopPackage

2019-11-13T20:24:53Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Stops a package during runtime. If a client downloads files from it, the download will be cancelled.}}

{{FuncSyntax|StopPackage(PackageName)}}

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

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

== Example ==
<syntaxhighlight lang="Lua">
function cmd_restartpack(player, package_)
StopPackage(package_)

Delay(500, function()
StartPackage(package_)
end)
end
AddCommand("restartpack", cmd_restartpack)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

StartPackage

2019-11-13T20:24:44Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Start a package during runtime. If the package contains client files, they will be downloaded during the game.}}

{{FuncSyntax|StartPackage(PackageName)}}

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

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

== Example ==
<syntaxhighlight lang="Lua">
function cmd_restartpack(player, package_)
StopPackage(package_)

Delay(500, function()
StartPackage(package_)
end)
end
AddCommand("restartpack", cmd_restartpack)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

GetVehicleModelName

2019-11-13T20:23:43Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Returns the name of the vehicle model by its ID}}

{{FuncSyntax|GetVehicleModelName(vehicle)}}

{{FuncParameters}}
{{FuncParam|vehicle|Vehicle you want to get the model name of}}

{{FuncReturnValue|The name of the vehicle model}}

== Example ==
<syntaxhighlight lang="Lua">
function getVehName(player, vehicle, seat)
AddPlayerChat(player, "You've entered a " .. GetVehicleModelName(veh))
end
AddEvent('OnPlayerEnterVehicle', getVehName)

</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetPlayerArmor

2019-11-13T20:21:00Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|SetPlayerArmor(player, armor)}}

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

{{FuncReturnValue|This function doesn't have a return value.}}

== Example ==
<syntaxhighlight lang="Lua">
--This command allows players to set refill their armor
function armor(player)
SetPlayerArmor(player, 100)
end
AddCommand('armor', armor)

</syntaxhighlight>

{{RelatedFunctions}}
[[GetPlayerArmor]]

RemovePlayerFromVehicle

2019-11-13T20:19:35Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Used to kick players from vehicles/force exit}}

{{FuncSyntax|RemovePlayerFromVehicle(player)}}

{{FuncParameters}}
{{FuncParam|player|Player you want to kick out of a vehicle}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">

function cmd_eject(player, otherplayer)

if (otherplayer == nil) then
return AddPlayerChat(player, "Usage: /eject <player>")
end

otherplayer = tonumber(otherplayer)

if (not IsValidPlayer(otherplayer)) then
return AddPlayerChat(player, "Selected player does not exist")
end

if (GetPlayerVehicle(otherplayer) == 0) then
return AddPlayerChat(player, "Selected player is not in a vehicle")
end

local x, y, z = GetPlayerLocation(otherplayer)
SetPlayerLocation(otherplayer, x, y, z + 300)

AddPlayerChat(player, "You have ejected "..GetPlayerName(otherplayer).."("..otherplayer..") from their vehicle")
end
AddCommand("eject", cmd_eject)

</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetPlayerHealth

2019-11-13T20:18:06Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|You can use this to set players health (0-100)}}

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

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

</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetPlayerInVehicle

2019-11-13T20:15:38Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|With this function you can put players inside vehicles or use it to change their seats}}

{{FuncSyntax|SetPlayerInVehicle(player, vehicle [, seat])}}

{{FuncParameters}}
{{FuncParam|player|Player you want to set in a vehicle}}
{{FuncParam|vehicle |Vehicle you want to set player into}}
{{FuncParamOptional|seat|Seat number you want to set player into}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
--This function enables player to go from passenger seat to driver seat
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)

function spawnTaxiCar(player)
local x,y,z = GetPlayerLocation(player)
local h = GetPlayerHeading(player)

local veh = CreateVehicle(2, x, y, z, h)
SetPlayerInVehicle(player, veh)
end
AddCommand('taxi', spawnTaxiCar)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

GetPlayerVehicleSeat

2019-11-13T20:11:34Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|__EDIT_ME__}}

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

StopVehicleEngine

2019-11-13T20:06:39Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Used to stop vehicle engine}}

{{FuncSyntax|StopVehicleEngine(vehicle)}}

{{FuncParameters}}
{{FuncParam|vehicle|Vehicle which engine you want to stop}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
function StopEngine(player)
local veh = GetPlayerVehicle(player)
if veh ~= 0 then
StopVehicleEngine(veh)
end
end
AddCommand('engineoff', StopEngine)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

StartVehicleEngine

2019-11-13T20:05:20Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Used to start vehicle engine}}

{{FuncSyntax|StartVehicleEngine(vehicle)}}

{{FuncParameters}}
{{FuncParam|vehicle|Vehicle which engine you want to start}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
function StartEngine(player)
local veh = GetPlayerVehicle(player)
if veh ~= 0 then
StartVehicleEngine(veh)
end
end
AddCommand('engine', StartEngine)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

CreateText3D

2019-11-13T20:03:14Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Creates a 3d text (hologram) which always faces the player camera, only visible from certain range}}

{{FuncSyntax|CreateText3D(text, size, x, y, z, rx, ry, rz)}}

{{FuncParameters}}
{{FuncParam|text|Text you want to show}}
{{FuncParam|size|Size of the text}}
{{FuncParam|x|X position}}
{{FuncParam|y|Y position}}
{{FuncParam|z|Z position}}
{{FuncParam|rx|X rotation}}
{{FuncParam|ry|Y rotation}}
{{FuncParam|rz|Z rotation}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
function OnPackageStart()
local i = 1
for _ in pairs(Shops) do
Shops[i].npc = CreateNPC(Shops[i].npc_model, Shops[i].x, Shops[i].y, Shops[i].z, Shops[i].h)
SetNPCAnimation(Shops[i].npc, "CROSSARMS", true)
SetNPCHealth(Shops[i].npc, 999999999)
CreateText3D(Shops[i].name, 17, Shops[i].x, Shops[i].y, Shops[i].z + 130, 0,0,0)
i = i + 1
end
end
AddEvent("OnPackageStart", OnPackageStart)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

CreateText3D

2019-11-13T20:02:49Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Creates a 3d text (hologram) which always faces the player camera, only visible from certain range}}

{{FuncSyntax|CreateText3D(text, size, x, y, z, rx, ry, rz)}}

{{FuncParameters}}
{{FuncParam|text|Text you want to show}}
{{FuncParam|size|Size of the text}}
{{FuncParam|x|X position}}
{{FuncParam|y|Y position}}
{{FuncParam|z|Z position}}
{{FuncParam|rx|X rotation}}
{{FuncParam|ry|Y rotation}}
{{FuncParam|rz|Z rotation}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
function OnPackageStart()

Delay(5000, function ()
local i = 1
for _ in pairs(Shops) do
Shops[i].npc = CreateNPC(Shops[i].npc_model, Shops[i].x, Shops[i].y, Shops[i].z, Shops[i].h)
SetNPCAnimation(Shops[i].npc, "CROSSARMS", true)
SetNPCHealth(Shops[i].npc, 999999999)
CreateText3D(Shops[i].name, 17, Shops[i].x, Shops[i].y, Shops[i].z + 130, 0,0,0)
i = i + 1
end
end)

end
AddEvent("OnPackageStart", OnPackageStart)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetPlayerHeading

2019-11-13T19:59:41Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Sets players heading (rotation)}}

{{FuncSyntax|SetPlayerHeading(player, heading)}}

{{FuncParameters}}
{{FuncParam|player|Player you want to set heading of}}
{{FuncParam|heading|Angle (0-360) you want to set players heading to}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
SetPlayerHeading(player, 95)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

GetNPCHealth

2019-11-13T19:56:39Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Returns NPC's health by its ID}}

{{FuncSyntax|GetNPCHealth(npc)}}

{{FuncParameters}}
{{FuncParam|npc|NPC you want to get health of}}

{{FuncReturnValue|NPC Health}}

== Example ==
<syntaxhighlight lang="Lua">
function checkHealth(player, npc)
if IsValidNPC(tonumber(npc) then
AddPlayerChat(player, 'NPC has: ' .. GetNPCHealth(tonumber(npc)) .. ' health')
else
AddPlayerChat(player, 'This NPC doesn\'t exist!')
end
end
AddCommand('npchealth', checkHealth)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

DestroyNPC

2019-11-13T19:55:09Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Destroy/remove any NPC by its id}}

{{FuncSyntax|DestroyNPC(npc)}}

{{FuncParameters}}
{{FuncParam|npc|NPC You want to destroy/remove}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
function deleteNPC(player, npc)
if IsValidNPC(tonumber(npc)) then --Check if npc is valid first
DestroyNPC(tonumber(npc))
end
end
AddCommand('removenpc', deleteNPC)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

GetNPCHealth

2019-11-13T19:53:22Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|GetNPCHealth(npc)}}

{{FuncParameters}}
{{FuncParam|npc|NPC you want to get health of}}

{{FuncReturnValue|NPC Health}}

== Example ==
<syntaxhighlight lang="Lua">
function checkHealth(player, npc)
AddPlayerChat(player, 'NPC has: ' .. GetNPCHealth(npc) .. ' health')
end
AddCommand('npchealth', checkHealth)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetNPCLocation

2019-11-13T19:51:29Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|__EDIT_ME__}}

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

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

IsNPCStreamedIn

2019-11-13T18:21:20Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Checks if stated NPC is streamed in for the player}}

{{FuncSyntax|IsNPCStreamedIn(player, npc)}}

{{FuncParameters}}
{{FuncParam|player|Player which you want to check}}
{{FuncParam|npc|NPC which you want to check}}

{{FuncReturnValue|boolean: true or false value}}

== Example ==
<syntaxhighlight lang="Lua">
function npcCheck(player)
local x, y, z = GetPlayerLocation(player)
local npc = CreateNPC(1, x, y, z, 0)

if IsNPCStreamedIn(player, npc) then
AddPlayerChat('npc has been created and streamed in')
end
end
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

GetDoorCount

2019-11-13T18:18:42Z

Kuzkay:

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

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

{{FuncSyntax|GetDoorCount()}}

{{FuncParameters}}
{{FuncNoParam}}

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

== Example ==
<syntaxhighlight lang="Lua">
function GetDoorCount()
print(GetDoorCount())
end
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

CreateDoor

2019-11-13T18:17:25Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Creates stateful doors which can be interacted with by players by pressing 'E'. Some of them are physics doors meaning they are pushed open by running against them.

See available doors here [[Doors]].}}

{{FuncSyntax|CreateDoor(modelid, x, y, z, rotation [, bEnableInteract])}}

{{FuncParameters}}
{{FuncParam|modelid|The door from this list: [[Doors]].}}
{{FuncParam|x|World X location.}}
{{FuncParam|y|World Y location.}}
{{FuncParam|z|World Z location.}}
{{FuncParam|rotation|Yaw rotation of the door.}}
{{FuncParamOptional|bEnableInteract|'''true''' means it will send a request to the server when the player presses the 'E' key. '''false''' to disable that.}}

{{FuncReturnValue|Returns the identifier to the door.}}

== Example ==
<syntaxhighlight lang="Lua">
function OnPackageStart()
CreateDoor(40, -161386.000000, -39784.500000, 1085.000000, 0.0, true)
end
AddEvent('OnPackageStart', OnPackageStart)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

HexToRGBA

2019-11-13T18:15:22Z

Kuzkay:

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

{{FuncDescription|Converts Hex color value into RGB format}}

{{FuncSyntax|HexToRGBA(HexColor)}}

{{FuncParameters}}
{{FuncParam|HexColor|Color in Hex format}}

{{FuncReturnValue|R, G, B, A values between 0 and 255}}

== Example ==
<syntaxhighlight lang="Lua">
function convertColor(hex)
return r, g, b, a = HexToRGBA(hex)
end
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

HexToRGBA

2019-11-13T18:15:12Z

Kuzkay:

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

{{FuncDescription|Converts Hex color value into RGB format}}

{{FuncSyntax|HexToRGBA(HexColor)}}

{{FuncParameters}}
{{FuncParam|HexColor|Color in Hex format}}

{{FuncReturnValue|R, G, B, A values between 0 and 255}}

== Example ==
<syntaxhighlight lang="Lua">
function convertColor(hex)
return r, g, b, a = HexToRGBA(hex)
end
AddCommand("objtest", cmd_objtest)
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetCameraViewDistance

2019-11-03T18:07:24Z

Kuzkay:

{{Info|Function|Client|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|SetCameraViewDistance(distance)}}

{{FuncParameters}}
{{FuncParam|distance|__EDIT_ME__}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__

OnPlayerPickupHit

2019-10-04T18:02:00Z

Kuzkay:

{{Info|Event|Server|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|OnPlayerPickupHit(player, Pickup)}}

{{FuncParameters}}
== Example ==
__EDIT_ME__

{{RelatedFunctions}}
{{ServerEvents}}

StartCameraFade

2019-09-29T11:52:23Z

Kuzkay:

{{Info|Function|Client|1.0}}

{{FuncDescription|Smoothly fade in or out, Setting CameraFade will overwrite any other started camera fades which were called before}}

{{FuncSyntax|StartCameraFade(FromAlpha, ToAlpha, Duration [, HexColor])}}

{{FuncParameters}}
{{FuncParam|FromAlpha|Starting alpha (0-1)}}
{{FuncParam|ToAlpha|Alpha you want to fade to (0-1)}}
{{FuncParam|Duration |Duration of the fade in seconds}}
{{FuncParamOptional|HexColor|Hex color of the fade}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
<syntaxhighlight lang="Lua">
StartCameraFade(1.0, 0.0, 4.0, "#000")
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

SetVehicleLicensePlate

2019-08-12T14:50:13Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Sets the vehicle license plate text}}

{{FuncSyntax|SetVehicleLicensePlate(vehicle, text)}}

{{FuncParameters}}
{{FuncParam|vehicle|Vehicle identifier of vehicle which you wish to change license plate text}}
{{FuncParam|text|New license plate text (up to 13 characters)}}

{{FuncReturnValue|This function has no return value}}

== Example ==
<syntaxhighlight lang="Lua">
function cmd_lp(player, ...)

local message = table.concat({...}, " ")

if (#{...} == 0) then
return AddPlayerChat(player, "Usage: /lp <new license plate text>")
end

local vehicle = GetPlayerVehicle(player)
if (vehicle == 0) then
return AddPlayerChat(player, '<span color="#ff0000ee">You must be in a vehicle!</>')
end

if (GetPlayerVehicleSeat(player) ~= 1) then
return AddPlayerChat(player, "You must be the driver of the vehicle")
end

SetVehicleLicensePlate(vehicle, message)
end
AddCommand("lp", cmd_lp)
</syntaxhighlight>

{{RelatedFunctions}}
{{VehicleFunctions}}

SetVehicleLicensePlate

2019-08-12T14:48:48Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Sets vehicle license plate text}}

{{FuncSyntax|SetVehicleLicensePlate(vehicle, text)}}

{{FuncParameters}}
{{FuncParam|vehicle|Vehicle identifier of vehicle which you wish to change license plate text}}
{{FuncParam|text|New license plate text (up to 13 characters)}}

{{FuncReturnValue|This function has no return value}}

== Example ==
<syntaxhighlight lang="Lua">
function cmd_lp(player, ...)

local message = table.concat({...}, " ")

if (#{...} == 0) then
return AddPlayerChat(player, "Usage: /lp <new license plate text>")
end

local vehicle = GetPlayerVehicle(player)
if (vehicle == 0) then
return AddPlayerChat(player, '<span color="#ff0000ee">You must be in a vehicle!</>')
end

if (GetPlayerVehicleSeat(player) ~= 1) then
return AddPlayerChat(player, "You must be the driver of the vehicle")
end

SetVehicleLicensePlate(vehicle, message)
end
AddCommand("lp", cmd_lp)
</syntaxhighlight>

{{RelatedFunctions}}
{{VehicleFunctions}}

CreateObject

2019-08-12T14:47:50Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|This function creates an object at a desired location. See [[Objects]] for a list of models.}}

{{FuncSyntax|CreateObject(modelid, x, y, z [, rx, ry, rz, sx, sy, sz])}}

{{FuncParameters}}
{{FuncParam|modelid|The [[Objects|model identifier]] for which object to spawn.}}
{{FuncParam|x|X coordinate}}
{{FuncParam|y|Y coordinate}}
{{FuncParam|z|Z coordinate}}
{{FuncParamOptional|rx|Pitch}}
{{FuncParamOptional|ry|Yaw}}
{{FuncParamOptional|rz|Roll}}
{{FuncParamOptional|sx|X scale}}
{{FuncParamOptional|sy|Y scale}}
{{FuncParamOptional|sz|Z scale}}

{{FuncReturnValue|Returns an identifier to the new object. '''false''' on error.}}

== Example ==
<syntaxhighlight lang="Lua">
function cmd_objtest(player)
local x, y, z = 64151.0234375, 48423.33984375, 4516.530273

for c=1,50 do
for r=1,50 do
CreateObject(592, x + (c * 350.0), y + (r * 350.0), z)
end
end
end
AddCommand("objtest", cmd_objtest)
</syntaxhighlight>

{{RelatedFunctions}}
{{ObjectFunctions}}

SetVehicleLicensePlate

2019-08-12T14:45:26Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Sets vehicle license plate text (up to 13 characters)}}

{{FuncSyntax|SetVehicleLicensePlate(vehicle, text)}}

{{FuncParameters}}
{{FuncParam|vehicle|Vehicle identifier of vehicle which you wish to change license plate text}}
{{FuncParam|text|New license plate text}}

{{FuncReturnValue|This function has no return value}}

== Example ==
<syntaxhighlight lang="Lua">
function cmd_lp(player, ...)

local message = table.concat({...}, " ")

if (#{...} == 0) then
return AddPlayerChat(player, "Usage: /lp <new license plate text>")
end

local vehicle = GetPlayerVehicle(player)
if (vehicle == 0) then
return AddPlayerChat(player, '<span color="#ff0000ee">You must be in a vehicle!</>')
end

if (GetPlayerVehicleSeat(player) ~= 1) then
return AddPlayerChat(player, "You must be the driver of the vehicle")
end

SetVehicleLicensePlate(vehicle, message)
end
AddCommand("lp", cmd_lp)
</syntaxhighlight>

{{RelatedFunctions}}
{{VehicleFunctions}}

AttachVehicleNitro

2019-08-12T14:31:38Z

Kuzkay:

{{Info|Function|Server|1.0}}

{{FuncDescription|Enabled/Disables vehicle nitro function, value can be true or false}}

{{FuncSyntax|AttachVehicleNitro(vehicle [, attach])}}

{{FuncParameters}}
{{FuncParam|vehicle |Vehicle object which you want to attach nitro to}}
{{FuncParamOptional|attach|boolean, an true or false value}}

{{FuncReturnValue|This function does not return any values}}

== Example ==
<syntaxhighlight lang="Lua">
function ToggleNitro(player)
--Gets vehicle player is currently driving
local vehicle = GetPlayerVehicle(player)

--make sure vehicle is not equal to 0
if vehicle ~= 0 then
--enable nitro + print a message on the chat
AttachVehicleNitro(vehicle, true)

AddPlayerChat(player, "Nitro has been enabled")
else
--vehicle was equal to 0 and vehicle was not found, print an error message on the chat
AddPlayerChat(player, "You must be in a vehicle to enable nitro")
end

end
</syntaxhighlight>

{{RelatedFunctions}}
__EDIT_ME__

GetCameraFoV

2019-08-12T14:15:48Z

Kuzkay:

{{Info|Function|Client|1.0}}

{{FuncDescription|Gets clients current FOV value}}

{{FuncSyntax|GetPlayerFOV()}}

{{FuncParameters}}
{{FuncNoParam}}

{{FuncReturnValue|Returns clients current FOV value}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__