Skip to content
This repository was archived by the owner on Sep 24, 2023. It is now read-only.

Commit 609f411

Browse files
committed
Update README for overhaul of plugin
1 parent 058de2c commit 609f411

1 file changed

Lines changed: 26 additions & 5 deletions

File tree

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,32 @@
11
# Level KeyValues
2-
A helper plugin that transforms the level's entity string into a `KeyValues` handle.
2+
A helper plugin that transforms the level's entity string into a `StringMultiMap` handle.
33

4-
## Information
4+
## Dependencies
55

6-
The plugin's `KeyValues` handle only does reads. Any modifications to the `KeyValues` structure are not applied to the map entities.
6+
* The [More ADTs extension][madt] provides the `StringMultiMap` handle type, providing proper
7+
support for one-to-many mappings without an additional handle for each unique key.
78

8-
This was mostly meant as a proof-of-concept (I was interested in reading output rules for a better round win command).
9-
Never really got around to designing a decent API for property manipulation as [Stripper:Source] does.
9+
[madt]: https://github.com/nosoop/SMExt-MoreADTs/releases
10+
11+
## Usage
12+
13+
Think of it as a more flexible, barebones version of [Stripper:Source].
14+
15+
You don't get the nice configuration files for fixed filterings, but you do get the following:
16+
17+
```
18+
forward Action LevelEntity_OnEntityKeysParsed(LevelEntityKeyValues entity);
19+
```
20+
21+
Plugins listening to the forward can add / remove keys, or return `Plugin_Stop` to filter the
22+
entity out entirely.
23+
24+
```
25+
forward void LevelEntity_OnAllEntitiesParsed();
26+
native void LevelEntity_InsertEntityKeys(LevelEntityKeyValues entity);
27+
```
28+
29+
Plugins can instantiate their own instances of `LevelEntityKeyValues` and call
30+
`LevelEntity_InsertEntityKeys` during this forward to add them to the level.
1031

1132
[Stripper:Source]: http://www.bailopan.net/stripper/

0 commit comments

Comments
 (0)