Back to index...

NameTypeDeprecatedSecureDescription
Command.CursorfunctionChanges the contents of the cursor. Ability cursors may be set only if the environment is not in ...
Event.CursorSignals that the cursor has changed.
Inspect.CursorfunctionReturns the current contents of the cursor.

Command.Cursor

Changes the contents of the cursor. Ability cursors may be set only if the environment is not in secure mode.

Usage:

Command.Cursor(hold)
ParameterTypeDatatypeDescription
holdparametervariantThe new cursor. Currently accepts ability, item, itemtype, or non-empty non-wildcard slot IDs. Pass nil to clear the cursor.

Event.Cursor

Signals that the cursor has changed.

Usage:

Event.Cursor(type, held)
ParameterTypeDatatypeDescription
heldparameter<nope>The blob describing the new element held. Generally, some kind of identifier used in another part of the addon system.
typeparametervariantThe current cursor type. Valid values include "ability", "item", and "itemtype".

Inspect.Cursor

Returns the current contents of the cursor.

Usage:

type, held = Inspect.Cursor()
ParameterTypeDatatypeDescription
heldresultvariant, nilThe blob describing what is currently held. Generally, some kind of identifier used in another part of the addon system.
typeresultstring, nilThe current cursor type. Valid values include "ability", "item", "itemtype", and nil.

Back to index...