Inheritance diagram for ISMoveableCursor:

Public Member Functions
void	deactivate ()
void	exitCursor ()
boolean	onObjectLeftMouseButtonDown (IsoObject object, number x, number y)
void	clearCache ()
string	getMoveableMode ()
void	tryInitialItem (InventoryItem _item)
void	setMoveableMode (string _mode)
void	create (number _x, number _y, number _z, boolean _north, string _sprite)
boolean	cannotCreate (number x, number y, number z)
ISMoveableInfoWindow	getInfoPanel ()
ISMoveableInfoWindow	setInfoPanel (IsoGridSquare _square, IsoObject _object, ISMoveableSpriteProps _moveProps, string _customTexture)
void	beforeWorldRender (number x, number y, number z)
void	render (number _x, number _y, number _z, IsoGridSquare _square)
void	renderSpriteGrid (number _x, number _y, number _z, umbrella::RGB color)
boolean	renderObjectThatCanRotate (number _x, number _y, number _z, nil renderRotateIndicator)
void	renderRotateIndicator (number _x, number _y, number _z, IsoDirections _dir)
boolean	isFacingOriginalDirection ()
boolean	isValid (IsoGridSquare _square)
void	rotateKey (integer key, boolean _joypadTriggered)
void	rotateWhilePlacing ()
IsoDirections	getDirectionFromItem (InventoryItem item)
number	getCenterOfRotation ()
void	rotateMouse (number x, number y)
void	setObjectHiddenDuringRotate (IsoObject object)
void	resetObjectHiddenDuringRotate ()
void	setCursorFacing (integer facing)
void	setJoypadFocus (ISUIElement _window)
umbrella::ISMoveableCursor::ObjectInfo false	getRotateableObject ()
umbrella::ISMoveableCursor::ObjectInfo[]	getInventoryObjectList ()
boolean	shouldAddObject (IsoObject _obj, ISMoveableSpriteProps moveProps)
umbrella::ISMoveableCursor::ObjectInfo[]	getObjectList ()
umbrella::ISMoveableCursor::ObjectInfo[]	getScrapObjectList ()
umbrella::ISMoveableCursor::ObjectInfo[]	getRepairObjectList ()
void	onJoypadPressButton (integer joypadIndex, JoypadData joypadData, JoypadButton button)
string	getAPrompt ()
string	getXPrompt ()
string	getLBPrompt ()
string	getRBPrompt ()
	ISMoveableCursor (IsoPlayer _character)
Public Member Functions inherited from ISBuildingObject
void	initialise ()
void	setCanPassThrough (string passThrough)
void	setNorthSprite (string sprite)
void	setEastSprite (string sprite)
void	setSouthSprite (string sprite)
void	setSprite (string sprite)
void	setDragNilAfterPlace (boolean nilAfter)
ISBuildAction	tryBuild (number x, number y, number z)
void	onActionComplete ()
boolean	walkTo (number x, number y, number z)
void	onTimedActionStart (ISBaseTimedAction action)
void	onTimedActionStop (ISBaseTimedAction action)
void	updateModData ()
boolean	haveMaterial (IsoGridSquare square)
void	reinit ()
void	reset ()
void	init ()
string	getSprite ()
boolean	isValid (IsoGridSquare square)
void	beforeWorldRender (number x, number y, number z)
void	render (number x, number y, number z, IsoGridSquare square)
void	rotateKey (integer key)
void	rotateMouse (number x, number y)
void	deactivate ()
void	onJoypadPressButton (integer joypadIndex, JoypadData joypadData, JoypadButton button)
void	onJoypadDirDown (JoypadData joypadData)
void	onJoypadDirUp (JoypadData joypadData)
void	onJoypadDirRight (JoypadData joypadData)
void	onJoypadDirLeft (JoypadData joypadData)
string	getAPrompt ()
string	getBPrompt ()
string	getYPrompt ()
string	getLBPrompt ()
string	getRBPrompt ()
IsoSprite	getFloorCursorSprite ()
void	update ()
void	renderOpaqueObjectsInWorld (number x, number y, number z, IsoGridSquare square)
Public Member Functions inherited from ISBaseObject
void	initialise ()
ISBaseObject	derive (string type)
boolean	instanceof (unknown object, string type)
void	addEventListener (string _event, function _callback, unknown _target)
void	removeEventListener (string _event, function _callback)
void	triggerEvent (string _event, unknown ...)
void	clearEventListeners ()
	ISBaseObject ()

