Page rewrite to add more info |
Fixed spelling on 'Slot Transferring' and update reference for Transcient_Grabbing |
||
(9 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
<translate>Every object in Resonite exists as a '''Slot'''. Slots form ''hierarchies'', | <translate><!--T:6--> Every object in Resonite exists as a '''Slot'''. Slots form ''hierarchies'', are positioned in 3D space via their ''transformation'', and may contain ''[[<tvar name=1>Component</tvar>|Components]]'' to add additional behavior.</translate> | ||
== <translate>Basic Properties</translate> == | == <translate><!--T:7--> Basic Properties</translate> == | ||
=== <translate>Hierarchy</translate> === | === <translate><!--T:8--> Hierarchy</translate> === | ||
[[File:Example_Slot_Hierarchy.webp|thumb|300px|<translate>A simple slot hierarchy, as shown in the [[<tvar name=1>Scene Inspector</tvar>|Scene Inspector]]</translate>.|alt=<translate>A hierarchy of slots as shown in the Scene Inspector. The Example slot has three children, the first of which has another child itself.</translate>]] | [[File:Example_Slot_Hierarchy.webp|thumb|300px|<translate><!--T:9--> A simple slot hierarchy, as shown in the [[<tvar name=1>Scene Inspector</tvar>|Scene Inspector]]</translate>.|alt=<translate><!--T:10--> A hierarchy of slots as shown in the Scene Inspector. The Example slot has three children, the first of which has another child itself.</translate>]] | ||
<translate>A slot can contain zero or more slots, forming a '''hierarchy''' or "'''tree'''". A slot is a '''child''' if it is contained within another slot; that slot is its '''parent'''. The only slot without a parent is the '''root''' of the world, which contains all other slots. | <translate><!--T:11--> | ||
A slot can contain zero or more slots, forming a '''hierarchy''' or "'''tree'''". A slot is a '''child''' if it is contained within another slot; that slot is its '''parent'''. The only slot without a parent is the '''root''' of the world, which contains all other slots. | |||
</translate> | </translate> | ||
<translate>This hierarchy is used for organization, transformation (see below), and many other features in [[Resonite]].</translate> | <translate><!--T:12--> This hierarchy is used for organization, transformation (see below), and many other features in [[Resonite]].</translate> | ||
=== <translate>Transformation</translate> === | === <translate><!--T:13--> Transformation</translate> === | ||
<translate> | <translate><!--T:14--> Each slot has a 3D transformation consisting of translation, rotation, and scale. A child slot's transformation is specified in ''local space'', i.e. relative to its parent slot's transformation, so even though a child may use the default transforms, it may be transformed in ''world space'' due to its parents' transforms.</translate> | ||
=== <translate>Components</translate> === | === <translate><!--T:15--> Components</translate> === | ||
<translate>''Main article: [[<tvar name=1>Component</tvar>|Component]]''</translate> | <translate><!--T:16--> ''Main article: [[<tvar name=1>Component</tvar>|Component]]''</translate> | ||
<translate>Slots contain '''components''', which provide almost all the functionality in Resonite. See the main article for details.</translate> | <translate><!--T:17--> Slots contain '''components''', which provide almost all the functionality in Resonite. See the main article for details.</translate> | ||
=== Fields === | === <translate><!--T:18--> Fields</translate> === | ||
Similar to [[Component]]s, slots have a number of fields that can be modified: | [[File:Scene_Inspector_Slot_Example.webp|thumb|400px|<translate><!--T:37--> A slot's fields and available operations, as shown in the [[<tvar name=1>Scene Inspector</tvar>|Scene Inspector]]</translate>.|alt=<translate><!--T:38--> Refer to caption.</translate>]] | ||
<translate><!--T:19--> Similar to [[Component]]s, slots have a number of fields that can be modified:</translate> | |||
{{Table TypeFields | {{Table TypeFields | ||
|Name|String|The name of the component, as shown in the scene inspector. | |Name|String|<translate><!--T:20--> The name of the component, as shown in the scene inspector.</translate> | ||
|Parent|Slot|A reference to the parent slot in the hierarchy. | |Parent|Slot|<translate><!--T:21--> A reference to the parent slot in the hierarchy.</translate> | ||
|Tag|String|A string tag used for identifying slots in various systems. | |Tag|String|<translate><!--T:22--> A string tag used for identifying slots in various systems.</translate> | ||
|Active|Bool|A general-purpose field to "disable" this slot and its components. If a slot is deactivated, its children are deactivated too. Note that not all components and features respect this field. | |Active|Bool|<translate><!--T:23--> A general-purpose field to "disable" this slot and its components. If a slot is deactivated, its children are deactivated too. Note that not all components and features respect this field.</translate> | ||
|Persistent|Bool|Whether this slot will be saved, for example to the [[Inventory]]. If this is disabled, the slot and all its descendants will not be saved. | |Persistent|Bool|<translate><!--T:24--> Whether this slot will be saved, for example to the [[Inventory]]. If this is disabled, the slot and all its descendants will not be saved.</translate> | ||
|Position|Float3| | |Position|Float3|<translate><!--T:25--> This slot's position in local space.</translate> | ||
|Rotation|FloatQ| | |Rotation|FloatQ|<translate><!--T:26--> This slot's rotation in local space.</translate> | ||
|Scale|Float3| | |Scale|Float3|<translate><!--T:27--> This slot's scale in local space. Defaults to (1, 1, 1).</translate> | ||
|OrderOffset|Long|Controls the sort order of this | |OrderOffset|Long|<translate><!--T:28--> Controls the sort order of this slot relative to its siblings. Slots with a higher value are processed after siblings with a lower value. This controls the order both in the scene inspector and in many of Resonite's internal processes.</translate> | ||
}} | }} | ||
== <translate>Working With Slots</translate> == | == <translate><!--T:29--> Working With Slots</translate> == | ||
=== <translate><!--T:30--> With the Scene Inspector</translate> === | |||
<translate><!--T:31--> As a user, slots are primarily manipulated through the [[<tvar name=1>Scene Inspector</tvar>|Scene Inspector]]. You can view, create, destroy and modify slots and their components.</translate> | |||
=== <translate><!--T:32--> With ProtoFlux</translate> === | |||
<translate><!--T:33--> [[ProtoFlux]] has a set of nodes for working with the slot hierarchy, see [[:Category:ProtoFlux:Slots]] for a list.</translate> | |||
<translate> | === <translate><!--T:35--> Limitations</translate> === | ||
* <translate><!--T:36--> There is no way to access a Slot's components with ProtoFlux.<ref><tvar name=1>{{CiteResoniteIssue|57|A way to use components on Protoflux}}</tvar></ref></translate> | |||
== Other Features == | |||
=== Slot Transferring === | |||
* Slots can be moved across [[World|worlds]] via a feature called [[Transcient Grabbing]]. This is when a user is holding onto a slot when focusing to a different world. | |||
== References == | == <translate><!--T:34--> References</translate> == |
Latest revision as of 14:18, 17 August 2024
Every object in Resonite exists as a Slot. Slots form hierarchies, are positioned in 3D space via their transformation, and may contain Components to add additional behavior.
Basic Properties
Hierarchy
A slot can contain zero or more slots, forming a hierarchy or "tree". A slot is a child if it is contained within another slot; that slot is its parent. The only slot without a parent is the root of the world, which contains all other slots.
This hierarchy is used for organization, transformation (see below), and many other features in Resonite.
Transformation
Each slot has a 3D transformation consisting of translation, rotation, and scale. A child slot's transformation is specified in local space, i.e. relative to its parent slot's transformation, so even though a child may use the default transforms, it may be transformed in world space due to its parents' transforms.
Components
Main article: Component
Slots contain components, which provide almost all the functionality in Resonite. See the main article for details.
Fields
Similar to Components, slots have a number of fields that can be modified:
Name | Type | Description |
---|---|---|
Name
|
String | The name of the component, as shown in the scene inspector. |
Parent
|
Slot | A reference to the parent slot in the hierarchy. |
Tag
|
String | A string tag used for identifying slots in various systems. |
Active
|
Bool | A general-purpose field to "disable" this slot and its components. If a slot is deactivated, its children are deactivated too. Note that not all components and features respect this field. |
Persistent
|
Bool | Whether this slot will be saved, for example to the Inventory. If this is disabled, the slot and all its descendants will not be saved. |
Position
|
Float3 | This slot's position in local space. |
Rotation
|
FloatQ | This slot's rotation in local space. |
Scale
|
Float3 | This slot's scale in local space. Defaults to (1, 1, 1). |
OrderOffset
|
Long | Controls the sort order of this slot relative to its siblings. Slots with a higher value are processed after siblings with a lower value. This controls the order both in the scene inspector and in many of Resonite's internal processes. |
Working With Slots
With the Scene Inspector
As a user, slots are primarily manipulated through the Scene Inspector. You can view, create, destroy and modify slots and their components.
With ProtoFlux
ProtoFlux has a set of nodes for working with the slot hierarchy, see Category:ProtoFlux:Slots for a list.
Limitations
- There is no way to access a Slot's components with ProtoFlux.[1]
Other Features
Slot Transferring
- Slots can be moved across worlds via a feature called Transcient Grabbing. This is when a user is holding onto a slot when focusing to a different world.