Skip to content

API > CloudVariableBank

CloudVariableBank⚓︎

Stores cloud variables. The variable banks are assigned to hold cloud variables belonging to specific subjects such as User, World and Server.

Members⚓︎

Properties⚓︎

Name Description
CloudVariableBank.[key]Property Gets or sets the cloud variable by Key.
CloudVariableBank.ReadOnlyPropertyReadonly Property Specifies if this variable bank is designated as read-only. Writing variables (Creating, Updating, deleting) of read-only variable banks is not allowed.

Methods⚓︎

Name Description
CloudVariableBank.GetVariable(key) Method Returns value assigned to a key. It throws an error if the key does not exist.
CloudVariableBank.KeyExists(key) Method Check if a key exists.
CloudVariableBank.MarkKeyForDeletion(key) Method Marks the key to be deleted from the server. Same result can be accomplished by setting the value of the key to nil.
CloudVariableBank.SetVariable(key, value) Method Creates a cloud variable with specified key and value. If the key already exists, it updates its value.

Extra Detail⚓︎

A variable bank might have been designated as read-only based on current user’s access permissions. Only reading the variables is allowed in a read-only variable bank.