Static Public Member Functions
static void	exitCursorKey (integer _key)
static void	changeModeKey (integer _key, integer _playerNum, boolean _joyPadTriggered)
static void	clearCacheForAllPlayers ()
Static Public Member Functions inherited from ISBuildingObject
static void	onDestroy (IsoThumpable thump, IsoPlayer player)
static void	removeFromGround (IsoGridSquare square)

Public Attributes
integer	objectIndex
umbrella::ISMoveableCursor::ObjectInfo umbrella::ISMoveableCursor::ObjectInfo[] false	objectListCache
IsoObject	cacheObject
InventoryItem	tryInitialInvItem
ISPathFindAction	pathfindAction
integer	cursorFacing
number	joypadFacing
IsoGridSquare	cacheSquare
number	renderX
number	renderY
number	renderZ
ISMoveableSpriteProps	currentMoveProps
ISMoveableSpriteProps	origMoveProps
boolean	canCreate
string	objectSprite
string	origSpriteName
umbrella::RGBA	colorMod
number	yOffset
IsoGridSquare	currentSquare
boolean	canSeeCurrentSquare
string	cacheInvObjectSprite
IsoObject	objectHiddenDuringRotate
number	xJoypad
number	yJoypad
boolean	isMoveableCursor
string	moveableMode
IsoPlayer	character
integer	player
boolean	skipBuildAction
boolean	isYButtonResetCursor
boolean	noNeedHammer
boolean	skipWalk
boolean	renderFloorHelper
integer	subObjectIndex
integer	cacheInvObjectIndex
Public Attributes inherited from ISBuildingObject
boolean	canPassThrough
string	northSprite
string	eastSprite
string	southSprite
string	sprite
string	chosenSprite
boolean	dragNilAfterPlace
boolean	blockBuild
boolean	isLeftDown
boolean	canBeBuild
boolean	build
IsoGridSquare	square
integer	nSprite
boolean	north
boolean	south
boolean	east
boolean	west
number	xJoypad
number	yJoypad
number	zJoypad
boolean	isWallLike
boolean	isCorner
string	completionSound
boolean	canBeAlwaysPlaced
boolean	isContainer
boolean	canBarricade
number	thumpDmg
boolean	isDoor
boolean	isDoorFrame
number	crossSpeed
boolean	blockAllTheSquare
boolean	dismantable
boolean	canBePlastered
boolean	hoppable
boolean	isThumpable
boolean	isFloor
table	modData
IsoSprite	RENDER_SPRITE_FLOOR
IsoSprite	RENDER_SPRITE
string	RENDER_SPRITE_NAME
Public Attributes inherited from ISBaseObject
string	Type
ISBaseObject	SuperType
table< string, table< function, unknown > >	__eventListeners

Static Public Attributes
static static table< integer, ISMoveableCursor >	cursors { tags: string[], titles: string[] } modes
static table< integer, string >	mode
static table< integer, string >	cacheMode
static umbrella::RGB	normalColor
static umbrella::RGB	validColor
static umbrella::RGB	invalidColor
Static Public Attributes inherited from ISBuildingObject
static IsoSprite	floorCursorSprite

Constructor & Destructor Documentation

◆ ISMoveableCursor()

ISMoveableCursor::ISMoveableCursor ( IsoPlayer _character )

Member Function Documentation

◆ beforeWorldRender()

void ISMoveableCursor::beforeWorldRender	(	number	x,
		number	y,
		number	z )

◆ cannotCreate()

boolean ISMoveableCursor::cannotCreate	(	number	x,
		number	y,
		number	z )

◆ changeModeKey()

void ISMoveableCursor::changeModeKey	(	integer	_key,
		integer	_playerNum,
		boolean	_joyPadTriggered )

static

◆ clearCache()

void ISMoveableCursor::clearCache ( )

◆ clearCacheForAllPlayers()

void ISMoveableCursor::clearCacheForAllPlayers ( )

static

◆ create()

void ISMoveableCursor::create	(	number	_x,
		number	_y,
		number	_z,
		boolean	_north,
		string	_sprite )

◆ deactivate()

void ISMoveableCursor::deactivate ( )

◆ exitCursor()

void ISMoveableCursor::exitCursor ( )

◆ exitCursorKey()

void ISMoveableCursor::exitCursorKey ( integer _key )

static

◆ getAPrompt()

string ISMoveableCursor::getAPrompt ( )

◆ getCenterOfRotation()

number ISMoveableCursor::getCenterOfRotation ( )

◆ getDirectionFromItem()

IsoDirections ISMoveableCursor::getDirectionFromItem ( InventoryItem item )

◆ getInfoPanel()

ISMoveableInfoWindow ISMoveableCursor::getInfoPanel ( )

◆ getInventoryObjectList()

umbrella::ISMoveableCursor::ObjectInfo[] ISMoveableCursor::getInventoryObjectList ( )

◆ getLBPrompt()

string ISMoveableCursor::getLBPrompt ( )

◆ getMoveableMode()

string ISMoveableCursor::getMoveableMode ( )

◆ getObjectList()

umbrella::ISMoveableCursor::ObjectInfo[] ISMoveableCursor::getObjectList ( )

◆ getRBPrompt()

string ISMoveableCursor::getRBPrompt ( )

◆ getRepairObjectList()

umbrella::ISMoveableCursor::ObjectInfo[] ISMoveableCursor::getRepairObjectList ( )

◆ getRotateableObject()

umbrella::ISMoveableCursor::ObjectInfo false ISMoveableCursor::getRotateableObject ( )

◆ getScrapObjectList()

umbrella::ISMoveableCursor::ObjectInfo[] ISMoveableCursor::getScrapObjectList ( )

◆ getXPrompt()

string ISMoveableCursor::getXPrompt ( )

◆ isFacingOriginalDirection()

boolean ISMoveableCursor::isFacingOriginalDirection ( )

◆ isValid()

boolean ISMoveableCursor::isValid ( IsoGridSquare _square )

◆ onJoypadPressButton()

void ISMoveableCursor::onJoypadPressButton	(	integer	joypadIndex,
		JoypadData	joypadData,
		JoypadButton	button )

◆ onObjectLeftMouseButtonDown()

boolean ISMoveableCursor::onObjectLeftMouseButtonDown	(	IsoObject	object,
		number	x,
		number	y )

◆ render()

void ISMoveableCursor::render	(	number	_x,
		number	_y,
		number	_z,
		IsoGridSquare	_square )

◆ renderObjectThatCanRotate()

boolean ISMoveableCursor::renderObjectThatCanRotate	(	number	_x,
		number	_y,
		number	_z,
		nil	renderRotateIndicator )

◆ renderRotateIndicator()

void ISMoveableCursor::renderRotateIndicator	(	number	_x,
		number	_y,
		number	_z,
		IsoDirections	_dir )

◆ renderSpriteGrid()

void ISMoveableCursor::renderSpriteGrid	(	number	_x,
		number	_y,
		number	_z,
		umbrella::RGB	color )

◆ resetObjectHiddenDuringRotate()

void ISMoveableCursor::resetObjectHiddenDuringRotate ( )

◆ rotateKey()

void ISMoveableCursor::rotateKey	(	integer	key,
		boolean	_joypadTriggered )

◆ rotateMouse()

void ISMoveableCursor::rotateMouse	(	number	x,
		number	y )

◆ rotateWhilePlacing()

void ISMoveableCursor::rotateWhilePlacing ( )

◆ setCursorFacing()

void ISMoveableCursor::setCursorFacing ( integer facing )

◆ setInfoPanel()

ISMoveableInfoWindow ISMoveableCursor::setInfoPanel	(	IsoGridSquare	_square,
		IsoObject	_object,
		ISMoveableSpriteProps	_moveProps,
		string	_customTexture )

◆ setJoypadFocus()

void ISMoveableCursor::setJoypadFocus ( ISUIElement _window )

◆ setMoveableMode()

void ISMoveableCursor::setMoveableMode ( string _mode )

◆ setObjectHiddenDuringRotate()

void ISMoveableCursor::setObjectHiddenDuringRotate ( IsoObject object )

◆ shouldAddObject()

boolean ISMoveableCursor::shouldAddObject	(	IsoObject	_obj,
		ISMoveableSpriteProps	moveProps )

◆ tryInitialItem()

void ISMoveableCursor::tryInitialItem ( InventoryItem _item )

Member Data Documentation

◆ cacheInvObjectIndex

integer ISMoveableCursor::cacheInvObjectIndex

◆ cacheInvObjectSprite

string ISMoveableCursor::cacheInvObjectSprite

◆ cacheMode

table<integer, string> ISMoveableCursor::cacheMode

static

◆ cacheObject

IsoObject ISMoveableCursor::cacheObject

◆ cacheSquare

IsoGridSquare ISMoveableCursor::cacheSquare

◆ canCreate

boolean ISMoveableCursor::canCreate

◆ canSeeCurrentSquare

boolean ISMoveableCursor::canSeeCurrentSquare

◆ character

IsoPlayer ISMoveableCursor::character

◆ colorMod

umbrella::RGBA ISMoveableCursor::colorMod

◆ currentMoveProps

ISMoveableSpriteProps ISMoveableCursor::currentMoveProps

◆ currentSquare

IsoGridSquare ISMoveableCursor::currentSquare

◆ cursorFacing

integer ISMoveableCursor::cursorFacing

◆ cursors

table<integer, ISMoveableCursor> ISMoveableCursor::cursors { tags: string[], titles: string[] } modes

static

◆ invalidColor

umbrella::RGB ISMoveableCursor::invalidColor

static

◆ isMoveableCursor

boolean ISMoveableCursor::isMoveableCursor

◆ isYButtonResetCursor

boolean ISMoveableCursor::isYButtonResetCursor

◆ joypadFacing

number ISMoveableCursor::joypadFacing

◆ mode

table<integer, string> ISMoveableCursor::mode

static

◆ moveableMode

string ISMoveableCursor::moveableMode

◆ noNeedHammer

boolean ISMoveableCursor::noNeedHammer

◆ normalColor

umbrella::RGB ISMoveableCursor::normalColor

static

◆ objectHiddenDuringRotate

IsoObject ISMoveableCursor::objectHiddenDuringRotate

◆ objectIndex

integer ISMoveableCursor::objectIndex

◆ objectListCache

umbrella::ISMoveableCursor::ObjectInfo umbrella::ISMoveableCursor::ObjectInfo [] false ISMoveableCursor::objectListCache

◆ objectSprite

string ISMoveableCursor::objectSprite

◆ origMoveProps

ISMoveableSpriteProps ISMoveableCursor::origMoveProps

◆ origSpriteName

string ISMoveableCursor::origSpriteName

◆ pathfindAction

ISPathFindAction ISMoveableCursor::pathfindAction

◆ player

integer ISMoveableCursor::player

◆ renderFloorHelper

boolean ISMoveableCursor::renderFloorHelper

◆ renderX

number ISMoveableCursor::renderX

◆ renderY

number ISMoveableCursor::renderY

◆ renderZ

number ISMoveableCursor::renderZ

◆ skipBuildAction

boolean ISMoveableCursor::skipBuildAction

◆ skipWalk

boolean ISMoveableCursor::skipWalk

◆ subObjectIndex

integer ISMoveableCursor::subObjectIndex

◆ tryInitialInvItem

InventoryItem ISMoveableCursor::tryInitialInvItem

◆ validColor

umbrella::RGB ISMoveableCursor::validColor

static

◆ xJoypad

number ISMoveableCursor::xJoypad

◆ yJoypad

number ISMoveableCursor::yJoypad

◆ yOffset

number ISMoveableCursor::yOffset

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

server/BuildingObjects/ISMoveableCursor.yml

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Constructor & Destructor Documentation

◆ ISMoveableCursor()

Member Function Documentation

◆ beforeWorldRender()

◆ cannotCreate()

◆ changeModeKey()

◆ clearCache()

◆ clearCacheForAllPlayers()

◆ create()

◆ deactivate()

◆ exitCursor()

◆ exitCursorKey()

◆ getAPrompt()

◆ getCenterOfRotation()

◆ getDirectionFromItem()

◆ getInfoPanel()

◆ getInventoryObjectList()

◆ getLBPrompt()

◆ getMoveableMode()

◆ getObjectList()

◆ getRBPrompt()

◆ getRepairObjectList()

◆ getRotateableObject()

◆ getScrapObjectList()

◆ getXPrompt()

◆ isFacingOriginalDirection()

◆ isValid()

◆ onJoypadPressButton()

◆ onObjectLeftMouseButtonDown()

◆ render()

◆ renderObjectThatCanRotate()

◆ renderRotateIndicator()

◆ renderSpriteGrid()

◆ resetObjectHiddenDuringRotate()

◆ rotateKey()

◆ rotateMouse()

◆ rotateWhilePlacing()

◆ setCursorFacing()

◆ setInfoPanel()

◆ setJoypadFocus()

◆ setMoveableMode()

◆ setObjectHiddenDuringRotate()

◆ shouldAddObject()

◆ tryInitialItem()

Member Data Documentation

◆ cacheInvObjectIndex

◆ cacheInvObjectSprite

◆ cacheMode

◆ cacheObject

◆ cacheSquare

◆ canCreate

◆ canSeeCurrentSquare

◆ character

◆ colorMod

◆ currentMoveProps

◆ currentSquare

◆ cursorFacing

◆ cursors

◆ invalidColor

◆ isMoveableCursor

◆ isYButtonResetCursor

◆ joypadFacing

◆ mode

◆ moveableMode

◆ noNeedHammer

◆ normalColor

◆ objectHiddenDuringRotate

◆ objectIndex

◆ objectListCache

◆ objectSprite

◆ origMoveProps

◆ origSpriteName

◆ pathfindAction

◆ player

◆ renderFloorHelper

◆ renderX