I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

Difference between revisions of "Legacy:Teleporter"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m (+Layout)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
{{classbox|[[Legacy:UT2003|UT2003]] :: [[Legacy:Actor|Actor]] >> [[Legacy:NavigationPoint|NavigationPoint]] >> [[Legacy:SmallNavigationPoint|SmallNavigationPoint]] >> Teleporter (Package: Engine)}}
 +
 
{{classbox|[[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:NavigationPoint (UT)|NavigationPoint (UT)]] >> Teleporter (Package: Engine)}}
 
{{classbox|[[Legacy:UT|UT]] :: [[Legacy:Actor (UT)|Actor (UT)]] >> [[Legacy:NavigationPoint (UT)|NavigationPoint (UT)]] >> Teleporter (Package: Engine)}}
  
A Teleporter is a method by which an actor (usually a [[Legacy:Pawn (UT)|Pawn (UT)]]) can be sent from one location to another.  Teleporters are typically used to connect two disjunctive locations on a level, but this comes nowhere near the extent of what they are capable of being used for. Teleporters can also be used to send players to other levels, or even to send them to static Unreal servers found somewhere on the internet. For a simple tutorial on using them, read [[Legacy:Teleportation Basics|Teleportation Basics]].
+
A Teleporter is a method by which an actor (usually a [[Legacy:Pawn (UT)|Pawn (UT)]]/[[Legacy:Pawn|Pawn]]) can be sent from one location to another.  Teleporters are typically used to connect two disjunctive locations on a level, but this comes nowhere near the extent of what they are capable of being used for. Teleporters can also be used to send players to other levels, or even to send them to static Unreal servers found somewhere on the internet. For a simple tutorial on using them, read [[Legacy:Teleportation Basics|Teleportation Basics]] or [[udn2:LevelTransitions]].
  
Here is a list of the configurable properties of a Teleporter.  Due to the significance of the URL property, it will be listed first.
+
==Properties==
  
==URLs ==
+
===Teleporter Group===
 +
;URL: The URL property determines where the actor will be teleported to. This can take several forms:
 +
:;(blank): Acts only as a teleporter destination.
 +
:;TeleporterName: Teleports to the teleporter whose Tag is set to ''TeleporterName''
 +
:;LevelName#TeleporterName: Teleports to a different level on this server. ''LevelName'' is the name of the level to teleport to. (Without the extension. .UNR for UT, .UT2 for UT200*)
 +
:; <nowiki>Unreal://server.domain.com:port/LevelName#TeleporterName</nowiki> : Teleports to a different server on the net. ''server.domain.com'' is the domain name or IP address of the server to connect to and ''port'' the port the server is running on (if different from the default).
  
The URL property determines where the actor will be teleported to. This can take several forms:
+
; bChangesVelocity, TargetVelocity : If <tt>bChangesVelocity</tt> is set to <tt>False</tt>, then the [[Legacy:Actor|Actor]] that enters the Teleporter will exit the destination Teleporter with the same velocity as it originally had.  If <tt>True</tt>, then the [[Legacy:Actor|Actor]]'s velocity will be changed to match the <tt>TargetVelocity</tt> vector when it is successfully teleported. (Note: these variables are applied to the destination Teleporter, not the starting Teleporter.)
  
  <blank>
+
; bChangesYaw : If set to <tt>True</tt>, this Teleporter will alter the direction an incoming [[Legacy:Actor|Actor]] faces. The change in yaw is relative to the incoming [[Legacy:Actor|Actor]]'s yaw prior to teleportation. The amount of change is determined by the ''Movement -> Rotation.Yaw'' of this Teleporter. Because the end result Yaw is not absolute, this is only slightly useful to keep a player from facing a wall after he is teleported. The custom [[Legacy:YawTeleporter|YawTeleporter]] class fixes this behaviour.
  TeleporterTag
+
;:'''<nowiki>Note:</nowiki>''' For this to work in network games, set ''Advanced -> bNoDelete'' to True.
  Mapname#TeleporterTag?peer
