Automated: update Fields, Categories |
add more info |
||
Line 8: | Line 8: | ||
}} | }} | ||
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| | |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| | ||
|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| | |TeleportEntered|{{RootFieldType|SyncDelegateList`1|[[Type:Action`1|Action`1]]<[[Type:Float3|Float3]]>}}|TypeAdv6=true| [[Sync Delegate|Sync Delegates]] that take no arguments that should be called when the teleporter is entered. | ||
|TeleportExited|{{RootFieldType|SyncDelegateList`1|[[Type:Action`1|Action`1]]<[[Type:Float3|Float3]]>}}|TypeAdv7=true| | |TeleportExited|{{RootFieldType|SyncDelegateList`1|[[Type:Action`1|Action`1]]<[[Type:Float3|Float3]]>}}|TypeAdv7=true| [[Sync Delegate|Sync Delegates]] that take no arguments that should be called when the teleporter is exited. | ||
}} | }} | ||
<!--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]] |
Revision as of 16:43, 16 October 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
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.
Fields
Name | Type | Description |
---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. |
TriggersOnly
|
Bool | Whether to only allow triggers in this component's slot hiearchy to trigger the teleporter. |
Exits
|
list of Exit | A list of slot exits to send the user to, which include rotation and individualized data. |
MinimumVelocity
|
Float | the minimum velocity the user has to be traveling to enter the teleporter. |
DirectionReference
|
Float3 | Which way is looking forward for this teleporter. |
MaxDirectionAngle
|
Float | |
IgnoreParentUser
|
Bool | Whether to ignore the active user of this component when finding users that meet the criteria to go through the teleporter. |
TeleportEntered
|
direct SyncDelegateList`1<Action`1<Float3>> | Sync Delegates that take no arguments that should be called when the teleporter is entered. |
TeleportExited
|
direct SyncDelegateList`1<Action`1<Float3>> | Sync Delegates that take no arguments that should be called when the teleporter is exited. |
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.