SetPickupPropertyValue: 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 |
||
| (One intermediate revision by the same user not shown) | |||
| 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.}} | ||
== Example == | == Example == | ||
=== Server === | |||
<syntaxhighlight lang="Lua"> | |||
function OnPackageStart() | |||
local pickup = CreatePickup(1, 0.0, 0.0, 0.0) | |||
SetPickupPropertyValue(pickup, "testValue", "Some test value string") | |||
end | |||
AddEvent("OnPackageStart", OnPackageStart) | |||
</syntaxhighlight> | |||
=== Client === | |||
<syntaxhighlight lang="Lua"> | |||
AddEvent("OnPickupStreamIn", function(pickup) | |||
AddPlayerChat("P: "..GetPickupPropertyValue(pickup, "testValue")) | |||
end) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
*[[SetPickupDimension]] | |||
*[[GetPickupDimension]] | |||
*[[SetPickupPropertyValue]] | |||
*[[GetPickupPropertyValue]] | |||
*[[SetPickupVisibleForPlayers]] | |||
*[[GetPickupCount]] | |||
*[[GetAllPickups]] | |||
*[[CreatePickup]] | |||
*[[DestroyPickup]] | |||
*[[IsValidPickup]] | |||
*[[SetPickupScale]] | |||
*[[GetPickupScale]] | |||
*[[SetPickupVisibility]] | |||
*[[SetPickupLocation]] | |||
Latest revision as of 21:33, 22 December 2020
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
SetPickupPropertyValue(pickup, PropertyName, Value, bSync)
Client Syntax
SetPickupPropertyValue(pickup, PropertyName, Value)
Parameters
- pickup
The pickup 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 pickup = CreatePickup(1, 0.0, 0.0, 0.0)
SetPickupPropertyValue(pickup, "testValue", "Some test value string")
end
AddEvent("OnPackageStart", OnPackageStart)
Client
AddEvent("OnPickupStreamIn", function(pickup)
AddPlayerChat("P: "..GetPickupPropertyValue(pickup, "testValue"))
end)