+
  unreal://server.site.name.com:portnum/levelname#teleportername
+
  
===Destination ===
+
; bReversesX, bReversesY, bReversesZ : If any of these is set to <tt>True</tt>, then that particular component of the teleported [[Legacy:Actor|Actor]]'s velocity will be reversed. (Note: these variables are applied to the destination Teleporter.)
  
If the URL property is left blank, then the Teleporter is set up to work only as a destination for other Teleporters. Set its ''Events -> Tag'' property for other teleporters to point to.
+
; bEnabled : This determines if the Teleporter is currently turned on.  [[Legacy:Trigger|Trigger]]ing the Teleporter will toggle it on and off. Turning a Teleporter on when it has actors inside it will cause the Teleporter to try to teleport those [[Legacy:Actor|Actor]]s.
  
===Same map ===
+
===Events Group===
 +
; Tag : The name of this Teleporter, for other teleporter's to use in their URL properties.
  
To make a Teleporter connect to another Teleporter on the same level, simply enter the Tag of the destination Teleporter into the URL property.
+
==Triggering==
  
===Local map ===
+
Teleporter toggles the <tt>bEnabled</tt> property when triggered. See [[Legacy:Trigger Systems|Trigger Systems]] for ways to use this.
  
To make a Teleporter connect to some Teleporter on another level, use the form ''Mapname#TeleporterTag?peer'', where:
+
==Known Subclasses==
* ''Mapname'' is the name of another map to load,
+
Teleporter
* ''TeleporterTag'' is the tag of a destination Teleporter in this map,
+
  +- UnrealShare.[[Legacy:FavoritesTeleporter|FavoritesTeleporter]] (UT only) &ndash; This class is broken, it acts the same as a normal Teleporter.
* ''peer'' is a keyword telling the engine to load another map.  
+
  +- Botpack.[[Legacy:VisibleTeleporter|VisibleTeleporter]] (UT only) &ndash; A regular Teleporter with a visual effect.
 +
  +- [[Legacy:DelayedTeleporter|DelayedTeleporter]] (Custom) &ndash; Deactivates for a short time after usage to prevent telefragging.
 +
  +- [[Legacy:YawTeleporter|YawTeleporter]] (Custom) &ndash; Sets the player's yaw to a fixed value when leaving the Teleporter.
  
Note that the ''Mapname'' parameter must not contain the .unr extension at the end.  Also, the current map and the map that is being referenced must be in the same folder, preferably the Maps folder or some other folder accessible to the engine.
+
==Related Topics==
 
+
===Net ===
+
 
+
To make a Teleporter connect to a server on the internet, use the form ''<nowiki>unreal://server.site.name.com:portnum/levelname#teleportername</nowiki>''.  A few of these parameters are optional.
+
* ''unreal://'' is the identifier that Unreal's servers use to be recognized by web browsers.  This allows you to enter URLs into web pages, so that either Unreal or UT can connect directly to that server from a hyperlink beginning with this identifier.  When entering a URL into a Teleporter's properties, this parameter is optional.
+
* ''server.site.name.com'' is the web address of the server that Unreal or UT will try to connect to.  It can be an actual text URL, but this is usually just a set of IP values.
+
* ''portnum'' is the port number that should be used to connect to the server.  For example, multiple Unreal engine games on the same computer can be used to run two or more servers at once, so they must use different port numbers so that a player trying to connect to one server doesn't end up on the other (since any two such games are running servers from the same computer, then the two servers will have the same IP address, but different port numbers).  In many cases, this parameter is unneccessary, but there are a few instances where it must be specified.
+
* ''levelname'' specifies a specific level to connect to.  By default, this is left blank, so that the player will automatically enter the level that the server is running.  For ''teleportername'', the same is true.  When this parameter is left blank, the player will simply spawn at a random PlayerStart in the level.
+
 
