Component:CharacterEventTrigger: Difference between revisions

Latest revision as of 18:31, 19 October 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Component image

**CharacterEventTrigger** component as seen in the Scene Inspector

The CharacterEventTrigger component invokes Action<Float3> triggers whenever a user enters or exits an attached collider.

Usage

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 use Trigger type colliders on this hierarchy when detecting character collisions.
`TriggerEntered`	direct SyncDelegateList`1<Action`1<Float3>>	Triggered when a user enters a collider attached to the parent slot
`TriggerLeft`	direct SyncDelegateList`1<Action`1<Float3>>	Triggered when a user exits a collider attached to the parent slot
`IgnoreParentUser`	Bool	If this component is under a user in the hierarchy, events from that user are ignored.

Behavior

Examples

Related Components

@@ Line 6: / Line 6: @@
 |Name=CharacterEventTrigger
 }}
-== Intoduction ==
+The '''CharacterEventTrigger''' component invokes [[Type:Action`1|Action<Float3>]] triggers whenever a user enters or exits an attached collider.
-The '''CharacterEventTrigger''' component invokes [[:Category:Type:Action`1|Action<Float3>]] triggers whenever a user enters or exits an attached collider.
 == Usage ==
 {{Table ComponentFields
-|TriggerEntered|Action`1|TypeString0=Action<Float3>| Triggered when a user enters a collider attached to the parent slot
+|TriggersOnly|Bool| Whether to only use Trigger type colliders on this hierarchy when detecting character collisions.
-|TriggerLeft|Action`1|TypeString1=Action<Float3>| Triggered when a user exits a collider attached to the parent slot
+|TriggerEntered|{{RootFieldType|SyncDelegateList`1|[[Type:Action`1|Action`1]]&lt;[[Type:Float3|Float3]]&gt;}}|TypeAdv1=true| Triggered when a user enters a collider attached to the parent slot
+|TriggerLeft|{{RootFieldType|SyncDelegateList`1|[[Type:Action`1|Action`1]]&lt;[[Type:Float3|Float3]]&gt;}}|TypeAdv2=true| Triggered when a user exits a collider attached to the parent slot
 |IgnoreParentUser|Bool| If this component is under a user in the hierarchy, events from that user are ignored.
 }}
@@ Line 18: / Line 19: @@
 == Related Components ==
 </translate>
-[[Category:Components{{#translation:}}|CharacterEventTrigger (Component){{#translation:}}]]
+[[Category:Components{{#translation:}}|Character Event Trigger]]
-[[Category:Components:Locomotion:Interaction{{#translation:}}|CharacterEventTrigger (Component){{#translation:}}]]
+[[Category:Components:Locomotion:Interaction{{#translation:}}|Character Event Trigger]]
-[[Category:Triggers]]