SetPlayerPropertyValue: 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 31: | Line 31: | ||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{PlayerFunctions}} |
Revision as of 17:12, 13 December 2019
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
SetPlayerPropertyValue(player, PropertyName, Value, bSync)
Client Syntax
SetPlayerPropertyValue(player, PropertyName, Value)
Parameters
- player
The player 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.
Return Value
- Returns true on success.
Example
Server
function OnPlayerJoin(player)
SetPlayerPropertyValue(player, "testValue", player + 1, true)
end
AddEvent("OnPlayerJoin", OnPlayerJoin)
Client
AddEvent("OnPlayerStreamIn", function(player)
AddPlayerChat("P: "..GetPlayerPropertyValue(player, "testValue"))
end)