SetObjectPropertyValue: 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
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.}}
Line 18: Line 18:


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

Revision as of 11:13, 1 September 2020

SetObjectPropertyValue

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

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

__EDIT_ME__

See also