GetDoorPropertyValue

From Onset Developer Wiki
Revision as of 06:56, 16 June 2023 by Sporny (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
GetDoorPropertyValue

Type: Function
Context: Server & Client
Introduced: v1.1.0

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)

See also