Component:CommonSpawnArea

The CommonSpawnArea component as seen in the Scene Inspector

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

If there is no CommonSpawnArea in the World, the user will spawn at the coordinates 0, 0, 0.

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	Shoots a ray from the slot containing this component and trys to detect a floor
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	The chance this spawner will be used to spawn users. The higher the number, the more likely the chance.
PositionNode	UserNode	Positions the user based on this body node.
RotationNode	UserNode	Rotates the user based on this body node.

Usage

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.

When multiple CommonSpawnArea components are present within a world, Resonite will pick one at random, based on the BaseWeight property.

Examples

The CommonSpawnArea as seen in the Grid world template.

Related Components

• SimpleUserSpawn
• SpawnArc
• PointGenerator