ISShovelGroundCursor Class Reference

Inheritance diagram for ISShovelGroundCursor:

Public Member Functions
void	create (number x, number y, number z, boolean north, string sprite)
boolean	isValid (IsoGridSquare square)
void	render (number x, number y, number z, IsoGridSquare square)
string	getDirtGravelSand (IsoGridSquare square)
string	getEmptyItem ()
	ISShovelGroundCursor (string sprite, string northSprite, IsoPlayer character, string groundType)
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)
void	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	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, integer 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)
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 table< string, integer >	GetEmptyItemCounts (IsoPlayer playerObj)
static string	GetEmptyItem (IsoPlayer playerObj, string groundType)
static string	GetDirtGravelSand (IsoGridSquare square)
Static Public Member Functions inherited from ISBuildingObject
static void	onDestroy (IsoThumpable thump, IsoPlayer player)
static void	removeFromGround (IsoGridSquare square)

Public Attributes
string	groundType
IsoPlayer	character
integer	player
boolean	noNeedHammer
boolean	skipBuildAction
Public Attributes inherited from ISBuildingObject
boolean	canPassThrough
string	northSprite
string	eastSprite
string	southSprite
string	sprite
string	chosenSprite
boolean	dragNilAfterPlace
boolean	blockBuild
boolean	isLeftDown
boolean	clickedUI
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
table< string, table< function, unknown > >	__eventListeners

Additional Inherited Members
Static Public Attributes inherited from ISBuildingObject
static IsoSprite	floorCursorSprite

Constructor & Destructor Documentation

ISShovelGroundCursor()

ISShovelGroundCursor::ISShovelGroundCursor	(	string	sprite,
		string	northSprite,
		IsoPlayer	character,
		string	groundType )

Member Function Documentation

create()

void ISShovelGroundCursor::create	(	number	x,
		number	y,
		number	z,
		boolean	north,
		string	sprite )

GetDirtGravelSand()

string ISShovelGroundCursor::GetDirtGravelSand ( IsoGridSquare square )

static

getDirtGravelSand()

string ISShovelGroundCursor::getDirtGravelSand

(

IsoGridSquare

square

)

GetEmptyItem()

string ISShovelGroundCursor::GetEmptyItem ( IsoPlayer playerObj, string groundType )

static

getEmptyItem()

string ISShovelGroundCursor::getEmptyItem

(

)

GetEmptyItemCounts()

table< string, integer > ISShovelGroundCursor::GetEmptyItemCounts ( IsoPlayer playerObj )

static

isValid()

boolean ISShovelGroundCursor::isValid

(

IsoGridSquare

square

)

render()

void ISShovelGroundCursor::render	(	number	x,
		number	y,
		number	z,
		IsoGridSquare	square )

Member Data Documentation

character

IsoPlayer ISShovelGroundCursor::character

groundType

string ISShovelGroundCursor::groundType

noNeedHammer

boolean ISShovelGroundCursor::noNeedHammer

player

integer ISShovelGroundCursor::player

skipBuildAction

boolean ISShovelGroundCursor::skipBuildAction

---

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

• server/BuildingObjects/ISShovelGroundCursor.yml