The '''CharacterTeleporter''' sets up a Slot to teleport a character to the associated teleport exit when the Slot's Collider is hit. The Collider must be of type Trigger.
The '''CharacterTeleporter''' sets up a Slot to teleport a character to the associated teleport exit when the Slot's Collider is hit. The Collider must be of type Trigger unless <code>TriggersOnly</code> is disabled.
<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TriggersOnly|Bool|
|TriggersOnly|Bool| Whether to only allow triggers in this component's slot hiearchy to trigger the teleporter.
|Exits|{{RootFieldType|SyncList`1|[[#Exit|Exit]]}}|TypeAdv1=true| A list of slot exits to send the user to, which include rotation and individualized data.
|MinimumVelocity|Float|
|MinimumVelocity|Float| the minimum velocity the user has to be traveling to enter the teleporter.
|DirectionReference|Float3|
|DirectionReference|Float3| Which way is looking forward for this teleporter.
|MaxDirectionAngle|Float|
|MaxDirectionAngle|Float| If the user's velocity direction has an angle greater than this compared to the <code>DirectionReference</code>, then don't teleport the user.
|IgnoreParentUser|Bool|
|IgnoreParentUser|Bool| Whether to ignore the active user of this component when finding users that meet the criteria to go through the teleporter.
|TeleportEntered|{{RootFieldType|SyncDelegateList`1|[[Type:Action`1|Action`1]]<[[Type:Float3|Float3]]>}}|TypeAdv6=true| [[Sync Delegate|Sync Delegates]] that take [[Type:Float3|Float3]] that should be called when the teleporter is entered.
|TeleportExited|{{RootFieldType|SyncDelegateList`1|[[Type:Action`1|Action`1]]<[[Type:Float3|Float3]]>}}|TypeAdv7=true| [[Sync Delegate|Sync Delegates]] that take [[Type:Float3|Float3]] that should be called when the teleporter is exited anywhere.
}}
}}
== Exit ==
{{Table TypeFields
|Weight|Float| The probability of coming out of this exit.
|TeleportExit|Slot| The slot this exit will send the user to when this exit is chosen.
|ParentAfterTeleport|Bool| Whether to parent the character controller slot under <code>TeleportExit</code>
|TransformRotation|Bool| Whether to rotate the user to align this user to be pointing the same direction relative to this as they were pointing relative to the entrance.
|TransformScale|Bool| Whether to scale the character controller to <code>TeleportExit</code>'s scale relative to the entrance.
|RelativeExitPoint|Bool| Whether this exit will put the user at the same relative position to it as the user was when they went into the entrance.
|RandomExitPointGenerator|IPointGenerator| A generator for points the user should end up when exiting out of this exit. for example, teleporting users into a [[Component:CirclePointGenerator|circle area]] after they exit here. Only works if <code>RelativeExitPoint</code> is false.
|TeleportExitVelocity|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float3|Float3]]>'''|TypeAdv7=true| What velocity to set the user to when they exit out of this exit.
|TeleportExited|{{RootFieldType|SyncDelegateList`1|[[Type:Action`1|Action`1]]<[[Type:Float3|Float3]]>}}|TypeAdv8=true| [[Sync Delegate|Sync Delegates]] that take [[Type:Float3|Float3]] that should be called when the teleporter is exited here.
}}
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Place the component on a slot with a collider that has character collider field enabled. Next, specify slot(s) for the user to exit out of in the <code>Exits</code> list. Walking into the collider zone will send you and anyone else to the target [[#Exit|Exit]]
<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Can be used in conjunction with a [[Component:CameraPortal|Camera Portal]] to make a gateway/portal. It can also be used to make a Tardis interior.
* [https://www.youtube.com/watch?v=vPj43dD8CQ4 Teleport users using CharacterTeleporter] by [[User:ProbablePrime|ProbablePrime]]
* [https://www.youtube.com/watch?v=vPj43dD8CQ4 Teleport users using CharacterTeleporter] by [[User:ProbablePrime|ProbablePrime]]
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
Character Teleporter component as seen in the Scene Inspector
The CharacterTeleporter sets up a Slot to teleport a character to the associated teleport exit when the Slot's Collider is hit. The Collider must be of type Trigger unless TriggersOnly is disabled.
A generator for points the user should end up when exiting out of this exit. for example, teleporting users into a circle area after they exit here. Only works if RelativeExitPoint is false.
Sync Delegates that take Float3 that should be called when the teleporter is exited here.
Usage
Place the component on a slot with a collider that has character collider field enabled. Next, specify slot(s) for the user to exit out of in the Exits list. Walking into the collider zone will send you and anyone else to the target Exit
Examples
Can be used in conjunction with a Camera Portal to make a gateway/portal. It can also be used to make a Tardis interior.
