Component:CommonSpawnArea: Difference between revisions

From Resonite Wiki
imported>Orangestar
No edit summary
 
m added images
Line 1: Line 1:
<languages></languages>
[[File:CommonSpawnAreaComponent.webp|alt=A photo of the common spawn area component and it's fields in the inspector.|thumb|The CommonSpawnArea component as seen in the [[Scene Inspector]]]]
<translate>
<!--T:1-->
{{stub}}
{{Infobox Component
|Image=CommonSpawnAreaComponent.png
|Name=CommonSpawnArea
}}


<!--T:2-->
== Introduction ==
== Intoduction ==


<!--T:3-->
The CommonSpawnArea component is user spawner that can take a range from PointGenerator.
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
Line 32: Line 24:
<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
[[File:Grid World Template Spawn.webp|alt=A glowing spawn circle next to an inspector showing it's hierarchy.|thumb|The CommonSpawnArea as seen in the Grid world template.]]


<!--T:6-->
== Related Components ==
== Related Components ==
* [[SimpleUserSpawn (Component)|SimpleUserSpawn]]
* [[SimpleUserSpawn (Component)|SimpleUserSpawn]]

Revision as of 23:28, 12 January 2024

A photo of the common spawn area component and it's fields in the inspector.
The CommonSpawnArea component as seen in the Scene Inspector

Introduction

The CommonSpawnArea component is user spawner that can take a range from PointGenerator.

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.
SpawnPointGenerator IPointGenerator A PointGenerator component. This determines which points the spawn area will use for spawning new users.
FloorPointRay Float3
OtherUserCheckRadius Float A minimum of how far away other users must be before a spawn point generated by SpawnPointGenerator is valid.
ParentUser Bool If true, newly-spawned users will be parented to the slot holding this component.
OrientUser Bool If true, newly-spawned users will be oriented towards the Z- axis that the slot holding this component is facing.
ScaleUser Bool If true, newly-spawned users will be scaled to be the same scale as the slot holding this component. This can cause issues with parenting, so take care.
Capacity Int The maximum number of users that can be spawned in the slot holding this component at any given time. A value of -1 makes the maximum unlimited.
BaseWeight Float
PositionNode UserNode
RotationNode UserNode

Behavior

Unlike other user spawner components, the CommonSpawnArea component allows you to use a PointGenerator component to define an arbitrary area in which users can spawn from. This gives you more granular control over a spawn area than SpawnArc.

Examples

A glowing spawn circle next to an inspector showing it's hierarchy.
The CommonSpawnArea as seen in the Grid world template.

Related Components

</translate>