Component image File:WorldItemInterfaceComponent.pngWorld Item Interface component as seen in the Scene Inspector
The WorldItemInterface component is used with Data Feeds to show information about a particular world mapped to it. This is used in the worlds menu.
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. Some components stop their functionality when this field is disabled, but some don't. |
HasData
|
Bool | The field to set when this interface is templated by a data feed for whether it has data or not. |
ItemName
|
IField`1<String> | The field to fill with the name of the interface item when it is templated via a data feed. For settings toggles, this would be the toggle name. |
ItemKey
|
IField`1<String> | The field to fill with the interfaces key if it is a dictionary type item. |
ItemDescription
|
IField`1<String> | The field to fill with the template description when template via a data feed. |
HasDescription
|
IField`1<Bool> | Whether the item when templated via a data feed has a description. |
DescriptionCleanup
|
Slot | If this interface doesn't have a description during templating via a data feed, then delete the slot specified. |
ItemIcon
|
IField`1<Uri> | The resource URL to fill with an image link/URI if the data feed item has an icon. |
HasIcon
|
IField`1<Bool> | Whether this template has an icon. This is set during duplication as a template via a data feed. |
IconCleanup
|
Slot | The slot to delete when this interface item doesn't have an icon when being duplicated as a template item by a data feed. |
View
|
SyncRef`1<IDataFeedView> | The data feed view that this template was instantiated by. Like a SingleFeedView. |
ParentContainer
|
FeedItemInterface | This template's parent container. If that template also has a parent and a child, then it recursively goes up the containers till it finds the root interface with a parent and a child interface, then instantiates that interfaces child interface and it's Nested items instead of just this interface. |
ChildContainer
|
Slot | This template's child template which it instanciates if it's part of a parent child structure of interfaces. |
NestedItems
|
list of FeedItemInterface.NestedItem | A list of extra data feed items to instantiate the same as this one with the same arguments, except each one can be Nested under this item. |
EnabledState
|
IField`1<Bool> | The enabled state of this feed interface item UI element. |
WorldName
|
IField`1<String> | The name of the world mapped to this template. |
Description
|
IField`1<String> | The description of the world mapped to this template. |
ThumbnailUrl
|
IField`1<Uri> | The URL of the preview world texture for the world mapped to this template. |
JoinedUsers
|
IField`1<Int> | The amount of users currently in the world mapped to this template. |
ActiveUsers
|
IField`1<Int> | The amount of focused active users in the world mapped to this template. |
IsHost
|
IField`1<Bool> | Whether the local user is the host of the world mapped to this template. |
AwayKickEnabled
|
IField`1<Bool> | |
AwayKickInterval
|
IField`1<TimeSpan> |
Usage
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Examples
Used in the world browser menu with the Component:WorldsDataFeed