SetObjectPropertyValue

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

SetObjectPropertyValue(object, PropertyName, Value, bSync)

Client Syntax

SetObjectPropertyValue(object, PropertyName, Value)

Parameters

• object
  The object 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 object = CreateObject(1, 0.0, 0.0, 0.0)
	SetObjectPropertyValue(object, "testValue", "Some test value string")
end
AddEvent("OnPackageStart", OnPackageStart)

Client

AddEvent("OnObjectStreamIn", function(object)
	AddPlayerChat("Value: "..GetObjectPropertyValue(object, "testValue"))
end)

See also

• SetObjectDimension
• GetObjectDimension
• SetObjectPropertyValue
• GetObjectPropertyValue
• CreateObject
• DestroyObject
• IsValidObject
• GetObjectCount
• SetObjectModel
• GetObjectModel
• IsObjectStreamedIn
• EnableObjectStreamEvents
• SetObjectStreamDistance
• SetObjectLocation
• GetObjectLocation
• SetObjectRotation
• GetObjectRotation
• SetObjectScale
• GetObjectScale
• SetObjectAttached
• SetObjectDetached
• IsObjectAttached
• GetObjectAttachmentInfo
• IsObjectMoving
• SetObjectMoveTo
• StopObjectMove
• SetObjectRotateAxis
• GetAllObjects