Automated: create new component page |
add info |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
|Name=Character Collider Setter Tool | |Name=Character Collider Setter Tool | ||
}} | }} | ||
See [[Character Collider Setter Tool]]. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| | |_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}} | ||
|TipReference|Slot| | |TipReference|Slot| {{Template:ITool TipReference}} | ||
|BlockGripEquip|Bool| | |BlockGripEquip|Bool| {{Template:ITool BlockGripEquip}} | ||
|BlockRemoteEquip|Bool| | |BlockRemoteEquip|Bool| {{Template:ITool BlockRemoteEquip}} | ||
|EquipName|String| | |EquipName|String| {{Template:ITool EquipName}} | ||
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| | |_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}} | ||
|_gripPosesGenerated|Bool| | |_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}} | ||
|ApplyToObjectRoot|Bool| | |ApplyToObjectRoot|Bool| whether this should apply to all colliders under a found object root from the hit collider rather than just the hit collider. | ||
|MarkGrippable|Bool| | |MarkGrippable|Bool| whether to mark it as being able to be climbed. | ||
}} | |||
== Sync Delegates == | |||
{{Table ComponentTriggers | |||
|EnsureWalkRun:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Set the character controller to the walk run preset. | |||
|EnsureZeroG:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Set the character controller to the ZeroG preset. | |||
|EnsurePhysicalFly:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Set the character controller to the PhysicalFly preset. | |||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
Line 26: | Line 33: | ||
[[Category:Components:Tools{{#translation:}}|Character Collider Setter Tool]] | [[Category:Components:Tools{{#translation:}}|Character Collider Setter Tool]] | ||
[[Category:Components{{#translation:}}|Character Collider Setter Tool]] | [[Category:Components{{#translation:}}|Character Collider Setter Tool]] | ||
Latest revision as of 22:39, 18 March 2025
Component image 
Character Collider Setter Tool component as seen in the Scene Inspector

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. Some components stop their functionality when this field is disabled, but some don't. |
_equipLink
|
direct LinkTarget`1<ITool> | This is Internal, and is used by the engine to retrieve the component this field is a part of. It cannot be assigned to. |
TipReference
|
Slot | The slot to use as the tool's tip, instead of the component's slot. |
BlockGripEquip
|
Bool | Whether to prevent legacy double grip equipping from equipping this tooltip. |
BlockRemoteEquip
|
Bool | Whether to prevent equipping by clicking via laser |
EquipName
|
String | The name of the tool in the context menu when equipping via context menu. |
_overrideActiveTool
|
InteractionHandler | The interaction handler to use instead of this tool as an interaction handler. |
_gripPosesGenerated
|
Bool | Whether the Grip Pose Reference components and slots have been generated for this tool. |
ApplyToObjectRoot
|
Bool | whether this should apply to all colliders under a found object root from the hit collider rather than just the hit collider. |
MarkGrippable
|
Bool | whether to mark it as being able to be climbed. |
Sync Delegates
Method Name | Method type and Arguments. | Is the method hidden? | Description |
---|---|---|---|
EnsureWalkRun:ButtonEventHandler
|
ButtonEventHandler | ✓ | Set the character controller to the walk run preset. |
EnsureZeroG:ButtonEventHandler
|
ButtonEventHandler | ✓ | Set the character controller to the ZeroG preset. |
EnsurePhysicalFly:ButtonEventHandler
|
ButtonEventHandler | ✓ | Set the character controller to the PhysicalFly preset. |