SetDoorPropertyValue: Difference between revisions
From Onset Developer Wiki
Created page with "{{Info|Function|Server & Client|1.1.0}} {{FuncDescription|Sets a property value for this entity. Useful to store information for individual entities which can be accessed on..." |
No edit summary |
||
| (One intermediate revision by one other 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.}} | ||
| Line 18: | Line 18: | ||
AddEvent("OnPlayerInteractDoor", function (player, door, bWantsOpen) | AddEvent("OnPlayerInteractDoor", function (player, door, bWantsOpen) | ||
if (bWantsOpen == true and | if (bWantsOpen == true and GetDoorPropertyValue(door, "locked") == true) then | ||
AddPlayerChat(player, "Door " .. door .. " is locked!") | AddPlayerChat(player, "Door " .. door .. " is locked!") | ||
return | return | ||
Latest revision as of 06:57, 16 June 2023
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
SetDoorPropertyValue(door, PropertyName, Value, bSync)
Client Syntax
SetDoorPropertyValue(door, PropertyName, Value)
Parameters
- door
The door 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
AddEvent("OnPlayerInteractDoor", function (player, door, bWantsOpen)
if (bWantsOpen == true and GetDoorPropertyValue(door, "locked") == true) then
AddPlayerChat(player, "Door " .. door .. " is locked!")
return
end
SetDoorOpen(door, not bWantsOpen)
end)
