SetVehiclePropertyValue

From Onset Developer Wiki
Revision as of 14:42, 23 December 2020 by BlueMountains (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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"