CommonSpawnArea (Component)

From Neos Wiki
Jump to navigation Jump to search
This page contains changes which are not marked for translation.


This article or section is a Stub. You can help the Neos Wiki by expanding it.


CommonSpawnArea component as seen in the Scene Inspector

Intoduction

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

Related Components