GetDoorPropertyValue: Difference between revisions
From Onset Developer Wiki
(Created page with "{{Info|Function|Server & Client|1.1.0}} {{FuncDescription|Gets 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 3: | Line 3: | ||
{{FuncDescription|Gets 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.}} | {{FuncDescription|Gets 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.}} | ||
{{FuncSyntax|GetDoorPropertyValue(door, PropertyName | {{FuncSyntax|GetDoorPropertyValue(door, PropertyName)}} | ||
{{FuncSyntaxClient|GetDoorPropertyValue(door, PropertyName | {{FuncSyntaxClient|GetDoorPropertyValue(door, PropertyName)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|door|The door identifier}} | {{FuncParam|door|The door identifier}} | ||
{{FuncParam|PropertyName|Name of the property variable}} | {{FuncParam|PropertyName|Name of the property variable}} | ||
{{FuncReturnValue|Returns ''' | {{FuncReturnValue|Returns '''propertyName''''s value.}} | ||
== Example == | == Example == | ||
| Line 18: | Line 16: | ||
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 | ||
end | end | ||
SetDoorOpen(door, not bWantsOpen) | |||
end) | end) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 06:56, 16 June 2023
Description
Gets 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
GetDoorPropertyValue(door, PropertyName)
Client Syntax
GetDoorPropertyValue(door, PropertyName)
Parameters
- door
The door identifier - PropertyName
Name of the property variable
Return Value
- Returns propertyName's value.
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)
