| Name | Type | Deprecated | Secure | Description |
|---|
| Command.Storage.Clear | function | | | Remove an element from a storage segment. If accessing guild storage, you will need write access ... |
| Command.Storage.Get | function | | | Gets a specific element from a target's storage. The result will be sent to Event.Storage.Get. Th... |
| Command.Storage.List | function | | | Lists the visible elements in a target's storage. The results will be sent to Event.Storage.List.... |
| Command.Storage.Set | function | | | Sets a storage element. If accessing guild storage, you will need the Write to Guild Addon Stora... |
| Event.Storage.Get | | | | Signals receiving storage data from a target. |
| Event.Storage.List | | | | Signals receiving a list of storage elements from a target. |
| Inspect.Storage.Used | function | | | Returns the storage space currently used for a given segment. |
| Utility.Storage.Checksum | function | | | Calculates the storage checksum of a string. |
| Utility.Storage.Limits | function | | | Returns information on the storage bandwidth limits. |
| Utility.Storage.Size | function | | | Returns the size of a stored element, as used for storage quota and bandwidth control. |
Remove an element from a storage segment. If accessing guild storage, you will need write access to that element, as well as the Delete from Guild Addon Storage permission. This command is throttled by the "storage" throttle type.
Usage:
| Command.Storage.Clear(segment, identifier, callback) |
| Parameter | Type | Datatype | Description |
|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| identifier | parameter | string | The identifier of the storage bucket. Must be at least three characters long. |
| segment | parameter | string | The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted. |
Gets a specific element from a target's storage. The result will be sent to Event.Storage.Get. This command is throttled by the "storage" throttle type on both the client and server.
Usage:
| Command.Storage.Get(target, segment, identifier, callback) |
| Parameter | Type | Datatype | Description |
|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| identifier | parameter | string | The identifier of the storage bucket. Must be at least three characters long. |
| segment | parameter | string | The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted. |
| target | parameter | string | The name of the player whose storage should be accessed. Will work only on players in your guild, players in your group, or players that the addon unit system is aware of. |
Lists the visible elements in a target's storage. The results will be sent to Event.Storage.List. This command is throttled by the "storage" throttle type.
Usage:
| Command.Storage.List(target, segment, callback) |
| Parameter | Type | Datatype | Description |
|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| segment | parameter | string | The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted. |
| target | parameter | string | The name of the player whose storage should be accessed. Will work only on players in your guild, players in your group, or players that the addon unit system is aware of. |
Sets a storage element. If accessing guild storage, you will need the Write to Guild Addon Storage permission. If replacing an existing element, you will also need write access to that element as well as the Delete from Guild Addon Storage permission. You cannot create an element that you cannot read, nor can you create an element with Officer write permissions if you are not an Officer. This command is throttled by the "storage" throttle type.
Usage:
| Command.Storage.Set(segment, identifier, read, write, data, callback) |
| Parameter | Type | Datatype | Description |
|---|
| callback | parameter | callbackfunction | A standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details. |
| data | parameter | string | The data to store. This parameter is binary-safe. |
| identifier | parameter | string | The identifier of the storage bucket. Must be at least three characters long. |
| read | parameter | string | Read permissions for this element. If the segment is "player", this may be "public", "guild", or "private", where public is readable by anyone, guild is readable by your guildmembers only, and private is readable by the player only. If the segment is "guild", this may be "public", "guild", or "officer", where public is readable by anyone, guild is readable by guildmembers with the Listen permission, and officer is readable by guildmembers with the Officer Chat permission. |
| segment | parameter | string | The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted. |
| write | parameter | string | Write permissions for this element. If the segment is "player", this must be "private", as only you may modify your own storage. If the segment is "guild", this may be "guild" or "officer", where guild is changeable by guildmembers with the Delete from Guild Addon Storage permission, and officer is changeable by guildmembers with the Delete from Guild Addon Storage permission and the Officer Chat permission. The write permission must be "officer" if the read permission is "officer". |
Signals receiving storage data from a target.
Usage:
| Event.Storage.Get(target, segment, identifier, read, write, data) |
| Parameter | Type | Datatype | Description |
|---|
| data | parameter | <nope> | The data contained in the requested element. |
| identifier | parameter | <nope> | The identifier that was inspected. |
| read | parameter | <nope> | The read permissions of this element. See Command.Storage.Set() for details. |
| segment | parameter | <nope> | The segment that has been inspected, either "player" or "guild". |
| target | parameter | variant | The name of the player that has been inspected. |
| write | parameter | <nope> | The write permissions of this element. See Command.Storage.Set() for details. |
Signals receiving a list of storage elements from a target.
Usage:
| Event.Storage.List(target, segment, identifiers) |
| Parameter | Type | Datatype | Description |
|---|
| identifiers | parameter | <nope> | A list of identifiers available to you, in {identifier = checksum} format. |
| segment | parameter | <nope> | The segment that has been inspected, either "player" or "guild". |
| target | parameter | variant | The name of the player that has been inspected. |
Returns the storage space currently used for a given segment.
Usage:
| current, maximum = Inspect.Storage.Used(segment) |
| Parameter | Type | Datatype | Description |
|---|
| segment | parameter | string | The storage segment to access. "player" will access the target's per-player storage, "guild" will access the target's guild's per-guild storage. If this function has no target parameter, then the player will be targeted. |
| current | result | number | Current storage space used. |
| maximum | result | number | Maximum storage space available. |
Calculates the storage checksum of a string.
Usage:
| checksum = Utility.Storage.Checksum(data) |
| Parameter | Type | Datatype | Description |
|---|
| data | parameter | string | The data to store. This parameter is binary-safe. |
| checksum | result | string | An opaque string representing the storage checksum. |
Returns information on the storage bandwidth limits.
Usage:
| data = Utility.Storage.Limits() |
| Parameter | Type | Datatype | Description |
|---|
| data | result | table | The requested data. |
- members
-
| burst |
The amount of data that can be sent or received without being subject to throttling.
|
| sustained |
Amount of data that can be transferred per second without dropping messages.
|
Returns the size of a stored element, as used for storage quota and bandwidth control.
Usage:
| size = Utility.Storage.Size(identifier, data) |
| Parameter | Type | Datatype | Description |
|---|
| data | parameter | string | The data to store. This parameter is binary-safe. |
| identifier | parameter | string | The identifier of the storage bucket. Must be at least three characters long. |
| size | result | number | The calculated size of the storage bucket. |