Component:BallisticPathMesh: Difference between revisions

From Resonite Wiki
Automated: update 'HighPriorityIntegration' description
add some info
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=BallisticPathMeshComponent.png
|Image=BallisticPathMeshComponent.png
|Name=Ballistic Path Mesh
|Name=Ballistic Path Mesh
}}
}}
The ballistics path mesh is a component that generates a stripe or tube mesh that traces the future path of a virtual thrown object.


<!--T:2-->
<!--T:2-->
Line 12: Line 12:
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|OverrideBoundingBox|Bool|
|OverrideBoundingBox|Bool| {{Template:Override Bounding Box}}
|OverridenBoundingBox|BoundingBox|
|OverridenBoundingBox|BoundingBox| {{Template:Overridden Bounding Box}}
|Profile|ColorProfile|
|Profile|ColorProfile|
|InitialPosition|Float3|
|InitialPosition|Float3| The initial position of the ballistics path.
|InitialVelocity|Float3|
|InitialVelocity|Float3| The initial velocity of the ballistics path.
|Gravity|Float3|
|Gravity|Float3| The gravity affecting the ballistics path (m/s^2)
|Drag|Float|
|Drag|Float| the resistance through the air of the generated ballistics path
|Mode|'''[[#StepMode|StepMode]]'''|TypeAdv8=true|
|Mode|'''[[#StepMode|StepMode]]'''|TypeAdv8=true|  
|StepSize|Float|
|StepSize|Float|
|TotalUnits|Float|
|TotalUnits|Float|
|Shape|'''[[#PathShape|PathShape]]'''|TypeAdv11=true|
|Shape|'''[[#PathShape|PathShape]]'''|TypeAdv11=true|
|Size|Float|
|Size|Float| How big to scale this ballisitics path
|Points|Int|
|Points|Int| how many points the final ballistics curve should be made of
|DualSided|Bool|
|DualSided|Bool| whether the generated mesh should be dual sided.
|Up|Float3|
|Up|Float3| The up direction against gravity for the generated mesh (local space)
|DistanceSizeGrowth|Float|
|DistanceSizeGrowth|Float|  
|MinGrownSize|Float|
|MinGrownSize|Float|
|MaxGrownSize|Float|
|MaxGrownSize|Float|
Line 39: Line 39:
<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
This is commonly used in the teleport to locomotion for the indication visual for teleporting.


<!--T:5-->
<!--T:5-->

Revision as of 21:55, 14 October 2024

Component image 
Ballistic Path Mesh component as seen in the Scene Inspector

The ballistics path mesh is a component that generates a stripe or tube mesh that traces the future path of a virtual thrown object.

Fields

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.
HighPriorityIntegration Bool If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
OverrideBoundingBox Bool Force the bounding box calculated from this component to use OverridenBoundingBox instead of calculating when requested.
OverridenBoundingBox BoundingBox the bounding box this component should say it has when OverrideBoundingBox is enabled. Useful for bounding box calculations with Flux, or changing the selection box for this component when rendered.
Profile ColorProfile
InitialPosition Float3 The initial position of the ballistics path.
InitialVelocity Float3 The initial velocity of the ballistics path.
Gravity Float3 The gravity affecting the ballistics path (m/s^2)
Drag Float the resistance through the air of the generated ballistics path
Mode StepMode
StepSize Float
TotalUnits Float
Shape PathShape
Size Float How big to scale this ballisitics path
Points Int how many points the final ballistics curve should be made of
DualSided Bool whether the generated mesh should be dual sided.
Up Float3 The up direction against gravity for the generated mesh (local space)
DistanceSizeGrowth Float
MinGrownSize Float
MaxGrownSize Float
UseLastSegment Bool
LastSegmentPosition Float3

Usage

Examples

This is commonly used in the teleport to locomotion for the indication visual for teleporting.

Related Components