diff --git a/docs/server/bots/bot-data-buckets.md b/docs/server/bots/bot-data-buckets.md new file mode 100644 index 00000000..61d6e704 --- /dev/null +++ b/docs/server/bots/bot-data-buckets.md @@ -0,0 +1,36 @@ +# Bot Data Buckets +* Bot data buckets allow Server Operators to limit the spells a Bot will cast based on different data bucket comparisons and the bucket name and value provided. + +## Using Bot Data Buckets +* To use a Bot Data Bucket you will need to set the `bucket_name`, `bucket_value`, and `bucket_comparison` fields in the `bot_spells_entries` table for your intended spell. + +## How the Data Buckets are Used +* Data Buckets used by the Bot use a `bucket_key-bucket_name` format. +* Meaning if your Bot ID is `7` and the bucket name is `test` your Data Bucket Key will be `bot-7`. +* If the Data Bucket's name is `test` the Bot will attempt to find a Data Bucket called `bot-7-test`. + +* The Bot will also use it's Owners Data Buckets to provide additional flexability. +* Meaning if your Character ID is `9` and the bucket name is `test` your Data Bucket Key will be `character-9`. +* If the Data Bucket's name is `test` the Bot will attempt to find a Data Bucket called `character-9-test`. + +* The Bot grabs all of their Data Buckets, along with the owner's Data Buckets when spawned and then compares values to the field values noted above. + +## Comparison Types +* Bot Data Buckets have 10 different comparison types. + +## Standard Comparison Types +* There are six standard comparison types. + - `0 (==)` checks your value and the Bot value for `equality` + - `1 (!=)` checks your value and the Bot value for `inequality` + - `2 (>=)` checks if your value is `greater than or equal to` the Bot value + - `3 (<=)` checks if your value is `lesser than or equal to` the Bot value + - `4 (>)` checks if your value is `greater than` the Bot value + - `5 (<)` checks if your value is `lesser than` the Bot value + +## Special Comparsion Types +* There are four special comparison types. +* These values are pipe `|` separated. + - `6 (Any)` checks if your value is `any` of the pipe-separated Bot values `(Example: 1|2|3)` + - `7 (Not Any)` checks if your value is `not any` of the pipe-separated Bot values `(Example: 4|5|6)` + - `8 (Between)` checks if your value is `between` two pipe-separated Bot values `(Example: 1|3)` + - `9 (Not Between)` checks if your value is `not between` two pipe-separated Bot values `(Example: 4|6)` diff --git a/mkdocs.yml b/mkdocs.yml index 609d3dcb..f78cd017 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -86,6 +86,7 @@ nav: - Bot Heal Rotations: server/bots/bot-heal-rotations.md - Bot Groups: server/bots/bot-groups.md - Bot Spell Types: server/bots/bot-spell-types.md + - Bot Data Buckets: server/bots//bot-data-buckets.md - Developer: - Project PEQ Expansions: - Classic: