SetVehiclePropertyValue: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server & Client|1.0}} {{FuncDescription|Sets a property value for this entity. Useful to store information for individual entities which can be accessed on cl..."
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 10: Line 10:
{{FuncParam|PropertyName|Name of the property variable}}
{{FuncParam|PropertyName|Name of the property variable}}
{{FuncParam|Value|Value can be a boolean, integer, float, string or table}}
{{FuncParam|Value|Value can be a boolean, integer, float, string or table}}
{{FuncParamOptional|bSync|Enable automatic network sync for this property value.}}
{{FuncParamOptional|bSync|Enable automatic network sync for this property value. Default: '''true'''}}


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


== 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:42, 23 December 2020

SetVehiclePropertyValue

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

Description

Sets a property value for this entity. Useful to store information for individual entities which can be accessed on client and server and across different packages.

Syntax

SetVehiclePropertyValue(vehicle, PropertyName, Value, bSync)
Client Syntax
SetVehiclePropertyValue(vehicle, PropertyName, Value)

Parameters

  • vehicle
    The vehicle identifier
  • PropertyName
    Name of the property variable
  • Value
    Value can be a boolean, integer, float, string or table
  • bSync (optional)
    Enable automatic network sync for this property value. Default: true

Return Value

  • Returns true on success.

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

Retrieved from "https://dev.playonset.com/index.php?title=SetVehiclePropertyValue&oldid=4558"