Difference between revisions of "Doors Lua API"

From Off Grid Wiki
Jump to navigation Jump to search
Line 77: Line 77:
  
 
'''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
 
'''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 ===
 
=== Unlock ===
 
<syntaxhighlight source lang="lua">Doors.Unlock(doorID)</syntaxhighlight>
 
<syntaxhighlight source lang="lua">Doors.Unlock(doorID)</syntaxhighlight>
Line 107: Line 121:
 
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''': 08/03/2019 13:51
+
'''Docs last hacked together on''': 15/11/2019 14:59
 
[[Category:Modding]][[Category:LuaAPI]]
 
[[Category:Modding]][[Category:LuaAPI]]

Revision as of 18:02, 19 November 2019

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(networkTable)

Expected parameter types

Name Type
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

Name Type
keyName string
device Lua Table

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

Notes: The character parameter can be either a character table, as set out in your mission script, or the internal name of the character to be assigned the key

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: 15/11/2019 14:59