Component:SquarePointGenerator: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page SquarePointGenerator (Component) to Component:SquarePointGenerator: Creating component Namespace
add info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=SquarePointGeneratorComponent.png
|Image=SquarePointGeneratorComponent.png
|Name=Square Point Generator
|Name=Square Point Generator
}}
}}
A generator for points arranged in a rectangle with a given length and width.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Size|Float2|
|Size|Float2| A flat rectangle size for generating points in
|Shell|Bool|
|Shell|Bool| Whether to spawn users on only the perimeter or not.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Used in a [[Component:CommonSpawnArea|Common Spawn Area]] to define in what kind of spawn area shape users should initially spawn into.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Can be used in cases where a circle spawn area is too inaccurate to spawn users in. This can happen in cases like: Hallway spawns, elevator spawns, or any room that is square or rectangular.


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
* [[Component:CommonSpawnArea]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Square Point Generator]]
[[Category:Components{{#translation:}}|Square Point Generator]]
[[Category:Components:Transform:Point Generators{{#translation:}}|Square Point Generator]]
[[Category:Components:Transform:Point Generators{{#translation:}}|Square Point Generator]]

Latest revision as of 17:10, 15 October 2024

Component image 
Square Point Generator component as seen in the Scene Inspector

A generator for points arranged in a rectangle with a given length and width.

Fields

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.
Size Float2 A flat rectangle size for generating points in
Shell Bool Whether to spawn users on only the perimeter or not.

Usage

Used in a Common Spawn Area to define in what kind of spawn area shape users should initially spawn into.

Examples

Can be used in cases where a circle spawn area is too inaccurate to spawn users in. This can happen in cases like: Hallway spawns, elevator spawns, or any room that is square or rectangular.

Related Components