Skip to content
This repository was archived by the owner on Jun 7, 2025. It is now read-only.

Commit 54d703c

Browse files
committed
Update README.md
1 parent 082a3e1 commit 54d703c

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ The plugin contains:
2929

3030
1. KeyType object;
3131
2. KeyringComponent;
32+
3. KeyringLibrary;
3233

3334
### KeyType object
3435

@@ -62,6 +63,22 @@ A component which manages keys the player got.
6263
2. `OnKeyRemoved` - called when the key was successfully removed from the keyring;
6364
3. `OnKeyUsed` - called when the key was successfully used;
6465

66+
### KeyringLibrary
67+
68+
A function library with useful functions to work with KeyringComponent.
69+
70+
#### Functions
71+
72+
1. `GetKeyringComponent` - returns KeyringComponent if the given actor has one;
73+
2. `ActorHasKey` - checks if the given actor has key;
74+
3. `AddKey` - adds key to KeyringComponent of the given actor;
75+
4. `RemoveKey` - removes key from KeyringComponent of the given actor;
76+
5. `UseKey` - force the given actor to use the given key class;
77+
6. `GetKeyObject` - returns a key object from KeyringComponent of the given actor;
78+
7. `GetKeyData` - returns key data from KeyringComponent of the given actor;
79+
8. `IsKeyDestroyable` - checks if the given key class is destroyable;
80+
9. `RemoveAllKeys` - removes all keys form KeyringComponent of the given actor;
81+
6582
## Quick setup
6683

6784
1. Add KeyRingComponent to your character;

0 commit comments

Comments
 (0)