trigger_paint_cleanser
trigger_paint_cleanser
is a brush entity available in Portal 2.
It is a trigger volume that destroys gel blobs which pass through it, and removes gel from objects such as cubes. In Portal 2: Community Edition , it will additionally reset the paint gun's gel types when the player passes through it.
Note:It does not remove gel applied to brushes, or block gel from streaking past it.
Bug:In Portal 2, the entity will always remove gel from physics objects regardless of the Physics Objects flag.
- Fix: This has been fixed in P2CE, in addition to respecting the Clients flag for paint gun resetting.
Note:Gel needs to have Paint in Map set to True in
worldspawn
before applying on surfaces. Maps that do not use gel can save significant resources by avoiding gel code.Contents
Keyvalues
BaseTrigger:
- Filter Name
(filtername)
<filter> - A filter entity to test potential activators against.
- Start Disabled
(StartDisabled)
<boolean> - Stay dormant until activated (with the
Enable
input).
Flags
BaseTrigger:
- [
4
] : func_pushable
- [
8
] : Physics Objects
- [
16
] : Only player ally NPCs
- [
32
] : Only clients in vehicles
- [
64
] : Everything (not including physics debris)
- [
512
] : Only clients *not* in vehicles
- [
1024
] : Physics debris
- [
2048
] : Only NPCs in vehicles (respects player ally flag)
- [
4096
] : Disallow Bots
Inputs
BaseTrigger:
Toggle
- Toggles this trigger between enabled and disabled states.
Enable
- Enable trigger
Disable
- Disable trigger
TouchTest
(in all games since )- Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
StartTouch
(in all games since ) !FGD- Behave as if the
!caller
entity had just entered the trigger volume. Accepts non-physical entities.
EndTouch
(in all games since ) !FGD- Behave as if !caller had just exited the trigger volume.
Base:
AddContext
<string>- Adds to the entity's list of response contexts. See Context.
AddOutput
<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
|
ClearContext
- Removes all contexts from this entity's list.
ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1
toFireUser4
- Fires the respective
OnUser
outputs; see User Inputs and Outputs.
Kill
- Removes this entity and any entities parented to it from the world.
KillHierarchy
- Functions the same as
Kill
, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKill
input.
RemoveContext
<string>- Remove a context from this entity's list. The name should match the key of an existing context.
SetParent
<string>- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment
<string>- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset
<string>- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
DispatchResponse
<string> !FGD- Dispatches a response to the entity. See Response and Concept.
DispatchEffect
<string> (removed since ) !FGD- Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since .
RunScriptFile
<script> (in all games since ) (also in )- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode
<string> (in all games since ) (also in )- Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console. Bug:In Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.Fix:Remove the string argument manually with a text editor.
CallScriptFunction
<string> (in all games since ) (also in ) !FGD- Calls a VScript function defined in the scope of the receiving entity.
TerminateScriptScope
(only in ) !FGD- Destroys the script scope of the receving entity.
SetLocalOrigin
<coordinates> (in all games since ) !FGD- Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
Outputs
BaseTrigger:
OnStartTouch
- Fired when a valid entity starts touching this trigger.
!activator
is whatever touches the trigger.
OnStartTouchAll
- Fired when a valid entity starts touching this trigger, and no other entities are touching it. If there are any other entities touching the trigger when a new one begins to touch, only
OnStartTouch
will fire.
OnEndTouch
- Fired when a valid entity stops touching this trigger.
Warning:This includes entities which are deleted while inside the trigger. In this case !activator will be invalid.
OnEndTouchAll
- Fired when all valid entities stop touching this trigger.
OnTouching
(in all games since )- Fired if something is currently touching this trigger when
TouchTest
is fired.
OnNotTouching
(in all games since )- Fired if nothing is currently touching this trigger when
TouchTest
is fired.
Targetname:
OnUser1
toOnUser4
- These outputs each fire in response to the firing of the like-numbered
FireUser1
toFireUser4
Input; see User Inputs and Outputs.