trigger_teleport
From Valve Developer Community
This is a brush entity available in all Source games.
Contents |
Entity Description
A trigger volume that teleports entities that touch it.
Entities are teleported to the Remote Destination, and have their angles set to that of the Remote Destination's.
If a Local Destination Landmark is specified, teleported entities are offset from the target by their initial offset from the landmark, and their angles are left alone.
Availability
This brush-based entity is available in: all Source games. In code it is represented by class CTriggerTeleport, defined in triggers.cpp.
Keyvalues
TriggerOnce:
- Filter Name
<targetname> - Filter to use to see if activator triggers me. See filter_activator_name for details.
Origin:
- Origin
<origin> - The position of this entity's center in the world. Rotating entities typically rotate around their origin.
EnableDisable:
- Start Disabled
<bool> - Stay dormant until activated (probably with the Enable input).
Parentname:
- Parent
<targetname> - Specifies the targetname of this entity's movement parent. Entities with parents move with their parent.
Global:
- Global Entity Name
<string> - Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with global names matching entities in the previous map will have the previous map's state copied over to them.
Targetname:
- Name <string>
- The targetname other entities refer to this entity by.
- target
- <target_destination> The entity specifying the point to which entities should be teleported. Use info_teleport_destination or info_target.
- landmark
- <target_destination> If specified, then teleported entities are offset from the target by their initial offset from the landmark.
Flags
- 1 : Clients
- 2 : NPCs
- 4 : Pushables
- 8 : Physics Objects
- 16 : Only player ally NPCs
- 32 : Preserve angles even when a local landmark is not specified
Inputs
Trigger:
-
TouchTest(New with Orange Box) - Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
TriggerOnce:
-
Toggle - Toggles this trigger between enabled and disabled states.
EnableDisable:
-
Enable -
Disable - Enable/disable this entity from performing its task. It might also disappear from view.
Parentname:
-
SetParent <targetname> - Move with this entity. See Entity Hierarchy (parenting).
-
SetParentAttachment <string> - Attach to a named attachment on the current parent. The entity will teleport so that the position of its root bone matches that of the attachment.
-
SetParentAttachmentMaintainOffset <string> - As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
-
ClearParent - Removes this entity from its current movement hierarchy.
Targetname:
-
Kill - Removes this entity from the world.
-
KillHierarchy - Removes this entity and all its children from the world.
-
AddOutput <string> - Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
- Format:
<key> <value> - Format:
<output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite> -
FireUser1toFireUser4 - Fire the
OnUseroutputs; see User Inputs and Outputs.
Outputs
Trigger:
-
OnEndTouch - Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire. (activator is the exiting entity)
-
OnEndTouchAll - Fires when the last entity in the entity's area exits this trigger or when this entity is disabled. Only entities that passed this trigger's filters are considered. (activator is the last exiting entity)
-
OnTouching(New with Orange Box) -
OnNotTouching(New with Orange Box) - Fired when the
TouchTestinput is called.
TriggerOnce:
-
OnStartTouch - Fired when an entity starts touching this trigger. The touching entity must pass this trigger's filters to cause this output to fire. (activator is the toucher)
-
OnTrigger - Fired whenever the trigger is activated. (activator is the activator)
Targetname:
-
OnUser1toOnUser4 - Fired in response to the
FireUserinputs; see User Inputs and Outputs. -
OnKilled(New with Left 4 Dead) - Fired when the entity is killed and removed from the game.
