Doors Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(Update)
mNo edit summary
(8 intermediate revisions by 3 users not shown)
Line 8: Line 8:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| zoneName || string
| zoneName || string
Line 18: Line 20:


=== SetNetwork ===
=== SetNetwork ===
<syntaxhighlight source lang="lua">Doors.SetNetwork(networkTable)</syntaxhighlight>
<syntaxhighlight source lang="lua">Doors.SetNetwork(networkName)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
|-
| networkTable || Lua Table
! Name !! Type
|-
| networkName || string
|}
|}
'''Description''': Sets the name of the network for the door system to use
'''Description''': Sets the name of the network for the door system to use
Line 29: Line 33:


=== SetKeyOnDevice ===
=== SetKeyOnDevice ===
<syntaxhighlight source lang="lua">Doors.SetKeyOnDevice(keyName, device)</syntaxhighlight>
<syntaxhighlight source lang="lua">Doors.SetKeyOnDevice(keyName, deviceName)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| keyName || string
| keyName || string
|-
|-
| device || Lua Table
| deviceName || string
|}
|}
'''Description''': Sets a key as the current NFC file on a net device
'''Description''': Sets a key as the current NFC file on a net device
Line 42: Line 48:


=== AssignKeyToCharacter ===
=== AssignKeyToCharacter ===
<syntaxhighlight source lang="lua">Doors.AssignKeyToCharacter(keyName, characterTable)</syntaxhighlight>
<syntaxhighlight source lang="lua">Doors.AssignKeyToCharacter(keyName, character)</syntaxhighlight>
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| keyName || string
| keyName || string
|-
|-
| characterTable || Lua Table
| character || Lua Type
|}
|}
'''Description''': Adds a key to a characters inventory and sets it as the characters current NFC data
'''Description''': Adds a key to a characters inventory and sets it as the characters current NFC data
'''Returns''': Nothing
=== Open ===
<syntaxhighlight source lang="lua">Doors.Open(doorID)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| doorID || string
|}
'''Description''': Open the specified door.
'''Returns''': Nothing
'''Notes''': This call will not open a locked door. If the door is (or could potentially be) locked, call Unlock first to guarantee that it will open
=== Close ===
<syntaxhighlight source lang="lua">Doors.Close(doorID)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| doorID || string
|}
'''Description''': close the specified door.
'''Returns''': Nothing
'''Notes''': This will close the door regardless of is someone is in the way. Please contact Semaeopus Health & Safety if this is a problem.
=== Unlock ===
<syntaxhighlight source lang="lua">Doors.Unlock(doorID)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| doorID || string
|}
'''Description''': Unlock the specified door
'''Returns''': Nothing
=== Lock ===
<syntaxhighlight source lang="lua">Doors.Lock(doorID)</syntaxhighlight>
'''Expected parameter types'''
{| class="wikitable"
|-
! Name !! Type
|-
| doorID || string
|}
'''Description''': Lock the specified door


'''Returns''': Nothing
'''Returns''': Nothing
Line 58: Line 120:
This file is auto generated, please don't edit manually!
This file is auto generated, please don't edit manually!


'''Docs last hacked together on''': 13/09/2017 13:56
'''Docs last hacked together on''': 23/07/2020 11:58
[[Category:Modding]][[Category:LuaAPI]]

Revision as of 12:33, 23 July 2020

Doors

Description

API to control the logic of doors in the mission

Functions

SetZoneKeys

Doors.SetZoneKeys(zoneName, keyNames)

Expected parameter types

Name Type
zoneName string
keyNames Lua Table

Description: Sets a key as unlocking a specific zone

Returns: Nothing

SetNetwork

Doors.SetNetwork(networkName)

Expected parameter types

Name Type
networkName string

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

Returns: Nothing

SetKeyOnDevice

Doors.SetKeyOnDevice(keyName, deviceName)

Expected parameter types

Name Type
keyName string
deviceName string

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

Returns: Nothing

AssignKeyToCharacter

Doors.AssignKeyToCharacter(keyName, character)

Expected parameter types

Name Type
keyName string
character Lua Type

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

Returns: Nothing

Open

Doors.Open(doorID)

Expected parameter types

Name Type
doorID string

Description: Open the specified door.

Returns: Nothing

Notes: This call will not open a locked door. If the door is (or could potentially be) locked, call Unlock first to guarantee that it will open

Close

Doors.Close(doorID)

Expected parameter types

Name Type
doorID string

Description: close the specified door.

Returns: Nothing

Notes: This will close the door regardless of is someone is in the way. Please contact Semaeopus Health & Safety if this is a problem.

Unlock

Doors.Unlock(doorID)

Expected parameter types

Name Type
doorID string

Description: Unlock the specified door

Returns: Nothing

Lock

Doors.Lock(doorID)

Expected parameter types

Name Type
doorID string

Description: Lock the specified door

Returns: Nothing


This file is auto generated, please don't edit manually!

Docs last hacked together on: 23/07/2020 11:58