GetDoorPropertyValue: Difference between revisions

From Onset Developer Wiki
28days (talk | contribs)
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..."
 
28days (talk | contribs)
No edit summary
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, Value, bSync)}}
{{FuncSyntax|GetDoorPropertyValue(door, PropertyName)}}
{{FuncSyntaxClient|GetDoorPropertyValue(door, PropertyName, Value)}}
{{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}}
{{FuncParam|Value|Value can be a boolean, integer, float, string or table}}
{{FuncParamOptional|bSync|Enable automatic network sync for this property value.}}


{{FuncReturnValue|Returns '''true''' on success.}}
{{FuncReturnValue|Returns '''propertyName''''s  value.}}


== Example ==
== Example ==

Revision as of 05:29, 7 March 2020

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 GetPlayerDoorPropertyValue(door, "locked") == true) then
		AddPlayerChat(player, "Door " .. door .. " is locked!")
		return
	end

	GetDoorOpen(door, not bWantsOpen)
end)

See also