> For the complete documentation index, see [llms.txt](https://kb.heathen.group/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.heathen.group/old-kb/toolkit-for-ui-and-ux/unity/objects/cursor-state.md).

# Cursor State

## Introduction

{% hint style="info" %}
Part of the [Cursor System](/old-kb/toolkit-for-ui-and-ux/unity/learning/core-concepts/cursor-tools.md) of the UX Foundation and UX Compelete assets
{% endhint %}

A specialized [GameEvent](/old-kb/assets/system-core/game-events.md) object which represents the state of a cursor.

## Definition

### Fields and Attributes

<table><thead><tr><th width="186.68968107781367">Type</th><th width="182.41271262309755">Name</th><th width="370.2">Notes</th></tr></thead><tbody><tr><td>Vector2</td><td>hotSpot</td><td>The point in the image to act as the tip or activation point of the cursor</td></tr><tr><td><a href="/pages/Bm4t3VzIiGZCv6HtxZxZ">CursorAnimation</a></td><td>stateOnExit</td><td>The animation settings for the cursor</td></tr></tbody></table>

### Funcitons

#### Set State

Sets the state as active&#x20;

#### Make Default

Makes this the default state