Updated Filters (markdown)

Blixibon 2019-08-21 15:44:48 -05:00
parent 5b156599a4
commit 8ed0f48840

@ -1,12 +1,19 @@
A filter is a type of entity that normally holds a set of rules that other entities can use to determine behaviors, like a `trigger_once` using a `filter_activator_name` that only allows an entity with the name "cow" to pass it. [Click here for more information on filters in Source.](https://developer.valvesoftware.com/wiki/Category:Filters) A filter is a type of entity that normally holds a set of rules that other entities can use to determine behaviors, like a `trigger_once` using a `filter_activator_name` that only allows an entity with the name "cow" to pass it. [Click here for more information on filters in Source.](https://developer.valvesoftware.com/wiki/Category:Filters)
In Mapbase, filters now support the following new I/O/KV: In Mapbase, all filters have been given the following new I/O/KV:
**Inputs**
* **TestEntity** `<ehandle>` - Tests the filter against the specified entity and fires OnPass or OnFail based on the result. *(TestActivator only uses the activator)*
* **SetField** `<any>` - Sets this filter's primary testing criteria. (e.g. the name to test against the activator)
**KeyValues**
* **Pass caller when tested** `<boolean>` - When tested with TestActivator or TestEntity, this causes the OnPass and OnFail outputs to use the entity that called the test as the caller instead of the filter itself.
--- ---
### New filters ### New filters
In Mapbase, a large number of standard filters have been added to allow for more control and flexibility: In Mapbase, a large number of standard filters have been added so mappers could test more conditions:
| Name | Description | | Name | Description |
|:-------------:|:-------------| |:-------------:|:-------------|
@ -27,12 +34,16 @@ Some of these filters have their own icons. (TODO: Show them here?)
### Redirect filters ### Redirect filters
"Redirect" filters are a new type of filter that takes a separate entity from the activator and passes it to another filter. For example, `filter_redirect_weapon` gets the activator's weapon and could then pass it to a different filter, which then treats the weapon as the activator. "Redirect" filters are a new type of filter that takes a separate entity from the activator and passes it to another filter. For example, `filter_redirect_weapon` gets the activator's weapon and could pass it to a different filter, which then treats the weapon as the activator.
Here's a list of the standard redirect filters introduced in Mapbase: Here's a list of the standard redirect filters introduced in Mapbase:
| Name | Description | | Name | Description |
|:-------------:|:-------------| |:-------------:|:-------------|
| filter_redirect_weapon | Redirects the activator's weapon. (as a damage filter, this gets the weapon used in the damage) | | filter_redirect_weapon | Redirects the activator's weapon. *(as a damage filter, this gets the weapon used in the damage)* |
| filter_redirect_owner | Redirects the activator's owner entity. | | filter_redirect_owner | Redirects the activator's owner entity. |
| filter_redirect_inflictor | As a damage filter, redirects the inflictor of the damage. (filters normally use the attacker) | | filter_redirect_inflictor | As a damage filter, this redirects the inflictor of the damage, e.g. a grenade after an explosion. (filters normally use the attacker) |
---
### Damage manipulators