Doors Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
m (Rich moved page Doors Lua API to Lua Apis/Doors Lua API without leaving a redirect: adding sub-pages)
(adding DocStart)
Line 1: Line 1:
{{OffGridDocStart}}
= Doors =
= Doors =
== Description ==
== Description ==

Revision as of 17:01, 22 June 2017

Template:OffGridDocStart

Doors

Description

API to control the logic of doors in the mission

Functions

SetZoneKeys

Doors.SetZoneKeys(zoneName, keyNames)

Expected parameter types

zoneName string
keyNames Lua Table

Description: Sets a key as unlocking a specific zone

Returns: Nothing

SetNetwork

Doors.SetNetwork(networkTable)

Expected parameter types

networkTable Lua Table

Description: Sets the name of the network for the door system to use

Returns: Nothing

SetKeyOnDevice

Doors.SetKeyOnDevice(keyName, device)

Expected parameter types

keyName string
device Lua Table

Description: Sets a key as the current NFC file on a net device

Returns: Nothing

AssignKeyToCharacter

Doors.AssignKeyToCharacter(keyName, characterTable)

Expected parameter types

keyName string
characterTable Lua Table

Description: Adds a key to a characters inventory and sets it as the characters current NFC data

Returns: Nothing


Docs last hacked together on: 09/05/2017 12:46