Component:BoxPointGenerator: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page BoxPointGenerator (Component) to Component:BoxPointGenerator: Creating component Namespace
related
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=BoxPointGeneratorComponent.png
|Image=BoxPointGeneratorComponent.png
|Name=Box Point Generator
|Name=Box Point Generator
}}
}}
A generator for points arranged in a box with a given length, width, and height.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Size|Float3|
|Size|Float3| How big the box should be for generating points.
|Shell|Bool|
|Shell|Bool| Whether points should only be spawned on the surface of the box 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 to spawn users on the outside of a cube world, with gravity on all 5 sides, at any place on the cube by making <code>Size</code> the size of the cube, and enabling <code>Shell</code>


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

Latest revision as of 17:01, 15 October 2024

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

A generator for points arranged in a box with a given length, width, and height.

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 Float3 How big the box should be for generating points.
Shell Bool Whether points should only be spawned on the surface of the box 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 to spawn users on the outside of a cube world, with gravity on all 5 sides, at any place on the cube by making Size the size of the cube, and enabling Shell

Related Components