IWorldspaceSystem
From Virtual World Web Wiki
Revision as of 21:05, 12 April 2017 by Spark5 (Talk | contribs) (Documentation for the IWorldspaceSystem class)
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)
- Guid CloneEditLayout(Guid editLayoutID, Guid targetSceneID, string targetName = NULL)
- Guid CloneScene(Guid sceneID, string newAlias, string newName, bool cloneLayout, bool cloneEditLayouts, bool cloneContainers, Guid? worldID = NULL)
- Clones a scene, optionally copying various other related data.
- 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 = AreaType.All)
- 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 = NULL)
- 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 = NULL)
- Deletes an area group
- void DeleteEditLayout(Guid editLayoutID)
- void DeleteScene(Guid sceneID, Action<PacketErrorStatus> onComplete = NULL)
- 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 = NULL)
- 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
- ISceneTypeInfo GetSceneTypeInfo(Guid sceneTypeID)
- Gets a structure of information about a scene type
- ISceneTypeInfo[] GetSceneTypeInfos()
- Gets a structure of information about all of the scene types registered with the system
- 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 = NULL, bool cloneLayout = true)
- 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 = NULL)
- Updates the basic properties of a scene