GetObjectPropertyValue: 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|GetObjectPropertyValue(object, PropertyName)}} {{FuncParameter..."
 
No edit summary
 
Line 12: Line 12:


== Example ==
== Example ==
__EDIT_ME__
=== Server ===
<syntaxhighlight lang="Lua">
function OnPackageStart()
local object = CreateObject(1, 0.0, 0.0, 0.0)
SetObjectPropertyValue(object, "testValue", "Some test value string")
end
AddEvent("OnPackageStart", OnPackageStart)
</syntaxhighlight>
 
=== Client ===
<syntaxhighlight lang="Lua">
AddEvent("OnObjectStreamIn", function(object)
AddPlayerChat("Value: "..GetObjectPropertyValue(object, "testValue"))
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{ServerObjectFunctions}}

Latest revision as of 14:48, 23 December 2020

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

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