Component:SpawnArc: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
This is no longer a stub. Added a descriptions. Added field descriptions, added usage descriptions.
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=SpawnArcComponent.png
|Image=SpawnArcComponent.png
Line 9: Line 8:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''SpawnArc''' component spawns in [[User|users]] along the arc of a circle, with an optional weight to select this spawner.


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Weight|Float|
|Weight|Float| The likelihood of this spawner being chosen for a spawning user.
|Capacity|Int|
|Capacity|Int| How many users this spawner can have spawned at a time.
|Radius|Float|
|Radius|Float| The range of how far this spawner can spawn this user.
|Arc|Float|
|Arc|Float| The shape of how the spawner will place the user.
|UsersPerArc|Int|
|UsersPerArc|Int| The segment area for the users to spawn at in this arc.
|CenterArcOffset|Float|
|CenterArcOffset|Float| The offset rotation of the center of the arc circle for this spawner.
|GrowBothSides|Bool|
|GrowBothSides|Bool| The option to extend both sides for the spawn arc, fanning out from a center point.
|RowHeightOffset|Float|
|RowHeightOffset|Float| The hieght where the users will spawn along the circle.
|OrientUser|Bool|
|OrientUser|Bool| Positions and rotates the user towards the center.
|ParentUser|Bool|
|ParentUser|Bool| Keeps the user parented onto this specific spawner slot.
|TiltUsers|Bool|
|TiltUsers|Bool| Tilts the user when spawning in.
|PositionNode|UserNode|
|PositionNode|UserNode| Takes the position of the user's body node for spawning.
|RotationNode|UserNode|
|RotationNode|UserNode| Takes the rotation of the user's body node for spawning.
|_showTest|Bool|
|_showTest|Bool| Internal: Mostly for debugging.
|_testSlots|Int|
|_testSlots|Int| Internal: Shows the number of test slots on this spawning arc.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
Used to help shape how you want [[User|users]] to spawn in a [[World|world]].


<!--T:5-->
<!--T:5-->
Line 41: Line 40:
</translate>
</translate>
[[Category:Components{{#translation:}}|Spawn Arc]]
[[Category:Components{{#translation:}}|Spawn Arc]]
[[Category:ComponentStubs]]
[[Category:Components:Users{{#translation:}}|Spawn Arc]]
[[Category:Components:Users{{#translation:}}|Spawn Arc]]

Latest revision as of 06:10, 6 October 2024

Component image 
SpawnArc component as seen in the Scene Inspector


The SpawnArc component spawns in users along the arc of a circle, with an optional weight to select this spawner.

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.
Weight Float The likelihood of this spawner being chosen for a spawning user.
Capacity Int How many users this spawner can have spawned at a time.
Radius Float The range of how far this spawner can spawn this user.
Arc Float The shape of how the spawner will place the user.
UsersPerArc Int The segment area for the users to spawn at in this arc.
CenterArcOffset Float The offset rotation of the center of the arc circle for this spawner.
GrowBothSides Bool The option to extend both sides for the spawn arc, fanning out from a center point.
RowHeightOffset Float The hieght where the users will spawn along the circle.
OrientUser Bool Positions and rotates the user towards the center.
ParentUser Bool Keeps the user parented onto this specific spawner slot.
TiltUsers Bool Tilts the user when spawning in.
PositionNode UserNode Takes the position of the user's body node for spawning.
RotationNode UserNode Takes the rotation of the user's body node for spawning.
_showTest Bool Internal: Mostly for debugging.
_testSlots Int Internal: Shows the number of test slots on this spawning arc.

Usage

Used to help shape how you want users to spawn in a world.

Examples

Related Components