![]() |
PowerQuest
0.13.1
|
Cursor: contains functions and data for manipulating the mouse cursor - Interface to QuestCursor.
Properties | |
bool | Visible [get, set] |
Shows or hides the mouse cursor. More... | |
string | AnimationClickable [get, set] |
Gets/Sets the default animation that plays when mouse is over a clickable object. More... | |
string | AnimationNonClickable [get, set] |
Gets/Sets the default animation that plays when mouse is NOT over a clickable object. More... | |
string | AnimationUseInv [get, set] |
Gets/Sets the default animation that plays when there's an active inventory item (if not using inventory items) More... | |
string | AnimationOverGui [get, set] |
Gets/Sets the default animation that plays when the mosue is over gui. More... | |
bool | HideWhenBlocking [get, set] |
Gets/Sets whether the mouse should be hidden when there's a blocking script. More... | |
bool | NoneCursorActive [get] |
Returns true if cursor is hovering over something with a cursor set to "None". More... | |
bool | InventoryCursorOverridden [get] |
Returns true if cursor is hovering over something with a cursor set as one of the "Inventory Override Anims" set in the inspector. Used for "exit" hotspot arrow cursors, etc. More... | |
Vector2 | PositionOverride [get, set] |
Gets/Sets the mouse cursor position, overiding the actual position of the mouse. Reset with "ClearPositionOverride()". More... | |
bool | HasPositionOverride [get] |
True if SetPositionOverride() was called or PositionOverride was set. More... | |
Color | InventoryOutlineColor [get, set] |
Outline colour used to highlight inventory (pixel art only) More... | |
Public Member Functions | |
void | SetPositionOverride (Vector2 position) |
Sets the mouse cursor position, overiding the actual position of the mouse. Reset with "ClearPositionOverride()". More... | |
void | ClearPositionOverride () |
Removes any position override from the cursor, returning it to normal mouse position. More... | |
QuestCursorComponent | GetInstance () |
Gets the QuestCursorComponent of the cursor's game object. More... | |
|
getset |
Shows or hides the mouse cursor.
|
getset |
Gets/Sets the default animation that plays when mouse is over a clickable object.
|
getset |
Gets/Sets the default animation that plays when mouse is NOT over a clickable object.
|
getset |
Gets/Sets the default animation that plays when there's an active inventory item (if not using inventory items)
|
getset |
Gets/Sets the default animation that plays when the mosue is over gui.
|
getset |
Gets/Sets whether the mouse should be hidden when there's a blocking script.
|
get |
Returns true if cursor is hovering over something with a cursor set to "None".
|
get |
Returns true if cursor is hovering over something with a cursor set as one of the "Inventory Override Anims" set in the inspector. Used for "exit" hotspot arrow cursors, etc.
|
getset |
Gets/Sets the mouse cursor position, overiding the actual position of the mouse. Reset with "ClearPositionOverride()".
|
get |
True if SetPositionOverride() was called or PositionOverride was set.
|
getset |
Outline colour used to highlight inventory (pixel art only)
void SetPositionOverride | ( | Vector2 | position | ) |
Sets the mouse cursor position, overiding the actual position of the mouse. Reset with "ClearPositionOverride()".
void ClearPositionOverride | ( | ) |
Removes any position override from the cursor, returning it to normal mouse position.
QuestCursorComponent GetInstance | ( | ) |
Gets the QuestCursorComponent of the cursor's game object.