Component:SimpleUserSpawn: Difference between revisions

From Resonite Wiki
Automated: update Categories
Style, Added links, this is no longer a stub. Added a danger note.
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=SimpleUserSpawnComponent.png
|Image=SimpleUserSpawnComponent.png
Line 9: Line 8:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''SimpleUserSpawn''' component is used to have a simple way of [[User|users]] spawning into a [[World|world]], with no optional parameters to fill in. In contrast, the [[Component:CommonSpawnArea|CommonSpawnArea]] component is similar to this but with those extra options.
 
{{Note|Currently in issue [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/3015 #3015], this component will not work as expected and will break your users when spawning into a world with this component in it.|danger}}


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
A SimpleUserSpawn defines a simple spawn point. New and respawning users will be placed with their avatar as a child of the world's root at <0,0,0>, facing the Z- direction. The position and rotation of this component's slot have no bearing on the user's position or rotation.
A '''SimpleUserSpawn''' defines a simple spawn point. New and respawning users will be placed with their avatar as a child of the world's [[Root|root]] at <code>0,0,0</code>, facing the Z- direction. The position and rotation of this component's slot have no bearing on the user's position or rotation.


<!--T:5-->
<!--T:5-->
Line 29: Line 29:
</translate>
</translate>
[[Category:Components{{#translation:}}|Simple User Spawn]]
[[Category:Components{{#translation:}}|Simple User Spawn]]
[[Category:ComponentStubs]]
[[Category:Components:Users{{#translation:}}|Simple User Spawn]]
[[Category:Components:Users{{#translation:}}|Simple User Spawn]]

Latest revision as of 06:04, 27 September 2024

Component image 
SimpleUserSpawn component as seen in the Scene Inspector


The SimpleUserSpawn component is used to have a simple way of users spawning into a world, with no optional parameters to fill in. In contrast, the CommonSpawnArea component is similar to this but with those extra options.

Currently in issue #3015, this component will not work as expected and will break your users when spawning into a world with this component in it.
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.

Usage

A SimpleUserSpawn defines a simple spawn point. New and respawning users will be placed with their avatar as a child of the world's root at 0,0,0, facing the Z- direction. The position and rotation of this component's slot have no bearing on the user's position or rotation.

Examples

Related Components