Endstar LUA API Documentation
Loading...
Searching...
No Matches
Lockable Class Reference

This component manages locking and unlocking of an object as well as spawning the "lock plate" of the required key! More...

Public Member Functions

KeyLibraryReference GetKeyReference ()
 Which key is currently required to unlock this?
 
void Unlock (Context instigator)
 Unlocks the door. The instigator does not have to have the key, as this could be done from say, a lever. If you are calling this from an interactable interaction, check if the context is a player, and if so, do they have the required key before calling this!
 
bool GetIsLocked ()
 

Detailed Description

This component manages locking and unlocking of an object as well as spawning the "lock plate" of the required key!

Member Function Documentation

◆ GetIsLocked()

bool GetIsLocked ( )

◆ GetKeyReference()

KeyLibraryReference GetKeyReference ( )

Which key is currently required to unlock this?

Returns

◆ Unlock()

void Unlock ( Context instigator)

Unlocks the door. The instigator does not have to have the key, as this could be done from say, a lever. If you are calling this from an interactable interaction, check if the context is a player, and if so, do they have the required key before calling this!

Parameters
instigatorThe source context that is triggering this change