View source

class Cursor

package funkin.input

@:directlyUsed@:nullSafety

Available on all platforms

Static variables

@:value({ graphic : "assets/images/cursor/cursor-cell.png", scale : 1.0, offsetX : -16, offsetY : -16 })staticfinalread onlyCURSOR_CELL_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-cell.png", scale : 1.0, offsetX : -16, offsetY : -16 }

@:value({ graphic : "assets/images/cursor/cursor-crosshair.png", scale : 1.0, offsetX : -16, offsetY : -16 })staticfinalread onlyCURSOR_CROSSHAIR_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-crosshair.png", scale : 1.0, offsetX : -16, offsetY : -16 }

@:value({ graphic : "assets/images/cursor/cursor-cross.png", scale : 1.0, offsetX : 0, offsetY : 0 })staticfinalread onlyCURSOR_CROSS_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-cross.png", scale : 1.0, offsetX : 0, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-default.png", scale : 1.0, offsetX : 0, offsetY : 0 })staticfinalread onlyCURSOR_DEFAULT_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-default.png", scale : 1.0, offsetX : 0, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-eraser.png", scale : 1.0, offsetX : 0, offsetY : 0 })staticfinalread onlyCURSOR_ERASER_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-eraser.png", scale : 1.0, offsetX : 0, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-grabbing.png", scale : 1.0, offsetX : -8, offsetY : 0 })staticfinalread onlyCURSOR_GRABBING_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-grabbing.png", scale : 1.0, offsetX : -8, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-hourglass.png", scale : 1.0, offsetX : 0, offsetY : 0 })staticfinalread onlyCURSOR_HOURGLASS_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-hourglass.png", scale : 1.0, offsetX : 0, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-pointer.png", scale : 1.0, offsetX : -8, offsetY : 0 })staticfinalread onlyCURSOR_POINTER_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-pointer.png", scale : 1.0, offsetX : -8, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-scroll.png", scale : 0.2, offsetX : -15, offsetY : -15 })staticfinalread onlyCURSOR_SCROLL_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-scroll.png", scale : 0.2, offsetX : -15, offsetY : -15 }

@:value({ graphic : "assets/images/cursor/cursor-text.png", scale : 0.2, offsetX : 0, offsetY : 0 })staticfinalread onlyCURSOR_TEXT_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-text.png", scale : 0.2, offsetX : 0, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-text-vertical.png", scale : 0.2, offsetX : 0, offsetY : 0 })staticfinalread onlyCURSOR_TEXT_VERTICAL_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-text-vertical.png", scale : 0.2, offsetX : 0, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-zoom-in.png", scale : 1.0, offsetX : 0, offsetY : 0 })staticfinalread onlyCURSOR_ZOOM_IN_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-zoom-in.png", scale : 1.0, offsetX : 0, offsetY : 0 }

@:value({ graphic : "assets/images/cursor/cursor-zoom-out.png", scale : 1.0, offsetX : 0, offsetY : 0 })staticfinalread onlyCURSOR_ZOOM_OUT_PARAMS:CursorParams = { graphic : "assets/images/cursor/cursor-zoom-out.png", scale : 1.0, offsetX : 0, offsetY : 0 }

@:value(null)staticcursorMode:Null<CursorMode> = null

The current cursor mode. Set this value to change the cursor graphic.

Static methods

staticinlinehide():Void

Hide the cursor.

staticregisterHaxeUICursor(id:String, params:CursorParams):Void

staticregisterHaxeUICursors():Void

staticinlineshow():Void

Show the cursor.

staticinlinetoggle():Void