GetObjectPropertyValue

From Onset Developer Wiki
Revision as of 14:48, 23 December 2020 by BlueMountains (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
GetObjectPropertyValue

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

Description

Gets a property value for this entity.

Syntax

GetObjectPropertyValue(object, PropertyName)

Parameters

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

Return Value

  • Returns the value.

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