+
==Properties ==
+
; bChangesVelocity, TargetVelocity : If bChangesVelocity is set to False, then the Actor that enters the Teleporter will exit the destination teleporter with the same velocity as it originally had.  If True, then the Actor's velocity will be changed to match the TargetVelocity vector when it is successfully teleported.  (Note:  these variables are applied to the destination teleporter, not the starting teleporter.)
+
 
+
; bChangesYaw : If set to True, this teleporter will alter the direction an incoming [[Legacy:Actor|actor]] faces. The change in yaw is relative to the incoming actor's yaw prior to teleportation. The amount of change is determined by the ''Movement -> Rotation.Yaw'' of this teleporter. Because the end result Yaw is not absolute, this is only slightly useful to keep a player from facing a wall after he is teleported. The custom [[Legacy:YawTeleporter|YawTeleporter]] class fixes this behaviour.
+
;* For this to work in network games, set ''Advanced -> bNoDelete'' to True.
+
 
+
; bReversesX, bReversesY, bReversesZ : If any of these is set to True, then that particular component of the teleported Actor's velocity will be reversed.  (Note:  these variables are applied to the destination teleporter.)
+
 
+
; bEnabled : This determines if the Teleporter is currently turned on.  [[Legacy:Trigger|Trigger]]ing the Teleporter will toggle it on and off.  Turning a Teleporter on when it has actors inside it will cause the Teleporter to try to teleport those actors.
+
 
+
==Triggering ==
+
 
+
Teleporter toggles the bEnabled property when triggered. See [[Legacy:Trigger Systems|Trigger Systems]] for ways to use this.
+
 
+
==Known Subclasses ==
+
* FavoritesTeleporter &ndash; Broken, don't use
+
 
+
* [[Legacy:DelayedTeleporter|DelayedTeleporter]] (custom) &ndash; Deactivates for a short time after usage to prevent telefragging.
+
* [[Legacy:VisibleTeleporter|VisibleTeleporter]]
+
* [[Legacy:YawTeleporter|YawTeleporter]] (custom) &ndash; Sets the player's yaw to a fixed value when leaving the teleporter
+
 
+
==Related Topics ==
+
 
* [[Legacy:Teleportation Basics|Teleportation Basics]]
 
* [[Legacy:Teleportation Basics|Teleportation Basics]]
 +
* [[udn2:LevelTransitions]]
 +
* Other types of Teleporter:
 +
** [[Legacy:TeleporterZone|TeleporterZone]] (UT only)
 +
** [[Legacy:WarpZoneInfo|WarpZoneInfo]]
 +
** [[Legacy:TransbeaconTeleporter|TransbeaconTeleporter]] (UT2003/UT2004 only)
  
Other things that can teleport:
+
==Discuss==
* [[Legacy:WarpZoneInfo|WarpZoneInfo]]
+
* [[Legacy:TeleporterZone|TeleporterZone]]
+
* [[Legacy:TransbeaconTeleporter|TransbeaconTeleporter]]
+
 
