| Name | Type | Deprecated | Secure | Description |
|---|
| Command.Cursor | function | | | Changes the contents of the cursor. Ability cursors may be set only if the environment is not in ... |
| Event.Cursor | | | | Signals that the cursor has changed. |
| Inspect.Cursor | function | | | Returns the current contents of the 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) |
| Parameter | Type | Datatype | Description |
|---|
| hold | parameter | variant | The new cursor. Currently accepts ability, item, itemtype, or non-empty non-wildcard slot IDs. Pass nil to clear the cursor. |
Signals that the cursor has changed.
Usage:
| Event.Cursor(type, held) |
| Parameter | Type | Datatype | Description |
|---|
| held | parameter | <nope> | The blob describing the new element held. Generally, some kind of identifier used in another part of the addon system. |
| type | parameter | variant | The current cursor type. Valid values include "ability", "item", and "itemtype". |
Returns the current contents of the cursor.
Usage:
| type, held = Inspect.Cursor() |
| Parameter | Type | Datatype | Description |
|---|
| held | result | variant, nil | The blob describing what is currently held. Generally, some kind of identifier used in another part of the addon system. |
| type | result | string, nil | The current cursor type. Valid values include "ability", "item", "itemtype", and nil. |