obj_teleporter

From Valve Developer Community
Jump to: navigation, search
<Team Fortress 2> obj_teleporter is a point entity available in Team Fortress 2.
A teleporter

Entity description

Used to place a teleporter in your map. A teleporter deploys players from one end into the other.

Keyvalues

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with Left 4 Dead 2)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function <string> (New with Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

Parentname:

Parent <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.

Angles:

Pitch Yaw Roll (Y Z X) <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.

TFObject:

Team <choices>
Team
  • 2 : Red
  • 3 : Blue
Starting Upgrade Level <choices>
Object spawns in the selected level.
  • 0 : Level 1
  • 1 : Level 2
  • 2 : Level 3
Note:Values higher than 2 are accepted (need to be typed in with SmartEdit off), with the limit being 90. With higher levels, the objects gain more health/damage/recharge speed.
SolidToPlayer <choices>
Object is solid or non-solid to players. !FGD
  • 1 : Solid
  • 0 : Non-solid
Teleporter Type <choices>
Sets whether this teleport is an entrance to another or an exit from another.
  • 1 : Entrance
  • 2 : Exit
Matching Teleporter <targetname>
The teleporter linked to this one. Both teleporters need to have their links defined to each other, otherwise one end will not function.

Flags

  • 2 : Invulnerable
    Bug: Invulnerable buildings can still be sapped and therefore destroyed.
  • 4 : Upgradable

Inputs

Targetname:

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 than Kill.
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>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
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> (New with 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> (New with 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: 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: 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> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin  <coordinates> (New with 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> (New with Alien Swarm) !FGD
Set this entity's angles.

Parentname:

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.

TFObject:

SetHealth  <integer>
Sets the current and maximum health. If the object is upgraded, the health will scale according to the new value.
Bug: Crashes if set to 0.
AddHealth  <integer>
Increase the current health of the object. Does not surpass maximum health. Does not destroy the building if set at 0.
RemoveHealth  <integer>
Decrease current health of the object. Destroys the object if the health hits 0.
SetSolidToPlayer  <boolean>
Sets the object to be solid or non-solid to players. 0 - non-solid, 1 - solid. !FGD
Note:The builder of the building will always be solid to the object.
SetTeam  <integer>
Ses the team the object is allied to. Does not change skin.
Skin  <integer>
Sets the skin the object uses. Useful in conjunction with SetTeam.
SetBuilder
Sets the builder of the object to the !activator.
Show
Makes the building visible and re-enables it.
Hide
Makes the building invisible and disables it.
Bug: Does not hide the obj_dispenser screen. A workaround is to fire the SetInactive (or SetActive) on the vgui_screen entity, although it will apply to all buildings.
Enable
Enable the object.
Note:Using Enable after using the Hide input will enable the building and keep it invisible.
Bug: Enable will reset the upgrade level on the object. Use the Show input instead, which properly re-enables the object.
Disable
Disable the object.

Outputs

Targetname:

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 the Left 4 Dead series)
This Output fires when the entity is killed and removed from the game.

TFObject:

OnDestroyed
Sent when object dies.
OnDamaged
Sent when hurt. !FGD
OnRepaired
Sent when repaired. !FGD
OnDisabled
Sent when disabled. !FGD
OnReenabled
Sent when enabled. !FGD
OnObjectHealthChanged  <integer>
Sends current health as a parameter whenever a change occurs. !FGD