+
----
+
  
 
'''Wormbo:''' This page seems to cover only the UT Teleporter class. Should it be renamed to "Teleporter (UT)" or should it be updated with UT2k3 info. (If the differences aren't too big.)
 
'''Wormbo:''' This page seems to cover only the UT Teleporter class. Should it be renamed to "Teleporter (UT)" or should it be updated with UT2k3 info. (If the differences aren't too big.)
  
 
'''Psyk:''' It doesn't look like anything has changed in 2kx. All this info is relevant in any case.
 
'''Psyk:''' It doesn't look like anything has changed in 2kx. All this info is relevant in any case.
 +
 +
'''Fyfe:''' There's only been some minor changes (for bots and vehicles) between UT and UT200*, and there's no subclasses in UT200*.
 +
 +
'''Fyfe:''' Updated for UT200*, is it OK to remove these comments now?
  
 
[[Category:Legacy Class (UT)|{{PAGENAME}}]]
 
[[Category:Legacy Class (UT)|{{PAGENAME}}]]
 +
[[Category:Legacy Class (UT2003)|{{PAGENAME}}]]
 +
[[Category:Legacy Class (UT2004)|{{PAGENAME}}]]
 +
[[Category:Legacy Class Tree|{{PAGENAME}}]]

Latest revision as of 19:05, 27 April 2015

UT2003 :: Actor >> NavigationPoint >> SmallNavigationPoint >> Teleporter (Package: Engine)
UT :: Actor (UT) >> NavigationPoint (UT) >> Teleporter (Package: Engine)

A Teleporter is a method by which an actor (usually a Pawn (UT)/Pawn) can be sent from one location to another. Teleporters are typically used to connect two disjunctive locations on a level, but this comes nowhere near the extent of what they are capable of being used for. Teleporters can also be used to send players to other levels, or even to send them to static Unreal servers found somewhere on the internet. For a simple tutorial on using them, read Teleportation Basics or udn2:LevelTransitions.

Properties[edit]

Teleporter Group[edit]

URL
The URL property determines where the actor will be teleported to. This can take several forms:
(blank)
Acts only as a teleporter destination.
TeleporterName
Teleports to the teleporter whose Tag is set to TeleporterName
LevelName#TeleporterName
Teleports to a different level on this server. LevelName is the name of the level to teleport to. (Without the extension. .UNR for UT, .UT2 for UT200*)
Unreal://server.domain.com:port/LevelName#TeleporterName 
Teleports to a different server on the net. server.domain.com is the domain name or IP address of the server to connect to and port the port the server is running on (if different from the default).
bChangesVelocity, TargetVelocity 
If bChangesVelocity is set to False, then the Actor that enters the Teleporter will exit the destination Teleporter with the same velocity as it originally had. If True, then the Actor's velocity will be changed to match the TargetVelocity vector when it is successfully teleported. (Note: these variables are applied to the destination Teleporter, not the starting Teleporter.)
bChangesYaw 
If set to True, this Teleporter will alter the direction an incoming Actor faces. The change in yaw is relative to the incoming Actor's yaw prior to teleportation. The amount of change is determined by the Movement -> Rotation.Yaw of this Teleporter. Because the end result Yaw is not absolute, this is only slightly useful to keep a player from facing a wall after he is teleported. The custom YawTeleporter class fixes this behaviour.
Note: For this to work in network games, set Advanced -> bNoDelete to True.
bReversesX, bReversesY, bReversesZ 
If any of these is set to True, then that particular component of the teleported Actor's velocity will be reversed. (Note: these variables are applied to the destination Teleporter.)
bEnabled 
This determines if the Teleporter is currently turned on. Triggering the Teleporter will toggle it on and off. Turning a Teleporter on when it has actors inside it will cause the Teleporter to try to teleport those Actors.

Events Group[edit]

Tag 
The name of this Teleporter, for other teleporter's to use in their URL properties.

Triggering[edit]

Teleporter toggles the bEnabled property when triggered. See Trigger Systems for ways to use this.

Known Subclasses[edit]

Teleporter
 +- UnrealShare.FavoritesTeleporter (UT only) – This class is broken, it acts the same as a normal Teleporter.
 +- Botpack.VisibleTeleporter (UT only) – A regular Teleporter with a visual effect.
 +- DelayedTeleporter (Custom) – Deactivates for a short time after usage to prevent telefragging.
 +- YawTeleporter (Custom) – Sets the player's yaw to a fixed value when leaving the Teleporter.

Related Topics[edit]

Discuss[edit]

Wormbo: This page seems to cover only the UT Teleporter class. Should it be renamed to "Teleporter (UT)" or should it be updated with UT2k3 info. (If the differences aren't too big.)

Psyk: It doesn't look like anything has changed in 2kx. All this info is relevant in any case.

Fyfe: There's only been some minor changes (for bots and vehicles) between UT and UT200*, and there's no subclasses in UT200*.

Fyfe: Updated for UT200*, is it OK to remove these comments now?