Difference between revisions of "Layer One API"
From Virtual World Web Wiki
(Documentation for the Layer One API class) |
(Documentation for the Layer One API class) |
||
| Line 1: | Line 1: | ||
| + | == Layer One API == | ||
=== IChatSystem === | === IChatSystem === | ||
:* See Also: [[IChatSystem]] | :* See Also: [[IChatSystem]] | ||
| + | : | ||
| + | :The chat system is a primary layer one interface. It provides methods for managing chat channels, and sending chat messages. | ||
| + | |||
=== IComponentSystem === | === IComponentSystem === | ||
:* See Also: [[IComponentSystem]] | :* See Also: [[IComponentSystem]] | ||
| + | : | ||
| + | :The component system is a primary layer one interface. It contains many useful utility methods for managing the component's lifetime, communicating with other components, communicating with root, and using the server transfer package system. | ||
| + | |||
=== IEntitySystem === | === IEntitySystem === | ||
:* See Also: [[IEntitySystem]] | :* See Also: [[IEntitySystem]] | ||
| + | : | ||
| + | :The entity system is a primary layer one interface. There are methods here for creating, managing and getting information about all kinds of [[Entities]] | ||
| + | |||
=== IFinancialSystem === | === IFinancialSystem === | ||
:* See Also: [[IFinancialSystem]] | :* See Also: [[IFinancialSystem]] | ||
| + | : | ||
| + | :The financial system is a primary layer one interface. It provides methods for working with currencies and transactions. | ||
| + | |||
=== IInventorySystem === | === IInventorySystem === | ||
:* See Also: [[IInventorySystem]] | :* See Also: [[IInventorySystem]] | ||
| + | : | ||
| + | :The inventory system is a primary layer one interface. It provides methods for working with runtime inventory. | ||
| + | |||
| + | :'''See also:''' [[IObjectSystem]] | ||
| + | |||
=== IObjectSystem === | === IObjectSystem === | ||
:* See Also: [[IObjectSystem]] | :* See Also: [[IObjectSystem]] | ||
| + | : | ||
| + | :The object system is a primary layer one interface. It provides methods for working with [[Object Type|Object Types]], [[Object Template|Object Templates]] and [[Container System|Containers]]. | ||
| + | |||
=== IPermissionSystem === | === IPermissionSystem === | ||
:* See Also: [[IPermissionSystem]] | :* See Also: [[IPermissionSystem]] | ||
| + | : | ||
| + | :The object system is a primary layer one interface. It provides methods for working with [[Securables and Permissions|system permssions]]. | ||
| + | |||
=== IResourceSystem === | === IResourceSystem === | ||
:* See Also: [[IResourceSystem]] | :* See Also: [[IResourceSystem]] | ||
| + | : | ||
| + | :The object system is a primary layer one interface. It provides methods for managing resources and their metadata. | ||
| + | |||
=== ISettingsSystem === | === ISettingsSystem === | ||
:* See Also: [[ISettingsSystem]] | :* See Also: [[ISettingsSystem]] | ||
| + | : | ||
| + | :The settings system is a primary layer one interface. It provides methods for getting and setting component settings as well as registering admin configurable settings and some helpful system properties. | ||
| + | |||
=== ITranslationSystem === | === ITranslationSystem === | ||
:* See Also: [[ITranslationSystem]] | :* See Also: [[ITranslationSystem]] | ||
| + | : | ||
| + | :The translation system is a primary layer one interface. It provides methods for managing translation group subscriptions and local translation groups. | ||
| + | |||
=== IUIScriptSystem === | === IUIScriptSystem === | ||
:* See Also: [[IUIScriptSystem]] | :* See Also: [[IUIScriptSystem]] | ||
| + | : | ||
| + | :The UI script system is a primary layer one interface. It provides methods for working with UI scripts, sending them to clients, finding their instances, and releasing them. | ||
| + | |||
=== IViewSystem === | === IViewSystem === | ||
:* See Also: [[IViewSystem]] | :* See Also: [[IViewSystem]] | ||
| + | : | ||
| + | :The view system is a primary layer one interface. It provides methods for working with DOM Views (server hosted DOM documents) | ||
| + | |||
=== IWorldspaceSystem === | === IWorldspaceSystem === | ||
:* See Also: [[IWorldspaceSystem]] | :* See Also: [[IWorldspaceSystem]] | ||
| + | : | ||
| + | :The worldspace system is a primary layer one interface. It provides methods for working with [[Worldspace]], Layouts and EditLayouts, and area groups | ||
| + | |||
=== LayerOne === | === LayerOne === | ||
:* See Also: [[LayerOne]] | :* See Also: [[LayerOne]] | ||
| + | : | ||
| + | :'''This is the main entry point to the server''' | ||
| + | : | ||
| + | :The LayerOne static class is initialized by the system when it starts up and provides the gateway to the layer one API. The API surface is split up into chunks to keep it logically separated. | ||
| + | |||
| + | :'''See also:''' [[Server API]] | ||
| + | |||
| + | :'''See also:''' [[IManagerFactory]] | ||
Revision as of 20:02, 15 October 2016
Contents
Layer One API
IChatSystem
- See Also: IChatSystem
- The chat system is a primary layer one interface. It provides methods for managing chat channels, and sending chat messages.
IComponentSystem
- See Also: IComponentSystem
- The component system is a primary layer one interface. It contains many useful utility methods for managing the component's lifetime, communicating with other components, communicating with root, and using the server transfer package system.
IEntitySystem
- See Also: IEntitySystem
- The entity system is a primary layer one interface. There are methods here for creating, managing and getting information about all kinds of Entities
IFinancialSystem
- See Also: IFinancialSystem
- The financial system is a primary layer one interface. It provides methods for working with currencies and transactions.
IInventorySystem
- See Also: IInventorySystem
- The inventory system is a primary layer one interface. It provides methods for working with runtime inventory.
- See also: IObjectSystem
IObjectSystem
- See Also: IObjectSystem
- The object system is a primary layer one interface. It provides methods for working with Object Types, Object Templates and Containers.
IPermissionSystem
- See Also: IPermissionSystem
- The object system is a primary layer one interface. It provides methods for working with system permssions.
IResourceSystem
- See Also: IResourceSystem
- The object system is a primary layer one interface. It provides methods for managing resources and their metadata.
ISettingsSystem
- See Also: ISettingsSystem
- The settings system is a primary layer one interface. It provides methods for getting and setting component settings as well as registering admin configurable settings and some helpful system properties.
ITranslationSystem
- See Also: ITranslationSystem
- The translation system is a primary layer one interface. It provides methods for managing translation group subscriptions and local translation groups.
IUIScriptSystem
- See Also: IUIScriptSystem
- The UI script system is a primary layer one interface. It provides methods for working with UI scripts, sending them to clients, finding their instances, and releasing them.
IViewSystem
- See Also: IViewSystem
- The view system is a primary layer one interface. It provides methods for working with DOM Views (server hosted DOM documents)
IWorldspaceSystem
- See Also: IWorldspaceSystem
- The worldspace system is a primary layer one interface. It provides methods for working with Worldspace, Layouts and EditLayouts, and area groups
LayerOne
- See Also: LayerOne
- This is the main entry point to the server
- The LayerOne static class is initialized by the system when it starts up and provides the gateway to the layer one API. The API surface is split up into chunks to keep it logically separated.
- See also: Server API
- See also: IManagerFactory
