Difference between revisions of "ISecurableInfo"
From Virtual World Web Wiki
(Documentation for the ISecurableInfo class) |
(Documentation for the ISecurableInfo class) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 8: | Line 8: | ||
:: | :: | ||
::The UTC date and time this securable was created | ::The UTC date and time this securable was created | ||
| + | |||
| + | :{{CSharp|bool Hidden {get;} }} | ||
| + | :: | ||
| + | ::True if this securable has been marked Hidden, which prevents it from being shown in the admin | ||
:{{CSharp|ResourceValue Image {get;} }} | :{{CSharp|ResourceValue Image {get;} }} | ||
| Line 16: | Line 20: | ||
:: | :: | ||
::True if this securable is in the process of being deleted | ::True if this securable is in the process of being deleted | ||
| − | |||
| − | |||
| − | |||
| − | |||
:{{CSharp|bool IsProtected {get;} }} | :{{CSharp|bool IsProtected {get;} }} | ||
Latest revision as of 12:31, 23 May 2018
An interface to a structure of information about a Securable (the base for all Worldspace and Entities)
Remarks [edit]
Properties
- DateTime Created {get;}
- The UTC date and time this securable was created
- bool Hidden {get;}
- True if this securable has been marked Hidden, which prevents it from being shown in the admin
- ResourceValue Image {get;}
- A helper which fetches the "Image" metadata value as a ResourceValue if it's defined on this securable
- bool IsDeleting {get;}
- True if this securable is in the process of being deleted
- bool IsProtected {get;}
- True if this securable has been marked Protected, which prevents it from being accidentally deleted
- ProtoValue Item {get;}
- string Name {get;}
- The name of this securable
- Guid? ParentID {get;}
- If this securable has a logical "Parent" this will be it's SecurableID. (eg, A Scene has a parent World)
- Guid SecurableID {get;}
- The unique identifier of this securable
- SecurableType SecurableType {get;}
- An enum specifying the type of this Securable
Methods
- HashSet<Guid> GetHierarchy(bool includeAreaGroups = false)
- Gets the collection of other securables in this securable's parentage hierarchy optionally including area groups
- ProtoValue GetMetadataValue(string key)
- Gets a metadata value associated with this securable
- T GetMetadataValue<T>(string key)
- Gets a metadata value of the specified type associated with this securable
- T GetMetadataValue<T>(string key, T default)
- Gets a metadata value of the specified type associated with this securable, or the supplied default if the value doesn't exist
