This article's documentation is for anything that uses the Source engine. Click here for more information.

Trigger teleport relative: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Minor changes, and added a {{ent not in fgd}} to the top of the page.)
(is in base.fgd for all tf2branch games)
 
(15 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{ent not in fgd}}
{{CD|CTriggerTeleportRelative|file1=1}}
{{base brush|trigger_teleport_relative}}
{{This is a|brush entity|name=trigger_teleport_relative|since=Source 2013 Multiplayer|engine=Source}} {{also|{{Black Mesa}}{{Mapbase}}{{Garry's Mod}}{{strata}}}}


== Entity description ==
It's a [[trigger]] volume that will teleport [[entity|entities]] that touch it. Entities are teleported by Offset from the trigger's world-space center. Useful to get objects out of situations where levels or entities suddenly appear intersecting with them. Teleported entities have their velocity set to zero and their angles untouched.
It's a [[trigger]] volume that will teleport [[entity|entities]] that touch it. Entities are teleported by Offset from their current position. Useful to get objects out of situations where levels or entities suddenly appear intersecting with them.


==Keyvalues==
== Keyvalues ==
{{KV Targetname}}
{{KV|Offset (X Y Z)|intn=teleportoffset|vector|The offset (in World-Space Coordinates X Y Z) to teleport the entity when the trigger is touched.}}
{{KV Trigger}}
{{KV Trigger}}
{{KV Targetname}}
{{KV|Offset (X Y Z)|vector|The offset (in World-Space Coordinates X Y Z) to teleport the entity when the trigger is touched.}}


==Flags==
== Flags ==
{{Fl Trigger}}
{{Fl Trigger}}


==Inputs==
== Inputs ==
{{I Trigger}}
{{I Trigger}}


==Outputs==
== Outputs ==
{{O Trigger}}
{{O Trigger}}


==See Also==
== FGD Code ==
{{todo}}
 
== See also ==
* [[Teleporters]]
* [[Teleporters]]
* [[trigger_teleport]]
* [[trigger_teleport]]
Line 25: Line 27:


{{sensor brush}}
{{sensor brush}}
<!-- cats not added by {{this is a}} -->
[[Category:Black Mesa entities]]
[[Category:Black Mesa brush entities]]
[[Category:Garry's Mod entities]]
[[Category:Garry's Mod brush entities]]
[[Category:Mapbase entities]]
[[Category:Mapbase brush entities]]
[[Category:Counter-Strike: Source entities]]
[[Category:Counter-Strike: Source brush entities]]
[[Category:Day of Defeat: Source entities]]
[[Category:Day of Defeat: Source brush entities]]
[[Category:Half-Life Deathmatch: Source entities]]
[[Category:Half-Life Deathmatch: Source brush entities]]
[[Category:Half-Life 2: Deathmatch entities]]
[[Category:Half-Life 2: Deathmatch brush entities]]
[[Category:Team Fortress 2 entities]]
[[Category:Team Fortress 2 brush entities]]

Latest revision as of 09:33, 9 May 2025

C++ Class hierarchy
CTriggerTeleportRelative
↳CBaseTrigger
↳CBaseToggle
↳CBaseEntity
C++ triggers.cpp

trigger_teleport_relative is a brush entity available in all Source Source games since Source 2013 Multiplayer Source 2013 Multiplayer. (also in Black MesaMapbaseGarry's ModStrata Source)

It's a trigger volume that will teleport entities that touch it. Entities are teleported by Offset from the trigger's world-space center. Useful to get objects out of situations where levels or entities suddenly appear intersecting with them. Teleported entities have their velocity set to zero and their angles untouched.

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Offset (X Y Z) (teleportoffset) <vector>
The offset (in World-Space Coordinates X Y Z) to teleport the entity when the trigger is touched.
BaseTrigger
Filter Name (filtername) <filter>
A filter entity to test potential activators against.
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Flags

BaseTrigger
Everything (not including physics debris) : [64]
Clients (Survivors, Special Infected, Tanks Left 4 Dead seriesLeft 4 Dead series) : [1]
Only clients in vehicles : [32]
Only clients *not* in vehicles : [512]
Disallow Bots (removed since Left 4 Dead) : [4096]
NPCs (Common Infected, Witches Left 4 Dead seriesLeft 4 Dead series) : [2]
Only player ally NPCs : [16]
Only NPCs in vehicles (respects player ally flag) : [2048]
Physics Objects (not including physics debris) : [8]
Physics debris (include also physics debris) : [1024]
Pushables (Passes entities with classname func_pushable) : [4] Obsolete
Deprecated.
Equivalent to using Everything + filter_activator_class that filters func_pushable.

Inputs

BaseTrigger
Toggle
Toggles this trigger between enabled and disabled states.
Enable
Enable trigger
Disable
Disable trigger
TouchTest  (in all games since Source 2007)
Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
Icon-Bug.pngBug:Sleeping prop_physics will never fire "OnTouching". Also applies to entities using prop_physics as base.  (tested in: Half-Life 2)
StartTouch  (in all games since Source 2007) !FGD
Behave as if the !caller entity had just entered the trigger volume. Accepts non-physical entities.
EndTouch  (in all games since Source 2007) !FGD
Behave as if !caller had just exited the trigger volume.
DisableAndEndTouch  (only in Source 2013 MultiplayerTeam Fortress 2 branch)
Disables this trigger and calls EndTouch on all currently-touching entities.

Outputs

BaseTrigger
OnStartTouch
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger.
OnStartTouchAll
!activator = entity that caused this output
!caller = this entity
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
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity stops touching this trigger.
Note.pngNote:Will also fire for entities touching it when trigger is disabled via Disable input
Warning.pngWarning:This includes entities which are deleted while inside the trigger. In this case !activator will be invalid.
Warning.pngWarning:OnEndTouch can fire before OnStartTouch under certain circumstances[How?] where both are fired on the same tick and each have the same delay.
Note.pngFix:Add a slight delay to OnEndTouch.
OnEndTouchAll
!activator = entity that caused this output
!caller = this entity
Fired when all valid entities stop touching this trigger.
OnTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if something is currently touching this trigger when TouchTest is fired.
OnNotTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if nothing is currently touching this trigger when TouchTest is fired.

FGD Code

[Todo]

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Trigger_teleport_relative&oldid=475999"