GetVehiclePropertyValue: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server & Client|1.0}} {{FuncDescription|Gets a property value for this entity.}} {{FuncSyntax|GetVehiclePropertyValue(vehicle, PropertyName)}} {{FuncParamet..."
 
No edit summary
 
Line 12: Line 12:


== Example ==
== Example ==
__EDIT_ME__
=== Server ===
<syntaxhighlight lang="Lua">
function OnPackageStart()
local vehicle = CreateVehicle(1, 0.0, 0.0, 0.0)
SetVehiclePropertyValue(vehicle, "testValue", "Some test value string")
end
AddEvent("OnPackageStart", OnPackageStart)
</syntaxhighlight>
 
=== Client ===
<syntaxhighlight lang="Lua">
AddEvent("OnVehicleStreamIn", function(vehicle)
AddPlayerChat("Value: "..GetVehiclePropertyValue(vehicle, "testValue"))
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
*[[GetVehicleLicensePlate]]
*[[SetVehicleDimension]]
*[[GetVehicleDimension]]
*[[SetVehiclePropertyValue]]
*[[GetVehiclePropertyValue]]
*[[GetVehicleCount]]
*[[GetAllVehicles]]
*[[GetVehicleModel]]
*[[GetVehicleModelName]]
*[[SetVehicleRespawnParams]]
*[[IsVehicleStreamedIn]]
*[[GetStreamedVehiclesForPlayer]]
*[[SetVehicleLocation]]
*[[GetVehicleLocation]]
*[[SetVehicleRotation]]
*[[GetVehicleRotation]]
*[[SetVehicleHeading]]
*[[GetVehicleHeading]]
*[[SetVehicleHealth]]
*[[GetVehicleHealth]]
*[[SetVehicleLicensePlate]]
*[[GetVehicleVelocity]]
*[[CreateVehicle]]
*[[DestroyVehicle]]
*[[IsValidVehicle]]
*[[GetVehicleDriver]]
*[[GetVehiclePassenger]]
*[[GetVehicleNumberOfSeats]]
*[[SetVehicleColor]]
*[[GetVehicleColor]]
*[[SetVehicleLinearVelocity]]
*[[SetVehicleAngularVelocity]]
*[[GetVehicleGear]]
*[[SetVehicleHoodRatio]]
*[[GetVehicleHoodRatio]]
*[[SetVehicleTrunkRatio]]
*[[GetVehicleTrunkRatio]]
*[[StartVehicleEngine]]
*[[StopVehicleEngine]]
*[[GetVehicleEngineState]]
*[[SetVehicleLightEnabled]]
*[[GetVehicleLightState]]
*[[SetVehicleDamage]]
*[[GetVehicleDamage]]
*[[AttachVehicleNitro]]
*[[EnableVehicleBackfire]]

Latest revision as of 14:45, 23 December 2020

GetVehiclePropertyValue

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Gets a property value for this entity.

Syntax

GetVehiclePropertyValue(vehicle, PropertyName)

Parameters

  • vehicle
    The vehicle identifier
  • PropertyName
    Name of the property variable

Return Value

  • Returns the value.

Example

Server

function OnPackageStart()
	local vehicle = CreateVehicle(1, 0.0, 0.0, 0.0)
	SetVehiclePropertyValue(vehicle, "testValue", "Some test value string")
end
AddEvent("OnPackageStart", OnPackageStart)

Client

AddEvent("OnVehicleStreamIn", function(vehicle)
	AddPlayerChat("Value: "..GetVehiclePropertyValue(vehicle, "testValue"))
end)

See also