Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Cursors.CursorController Class Reference
Inheritance diagram for Cursors.CursorController:

Public Member Functions

CursorItem AddCursor (string id, CustomCursor defaultCursor, CustomCursor leftClickCursor=null, CustomCursor rightClickCursor=null)
 Adds a new cursor item to the cursor dictionary More...
 
void ChangeCursor (string id)
 Change the current cursor item to one from the cursor list More...
 
void Clear ()
 Clears all the cursors in the cursors dictionary More...
 
bool Contains (string id)
 Returns true if the cursor dictionary contains a cursor with the provided id More...
 
void ForceDefaultCursor ()
 Force the use of the default KSP cursor More...
 
void RemoveCursor (string id)
 Removes a cursor from the cursors dictionary More...
 

Public Attributes

TextureCursor DefaultCursor
 
TextureCursor DefaultLeftClick
 
TextureCursor DefaultRightClick
 

Static Public Attributes

static CursorController Instance
 

Protected Member Functions

void SetCursor (CustomCursor cur)
 

Protected Attributes

CursorItem basicDefault
 
CursorItem currentCursor
 

Properties

int Count [get]
 Returns the size of the cursors dictionary More...
 
CursorItem this[int index] [get]
 Returns a cursor item for the specified index More...
 
CursorItem this[string id] [get]
 Returns a cursor item for the specified id More...
 

Member Function Documentation

CursorItem Cursors.CursorController.AddCursor ( string  id,
CustomCursor  defaultCursor,
CustomCursor  leftClickCursor = null,
CustomCursor  rightClickCursor = null 
)
inline

Adds a new cursor item to the cursor dictionary

Parameters
idId of this cursor
defaultCursorDefault/Idle cursor
leftClickCursorLeft click cursor
rightClickCursorRight click cursor
Returns
void Cursors.CursorController.ChangeCursor ( string  id)
inline

Change the current cursor item to one from the cursor list

Parameters
id
void Cursors.CursorController.Clear ( )
inline

Clears all the cursors in the cursors dictionary

bool Cursors.CursorController.Contains ( string  id)
inline

Returns true if the cursor dictionary contains a cursor with the provided id

Parameters
idId of the cursor
Returns
void Cursors.CursorController.ForceDefaultCursor ( )
inline

Force the use of the default KSP cursor

void Cursors.CursorController.RemoveCursor ( string  id)
inline

Removes a cursor from the cursors dictionary

Parameters
idId of the cursor
void Cursors.CursorController.SetCursor ( CustomCursor  cur)
inlineprotected

Member Data Documentation

CursorItem Cursors.CursorController.basicDefault
protected
CursorItem Cursors.CursorController.currentCursor
protected
TextureCursor Cursors.CursorController.DefaultCursor
TextureCursor Cursors.CursorController.DefaultLeftClick
TextureCursor Cursors.CursorController.DefaultRightClick
CursorController Cursors.CursorController.Instance
static

Property Documentation

int Cursors.CursorController.Count
get

Returns the size of the cursors dictionary

CursorItem Cursors.CursorController.this[int index]
get

Returns a cursor item for the specified index

Parameters
indexCursor index
Returns
CursorItem Cursors.CursorController.this[string id]
get

Returns a cursor item for the specified id

Parameters
idId of the cursor
Returns

The documentation for this class was generated from the following file: