SetDoorPropertyValue

From Onset Developer Wiki
Revision as of 05:22, 7 March 2020 by 28days (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
SetDoorPropertyValue

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

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.

Return Value

  • Returns true on success.

Example

AddEvent("OnPlayerInteractDoor", function (player, door, bWantsOpen)

	if (bWantsOpen == true and GetPlayerDoorPropertyValue(door, "locked") == true) then
		AddPlayerChat(player, "Door " .. door .. " is locked!")
		return
	end

	SetDoorOpen(door, not bWantsOpen)
end)

See also