Difference between revisions of "Trigger portal"

From Valve Developer Community
Jump to: navigation, search
(It needs an orientation to work properly.)
Line 5: Line 5:
  
 
==FGD Code==
 
==FGD Code==
  @SolidClass base(Trigger) = trigger_portal :
+
  @SolidClass base(Trigger, Angles) = trigger_portal :
 
  "A trigger volume which teleports touched entities and reorients their physics."
 
  "A trigger volume which teleports touched entities and reorients their physics."
 
  [
 
  [
Line 21: Line 21:
 
{{KV|Remote Portal|targetname|The trigger_portal linked to this entity. Entities that touch this entity will be teleported to the Remote Portal.}}
 
{{KV|Remote Portal|targetname|The trigger_portal linked to this entity. Entities that touch this entity will be teleported to the Remote Portal.}}
 
{{KV Trigger}}
 
{{KV Trigger}}
 +
{{KV Angles}}
  
 
==Flags==
 
==Flags==

Revision as of 08:24, 10 July 2020

trigger_portal is an brush entity in the Source base code. It moves touched entity to a target location, changing the model's orientation to match the exit target. It differs from trigger_teleport in that it "reorients physics" and (probably) preserves velocity.

Note.png Note: This entity is unavailable in any Source game. However, it can be made available in Sourcemods using custom binaries by editing server_base.vpc to include trigger_portal.cpp before building the project, or by adding the file within Visual Studio after building the project.
Bug.png Bug: The code for this entity will not compile on its own. See below for how to fix it.

FGD Code

@SolidClass base(Trigger, Angles) = trigger_portal :
	"A trigger volume which teleports touched entities and reorients their physics."
[
	RemotePortal(target_destination) : "Remote Portal" : : "The trigger_portal linked to this entity. Entities that touch this entity will be teleported to the Remote Portal."

	//Inputs
	input SetRemotePortal(string) : "Set the remote portal to the specified trigger_portal."
]

Code Fix

Line 278 and 302:

SetContextThink( &CTriggerPortal::DisabledThink, gpGlobals->curtime + 0.1, TRIGGER_DISABLED_THINK );

Keyvalues

Remote Portal <targetname>
The trigger_portal linked to this entity. Entities that touch this entity will be teleported to the Remote Portal.

TriggerOnce:

Filter Name <filter>
A filter entity to test potential activators against.

Brush:

Minimum Bounding Box Size (mins) <vector> !FGD
Starting at the brush's origin, mark the maximum bounding box's corner as this far away. Requiresmaxsif used so the other side of the box isn't empty.
Maximum Bounding Box Size (maxs) <vector> !FGD
Starting at the brush's origin, mark the minimum bounding box's corner as this far away. Requiresminsif used so the other side of the box isn't empty.
Note.png Note: To translate a brush's size in Hammer to these keys, first divide the size value shown in Hammer by 2. Then, apply the result to themaxskey, and invert the number (Multiply / Divide by -1) and apply it for theminskey.
Note.png Note: If collisions is already set, it must be set back to Bounding Box (solid 2).
Collisions (solid) <choices>
Method of collision for this entity.
Model Index (modelindex) <short> !FGD
Given the number index from dumping thecl_precacheinfo modelprecachetable, sets entity model to of the index.
Warning.png Warning: If an entity has animations that will be played, then the set model also must have its own sequences, else the game crashes.

Base:

Name (targetname) <string>
The name that other entities refer to this entity by.
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma. Every entity can be parented, even point entities. Entities which are parented will be forced to transition to the next map, such as from a trigger_transition. Some entities which aren't intended to be parented may not function correctly. phys_constraint can be used as a workaround to parenting.
Global Entity Name (globalname) <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 globalnames matching entities in the previous map will have the previous map's state copied over their state.
Origin (X Y Z) (origin) <coordinates>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.
Note.png Note: While this can override positions of where some entities spawn at, Hammer does not move the entities accordingly.
Pitch Yaw Roll (X Y Z) (angles) <angle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
Note.png Note: This works on brush entities, although Hammer doesn't show the new angles.
Response Contexts (ResponseContext) <string>
Pre-defined response system contexts; Format is key:value,key:value,...and so on. Can also be filtered for or against.
Classname (classname) <string> !FGD
The classname defines the type of entity. Classnames can be changed usingAddOutputinput, which may influence how the engine deals with the entity in certain circumstances.
Flags (spawnflags) <integer> !FGD
Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.
Effects (effects) <integer> !FGD
Combination of effect flags to use.
Hammer ID (hammerid) <integer> !FGD
The entity's Hammer ID, which is auto-generated on map compiles. Mainly used by plugins and debugging commands, such as theent_keyvaluecommand. Run-time spawned entities aren't assigned a Hammer ID.


EnableDisable:

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Angles:

Pitch Yaw Roll (Y Z X) (angles) <angle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Flags

TriggerOnce:

  •  [1] : Clients
  •  [2] : NPCs
  •  [4] : Pushables
  •  [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
  •  [4096] : Correctly account for object mass (trigger_push used to assume 100Kg) and multiple component physics objects (car, blob...) (in all games since <Alien Swarm>)
Note.png Note: In <Garry's Mod>, flag 4096 is "Correctly account for object mass" for trigger_push only.[confirm]

Inputs

SetRemotePortal <string>
Set the remote portal to the specified trigger_portal.

Trigger:

TouchTest  (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>)
Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
StartTouch  (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>) !FGD
Behave as if the !caller entity had just entered the trigger volume. Accepts non-physical entities.
EndTouch  (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>) !FGD
Behave as if the !caller entity had just exited the trigger volume.
DisableAndEndTouch  (only in <Team Fortress 2>)
Disables this trigger and calls EndTouch on all currently-touching entities.

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.

Base:

AddOutput <string>
Evaluates a keyvalue/output on this entity.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
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 thanKillinput.
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.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
AddContext <string>
Adds to the entity's list of response contexts. Format is <key>:<value>.
RemoveContext <string>
Remove a context from this entity's list. The name should match the key of an existing context.
ClearContext <string>
Removes all contexts from this entity's list.
DispatchEffect <string> (removed since Left 4 Dead) !FGD
Dispatches a special effect from the entity's origin. Removed and replaced entirely by the particle system since Left 4 Dead.
DispatchResponse <string> !FGD
Dispatches a response to the entity. See Response and Concept.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile <script> (in all games since Left 4 Dead 2)
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 Left 4 Dead 2)
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.png Bug:  In Left 4 Dead 2, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning.png Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !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.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.


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)
Warning.png Warning: This includes entities which are deleted while inside the trigger. In this case activator will be invalid.
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  (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>)
OnNotTouching  (in all games since <Half-Life 2: Episode Two><Half-Life 2: Episode Two>)
Fired when the TouchTest input 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)

Base:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (only in Left 4 Dead Left 4 Dead 2)
This output fires when the entity is killed and removed from the game.