Header menu logo Nu

WorldCursorModule Module

Cursor manipulation functions for the world.

Type extensions

Type extension Description

World.getCursorType world

Full Usage: World.getCursorType world

Parameters:
Returns: CursorType

Get the cursor type.

Extended Type: World

world : World
Returns: CursorType

World.getCursorVisible world

Full Usage: World.getCursorVisible world

Parameters:
Returns: bool

Check cursor visibility.

Extended Type: World

world : World
Returns: bool

World.loadCursorPackage packageName world

Full Usage: World.loadCursorPackage packageName world

Parameters:
    packageName : string
    world : World

Load a cursor asset package. Should be used to avoid loading assets at inconvenient times (such as in the middle of game play!)

Extended Type: World

packageName : string
world : World

World.reloadCursorAssets world

Full Usage: World.reloadCursorAssets world

Parameters:

Reload all cursor assets.

Extended Type: World

world : World

World.setCursorType cursorType world

Full Usage: World.setCursorType cursorType world

Parameters:

Set the cursor type .

Extended Type: World

cursorType : CursorType
world : World

World.setCursorVisible visible world

Full Usage: World.setCursorVisible visible world

Parameters:
    visible : bool
    world : World

Set cursor visibility.

Extended Type: World

visible : bool
world : World

World.unloadCursorPackage packageName world

Full Usage: World.unloadCursorPackage packageName world

Parameters:
    packageName : string
    world : World

Unload an cursor package since its assets will not be used again soon.

Extended Type: World

packageName : string
world : World

Type something to start searching.