Difference between revisions of "IWorldspaceSystem"
From Virtual World Web Wiki
(Documentation for the IWorldspaceSystem class) |
(Documentation for the IWorldspaceSystem class) |
||
Line 1: | Line 1: | ||
+ | The worldspace system is a primary layer one interface. It provides methods for working with [[Worldspace]], Layouts and EditLayouts, and area groups | ||
+ | |||
===Remarks <nowiki>[</nowiki>[{{fullurl:IWorldspaceSystem Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:IWorldspaceSystem Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
{{:IWorldspaceSystem Remarks}} | {{:IWorldspaceSystem Remarks}} | ||
Line 4: | Line 6: | ||
===Properties=== | ===Properties=== | ||
:{{CSharp|IWorldInfo RootWorld {get;} }} | :{{CSharp|IWorldInfo RootWorld {get;} }} | ||
+ | :: | ||
+ | ::Gets info about the system root world. This is the only world with a null parent world ID. | ||
===Methods=== | ===Methods=== | ||
Line 13: | Line 17: | ||
:{{CSharp|void CopySceneToStorage(Guid sceneID, Guid sceneInstanceID, bool designMode)}} | :{{CSharp|void CopySceneToStorage(Guid sceneID, Guid sceneInstanceID, bool designMode)}} | ||
+ | :: | ||
+ | ::Copies a scene to instance storage given a known scene instance ID | ||
:{{CSharp|Guid CopySceneToStorage(Guid sceneID, bool designMode)}} | :{{CSharp|Guid CopySceneToStorage(Guid sceneID, bool designMode)}} | ||
+ | :: | ||
+ | ::Copies a scene to instance storage and creates a new instance storage ID for it | ||
:{{CSharp|void CopyStorageToScene(Guid sceneInstanceID)}} | :{{CSharp|void CopyStorageToScene(Guid sceneInstanceID)}} | ||
+ | :: | ||
+ | ::Save the specified stored instance to its scene | ||
:{{CSharp|Guid CreateAreaGroup(string name, AreaType allowedAreaTypes)}} | :{{CSharp|Guid CreateAreaGroup(string name, AreaType allowedAreaTypes)}} | ||
+ | :: | ||
+ | ::Creates a new area group, optionally as a child of another | ||
:{{CSharp|Guid CreateDefaultEditLayout(Guid sceneID)}} | :{{CSharp|Guid CreateDefaultEditLayout(Guid sceneID)}} | ||
Line 27: | Line 39: | ||
:{{CSharp|Guid CreateSceneType(Guid resourceItemID, string title)}} | :{{CSharp|Guid CreateSceneType(Guid resourceItemID, string title)}} | ||
+ | :: | ||
+ | ::Creates a new Scene Type given an existing resource identifier | ||
:{{CSharp|Guid CreateWorld(string alias, string title, bool isContainer, bool isPermissionRoot, Guid? parentWorldID)}} | :{{CSharp|Guid CreateWorld(string alias, string title, bool isContainer, bool isPermissionRoot, Guid? parentWorldID)}} | ||
+ | :: | ||
+ | ::Creates a new world, optionally under a parent world | ||
:{{CSharp|void DeleteAreaGroup(Guid areaGroupID, Action<PacketErrorStatus> onComplete)}} | :{{CSharp|void DeleteAreaGroup(Guid areaGroupID, Action<PacketErrorStatus> onComplete)}} | ||
+ | :: | ||
+ | ::Deletes an area group | ||
:{{CSharp|void DeleteEditLayout(Guid editLayoutID)}} | :{{CSharp|void DeleteEditLayout(Guid editLayoutID)}} | ||
:{{CSharp|void DeleteScene(Guid sceneID, Action<PacketErrorStatus> onComplete)}} | :{{CSharp|void DeleteScene(Guid sceneID, Action<PacketErrorStatus> onComplete)}} | ||
+ | :: | ||
+ | ::Begins the deletion of a scene. | ||
:{{CSharp|void DeleteSceneType(Guid sceneTypeID)}} | :{{CSharp|void DeleteSceneType(Guid sceneTypeID)}} | ||
+ | :: | ||
+ | ::Begins the deletion of a Scene Type and it's associated scenes. | ||
:{{CSharp|void DeleteWorld(Guid worldID, Action<PacketErrorStatus> onComplete)}} | :{{CSharp|void DeleteWorld(Guid worldID, Action<PacketErrorStatus> onComplete)}} | ||
+ | :: | ||
+ | ::Begins the deletion of a world and all its child objects | ||
:{{CSharp|Guid FindScene(string alias, Guid worldID)}} | :{{CSharp|Guid FindScene(string alias, Guid worldID)}} | ||
+ | :: | ||
+ | ::Finds a ID for a world given its alias and parent world | ||
:{{CSharp|Guid FindWorld(string alias, Guid parentWorldID)}} | :{{CSharp|Guid FindWorld(string alias, Guid parentWorldID)}} | ||
+ | :: | ||
+ | ::Gets the ID of a world with a given alias in a given parent world | ||
:{{CSharp|string GetAreaGroupName(Guid areaGroupID)}} | :{{CSharp|string GetAreaGroupName(Guid areaGroupID)}} | ||
+ | :: | ||
+ | ::Gets the name of an area group | ||
:{{CSharp|IEditLayoutInfo GetDefaultEditLayout(Guid sceneID)}} | :{{CSharp|IEditLayoutInfo GetDefaultEditLayout(Guid sceneID)}} | ||
Line 59: | Line 89: | ||
:{{CSharp|Guid GetPersonaRootWorld(Guid personaID)}} | :{{CSharp|Guid GetPersonaRootWorld(Guid personaID)}} | ||
+ | :: | ||
+ | ::Gets the world in which the given persona is rooted. This represents the highest level world this persona is valid in. | ||
:{{CSharp|Guid GetRootWorld(Guid areaID)}} | :{{CSharp|Guid GetRootWorld(Guid areaID)}} | ||
+ | :: | ||
+ | ::Gets the ID of the next persona container (root world) up the worldspace hierarchy | ||
:{{CSharp|string GetSceneAlias(Guid sceneID)}} | :{{CSharp|string GetSceneAlias(Guid sceneID)}} | ||
+ | :: | ||
+ | ::Gets the alias (URL safe name) of the requested scene | ||
:{{CSharp|Guid GetSceneForUri(IConnectionIdentity identity, Uri uri)}} | :{{CSharp|Guid GetSceneForUri(IConnectionIdentity identity, Uri uri)}} | ||
+ | :: | ||
+ | ::Resolves a VWW URI to a Scene ID, Relative URIs willl be resolved relative to the identity's current location or worldspace root if there is no location | ||
:{{CSharp|Guid GetSceneForUri(Uri uri)}} | :{{CSharp|Guid GetSceneForUri(Uri uri)}} | ||
+ | :: | ||
+ | ::Resolves a VWW URI to a Scene ID, Relative URIs willl be resolved relative to the worldspace root | ||
:{{CSharp|ISceneInfo GetSceneInfo(Guid sceneID)}} | :{{CSharp|ISceneInfo GetSceneInfo(Guid sceneID)}} | ||
+ | :: | ||
+ | ::Gets a structure of information about a scene and its parent worlds | ||
:{{CSharp|string GetSceneInstanceName(Guid sceneInstanceID)}} | :{{CSharp|string GetSceneInstanceName(Guid sceneInstanceID)}} | ||
+ | :: | ||
+ | ::Gets the name of a scene instance | ||
:{{CSharp|DOMDocument GetSceneLayout(Guid sceneID)}} | :{{CSharp|DOMDocument GetSceneLayout(Guid sceneID)}} | ||
:{{CSharp|string GetSceneName(Guid sceneID)}} | :{{CSharp|string GetSceneName(Guid sceneID)}} | ||
+ | :: | ||
+ | ::Gets the name of a scene | ||
:{{CSharp|Guid GetSceneType(Guid sceneID)}} | :{{CSharp|Guid GetSceneType(Guid sceneID)}} | ||
+ | :: | ||
+ | ::Gets the Scene Type of the scene | ||
:{{CSharp|string GetSceneTypeName(Guid sceneTypeID)}} | :{{CSharp|string GetSceneTypeName(Guid sceneTypeID)}} | ||
+ | :: | ||
+ | ::Gets the name of a scene type | ||
:{{CSharp|ISecurableInfo GetSecurableInfo(Guid securableID)}} | :{{CSharp|ISecurableInfo GetSecurableInfo(Guid securableID)}} | ||
+ | :: | ||
+ | ::Gets general information about a securable | ||
:{{CSharp|string GetSecurableName(Guid securableID)}} | :{{CSharp|string GetSecurableName(Guid securableID)}} | ||
+ | :: | ||
+ | ::Gets the name of a securable | ||
:{{CSharp|SecurableType GetSecurableType(Guid securableID)}} | :{{CSharp|SecurableType GetSecurableType(Guid securableID)}} | ||
+ | :: | ||
+ | ::Gets the type of a securable | ||
:{{CSharp|string GetServiceProviderName(Guid serviceProviderID)}} | :{{CSharp|string GetServiceProviderName(Guid serviceProviderID)}} | ||
+ | :: | ||
+ | ::Gets the name of a service provider | ||
:{{CSharp|Uri GetUriForScene(Guid sceneID)}} | :{{CSharp|Uri GetUriForScene(Guid sceneID)}} | ||
+ | :: | ||
+ | ::The oposite of GetSceneForURI, this methof returns the full VWW URL for a scene | ||
:{{CSharp|string GetWorldAlias(Guid worldID)}} | :{{CSharp|string GetWorldAlias(Guid worldID)}} | ||
+ | :: | ||
+ | ::Gets the alias (URL safe name) of the requested world | ||
:{{CSharp|IWorldInfo GetWorldInfo(Guid worldID)}} | :{{CSharp|IWorldInfo GetWorldInfo(Guid worldID)}} | ||
+ | :: | ||
+ | ::Gets a structure of information about a world and its parent worlds | ||
:{{CSharp|string GetWorldName(Guid worldID)}} | :{{CSharp|string GetWorldName(Guid worldID)}} | ||
+ | :: | ||
+ | ::Gets the name of a world | ||
:{{CSharp|bool IsPersonaContainer(Guid worldID)}} | :{{CSharp|bool IsPersonaContainer(Guid worldID)}} | ||
+ | :: | ||
+ | ::Determines if a world is a persona container | ||
:{{CSharp|bool IsProtected(Guid areaID)}} | :{{CSharp|bool IsProtected(Guid areaID)}} | ||
+ | :: | ||
+ | ::Tests if an area is protected | ||
:{{CSharp|void JoinAreaGroup(Guid areaGroupID, Guid areaID)}} | :{{CSharp|void JoinAreaGroup(Guid areaGroupID, Guid areaID)}} | ||
+ | :: | ||
+ | ::Adds an area to an area group | ||
:{{CSharp|void LeaveAreaGroup(Guid areaGroupID, Guid areaID)}} | :{{CSharp|void LeaveAreaGroup(Guid areaGroupID, Guid areaID)}} | ||
+ | :: | ||
+ | ::Removes an area from an area group | ||
:{{CSharp|void ProtectArea(Guid areaID)}} | :{{CSharp|void ProtectArea(Guid areaID)}} | ||
+ | :: | ||
+ | ::Marks an area as a system area so it cannot be deleted with layer 1 tools | ||
:{{CSharp|void PublishEditLayout(Guid editLayoutID)}} | :{{CSharp|void PublishEditLayout(Guid editLayoutID)}} | ||
:{{CSharp|void RemoveInstanceFromStorage(Guid instanceID)}} | :{{CSharp|void RemoveInstanceFromStorage(Guid instanceID)}} | ||
+ | :: | ||
+ | ::Removes a instance from InstanceStorages | ||
:{{CSharp|void RemoveSceneFromStorage(Guid sceneID)}} | :{{CSharp|void RemoveSceneFromStorage(Guid sceneID)}} | ||
+ | :: | ||
+ | ::Removes all instances of a scene from InstanceStorages | ||
:{{CSharp|void SaveInstance(IInstanceContext context)}} | :{{CSharp|void SaveInstance(IInstanceContext context)}} | ||
+ | :: | ||
+ | ::Saves the layout to the instance | ||
:{{CSharp|Guid SaveInstanceToNewStorage(IInstanceContext context, bool? designMode, bool cloneLayout)}} | :{{CSharp|Guid SaveInstanceToNewStorage(IInstanceContext context, bool? designMode, bool cloneLayout)}} | ||
+ | :: | ||
+ | ::Saves the instance to instance storage under a new instance ID | ||
:{{CSharp|void SaveInstanceToStorage(IInstanceContext context)}} | :{{CSharp|void SaveInstanceToStorage(IInstanceContext context)}} | ||
+ | :: | ||
+ | ::Saves the instance to instance storage | ||
:{{CSharp|void SceneLayoutChangeNotify(Guid sceneID)}} | :{{CSharp|void SceneLayoutChangeNotify(Guid sceneID)}} | ||
:{{CSharp|void SetAreaGroupName(Guid areaGroupID, string name)}} | :{{CSharp|void SetAreaGroupName(Guid areaGroupID, string name)}} | ||
+ | :: | ||
+ | ::Sets the name of an area group | ||
:{{CSharp|void SetEditLayoutName(Guid editLayoutID, string layoutName)}} | :{{CSharp|void SetEditLayoutName(Guid editLayoutID, string layoutName)}} | ||
Line 129: | Line 217: | ||
:{{CSharp|void SetSceneAlias(Guid sceneID, string alias)}} | :{{CSharp|void SetSceneAlias(Guid sceneID, string alias)}} | ||
+ | :: | ||
+ | ::Sets the alias (URL safe name) of the requested scene | ||
:{{CSharp|void SetSceneInstanceName(Guid sceneInstanceID, string name)}} | :{{CSharp|void SetSceneInstanceName(Guid sceneInstanceID, string name)}} | ||
+ | :: | ||
+ | ::Renames a scene instance. | ||
:{{CSharp|void SetSceneLayout(Guid sceneID, DOMDocument sceneLayout)}} | :{{CSharp|void SetSceneLayout(Guid sceneID, DOMDocument sceneLayout)}} | ||
Line 137: | Line 229: | ||
:{{CSharp|void SetSceneName(Guid sceneID, string name)}} | :{{CSharp|void SetSceneName(Guid sceneID, string name)}} | ||
+ | :: | ||
+ | ::Renames a scene. | ||
:{{CSharp|void SetSecurableMetadata(Guid securableID, string key, ProtoValue value)}} | :{{CSharp|void SetSecurableMetadata(Guid securableID, string key, ProtoValue value)}} | ||
+ | :: | ||
+ | ::Sets a securable metadata value. Values can be retrieved through GetSecurableInfo | ||
:{{CSharp|void SetServiceProviderName(Guid serviceProviderID, string name)}} | :{{CSharp|void SetServiceProviderName(Guid serviceProviderID, string name)}} | ||
+ | :: | ||
+ | ::Renames a service provider. | ||
:{{CSharp|void SetWorldAlias(Guid worldID, string alias)}} | :{{CSharp|void SetWorldAlias(Guid worldID, string alias)}} | ||
+ | :: | ||
+ | ::Sets the alias (URL safe name) of the requested world | ||
:{{CSharp|void SetWorldName(Guid worldID, string name)}} | :{{CSharp|void SetWorldName(Guid worldID, string name)}} | ||
+ | :: | ||
+ | ::Renames a world. | ||
:{{CSharp|void ShutdownSceneInstances(Guid sceneID)}} | :{{CSharp|void ShutdownSceneInstances(Guid sceneID)}} | ||
+ | :: | ||
+ | ::Forces a shutdown of any instances of the given scene | ||
:{{CSharp|void UnProtectArea(Guid areaID)}} | :{{CSharp|void UnProtectArea(Guid areaID)}} | ||
+ | :: | ||
+ | ::Marks an area as no longer a system area so it can again be deleted | ||
:{{CSharp|void UpdateScene(Guid sceneID, string alias, string title, Guid? worldID, Byte instanceModeID, string modeMetadata)}} | :{{CSharp|void UpdateScene(Guid sceneID, string alias, string title, Guid? worldID, Byte instanceModeID, string modeMetadata)}} | ||
+ | :: | ||
+ | ::Updates the basic properties of a scene | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Revision as of 20:02, 15 October 2016
The worldspace system is a primary layer one interface. It provides methods for working with Worldspace, Layouts and EditLayouts, and area groups
Remarks [edit]
Properties
- IWorldInfo RootWorld {get;}
- Gets info about the system root world. This is the only world with a null parent world ID.
Methods
- Guid AttachDefaultEditLayout(Guid sceneInstanceID)
- Guid AttachEditLayout(Guid sceneInstanceID, string name)
- Guid CloneEditLayout(Guid editLayoutID, string name)
- void CopySceneToStorage(Guid sceneID, Guid sceneInstanceID, bool designMode)
- Copies a scene to instance storage given a known scene instance ID
- Guid CopySceneToStorage(Guid sceneID, bool designMode)
- Copies a scene to instance storage and creates a new instance storage ID for it
- void CopyStorageToScene(Guid sceneInstanceID)
- Save the specified stored instance to its scene
- Guid CreateAreaGroup(string name, AreaType allowedAreaTypes)
- Creates a new area group, optionally as a child of another
- Guid CreateDefaultEditLayout(Guid sceneID)
- Guid CreateEditLayout(Guid sceneID, string name)
- Guid CreateScene(string alias, string title, Guid worldID, Guid sceneTypeID, InstanceModes instanceMode, string modeMetadata)
- Guid CreateSceneType(Guid resourceItemID, string title)
- Creates a new Scene Type given an existing resource identifier
- Guid CreateWorld(string alias, string title, bool isContainer, bool isPermissionRoot, Guid? parentWorldID)
- Creates a new world, optionally under a parent world
- void DeleteAreaGroup(Guid areaGroupID, Action<PacketErrorStatus> onComplete)
- Deletes an area group
- void DeleteEditLayout(Guid editLayoutID)
- void DeleteScene(Guid sceneID, Action<PacketErrorStatus> onComplete)
- Begins the deletion of a scene.
- void DeleteSceneType(Guid sceneTypeID)
- Begins the deletion of a Scene Type and it's associated scenes.
- void DeleteWorld(Guid worldID, Action<PacketErrorStatus> onComplete)
- Begins the deletion of a world and all its child objects
- Guid FindScene(string alias, Guid worldID)
- Finds a ID for a world given its alias and parent world
- Guid FindWorld(string alias, Guid parentWorldID)
- Gets the ID of a world with a given alias in a given parent world
- string GetAreaGroupName(Guid areaGroupID)
- Gets the name of an area group
- IEditLayoutInfo GetDefaultEditLayout(Guid sceneID)
- IEditLayoutInfo GetEditLayout(Guid editLayoutID)
- IEditLayoutInfo GetEditLayout(Guid sceneID, string name)
- IEditLayoutInfo GetEditLayoutForInstance(Guid sceneInstanceID)
- IEnumerable<IEditLayoutInfo> GetEditLayouts(Guid sceneID)
- DOMDocument GetInstanceStorageLayout(Guid storageInstanceID)
- Guid GetPersonaRootWorld(Guid personaID)
- Gets the world in which the given persona is rooted. This represents the highest level world this persona is valid in.
- Guid GetRootWorld(Guid areaID)
- Gets the ID of the next persona container (root world) up the worldspace hierarchy
- string GetSceneAlias(Guid sceneID)
- Gets the alias (URL safe name) of the requested scene
- Guid GetSceneForUri(IConnectionIdentity identity, Uri uri)
- Resolves a VWW URI to a Scene ID, Relative URIs willl be resolved relative to the identity's current location or worldspace root if there is no location
- Guid GetSceneForUri(Uri uri)
- Resolves a VWW URI to a Scene ID, Relative URIs willl be resolved relative to the worldspace root
- ISceneInfo GetSceneInfo(Guid sceneID)
- Gets a structure of information about a scene and its parent worlds
- string GetSceneInstanceName(Guid sceneInstanceID)
- Gets the name of a scene instance
- DOMDocument GetSceneLayout(Guid sceneID)
- string GetSceneName(Guid sceneID)
- Gets the name of a scene
- Guid GetSceneType(Guid sceneID)
- Gets the Scene Type of the scene
- string GetSceneTypeName(Guid sceneTypeID)
- Gets the name of a scene type
- ISecurableInfo GetSecurableInfo(Guid securableID)
- Gets general information about a securable
- string GetSecurableName(Guid securableID)
- Gets the name of a securable
- SecurableType GetSecurableType(Guid securableID)
- Gets the type of a securable
- string GetServiceProviderName(Guid serviceProviderID)
- Gets the name of a service provider
- Uri GetUriForScene(Guid sceneID)
- The oposite of GetSceneForURI, this methof returns the full VWW URL for a scene
- string GetWorldAlias(Guid worldID)
- Gets the alias (URL safe name) of the requested world
- IWorldInfo GetWorldInfo(Guid worldID)
- Gets a structure of information about a world and its parent worlds
- string GetWorldName(Guid worldID)
- Gets the name of a world
- bool IsPersonaContainer(Guid worldID)
- Determines if a world is a persona container
- bool IsProtected(Guid areaID)
- Tests if an area is protected
- void JoinAreaGroup(Guid areaGroupID, Guid areaID)
- Adds an area to an area group
- void LeaveAreaGroup(Guid areaGroupID, Guid areaID)
- Removes an area from an area group
- void ProtectArea(Guid areaID)
- Marks an area as a system area so it cannot be deleted with layer 1 tools
- void PublishEditLayout(Guid editLayoutID)
- void RemoveInstanceFromStorage(Guid instanceID)
- Removes a instance from InstanceStorages
- void RemoveSceneFromStorage(Guid sceneID)
- Removes all instances of a scene from InstanceStorages
- void SaveInstance(IInstanceContext context)
- Saves the layout to the instance
- Guid SaveInstanceToNewStorage(IInstanceContext context, bool? designMode, bool cloneLayout)
- Saves the instance to instance storage under a new instance ID
- void SaveInstanceToStorage(IInstanceContext context)
- Saves the instance to instance storage
- void SceneLayoutChangeNotify(Guid sceneID)
- void SetAreaGroupName(Guid areaGroupID, string name)
- Sets the name of an area group
- void SetEditLayoutName(Guid editLayoutID, string layoutName)
- void SetInstanceStorageLayout(Guid storageInstanceID, DOMDocument sceneLayout)
- void SetInstanceStorageLayout(Guid storageInstanceID, Byte[] sceneLayout)
- void SetSceneAlias(Guid sceneID, string alias)
- Sets the alias (URL safe name) of the requested scene
- void SetSceneInstanceName(Guid sceneInstanceID, string name)
- Renames a scene instance.
- void SetSceneLayout(Guid sceneID, DOMDocument sceneLayout)
- void SetSceneLayout(Guid sceneID, Byte[] sceneLayout)
- void SetSceneName(Guid sceneID, string name)
- Renames a scene.
- void SetSecurableMetadata(Guid securableID, string key, ProtoValue value)
- Sets a securable metadata value. Values can be retrieved through GetSecurableInfo
- void SetServiceProviderName(Guid serviceProviderID, string name)
- Renames a service provider.
- void SetWorldAlias(Guid worldID, string alias)
- Sets the alias (URL safe name) of the requested world
- void SetWorldName(Guid worldID, string name)
- Renames a world.
- void ShutdownSceneInstances(Guid sceneID)
- Forces a shutdown of any instances of the given scene
- void UnProtectArea(Guid areaID)
- Marks an area as no longer a system area so it can again be deleted
- void UpdateScene(Guid sceneID, string alias, string title, Guid? worldID, Byte instanceModeID, string modeMetadata)
- Updates the basic properties of a scene