Project Zomboid Lua Docs 29123
Unofficial documentation for Project Zomboid's Lua
Loading...
Searching...
No Matches
ISBuildCursorMouse Class Reference
Inheritance diagram for ISBuildCursorMouse:
ISBuildingObject ISBaseObject

Public Member Functions

void create (number x, number y, number z, boolean north, string sprite)
void render (number x, number y, number z, IsoGridSquare square)
void deactivate ()
void hideTooltip ()
void renderTooltip ()
 ISBuildCursorMouse (IsoPlayer character, umbrella::ISBuildCursorMouse::OnSquareSelected onSquareSelected, umbrella::ISBuildCursorMouse::ValidationFunction isValid)
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 boolean IsVisible ()
Static Public Member Functions inherited from ISBuildingObject
static void onDestroy (IsoThumpable thump, IsoPlayer player)
static void removeFromGround (IsoGridSquare square)

Public Attributes

IsoGridSquare sq
string chosenSprite
string previousSprite
ISToolTip tooltip
umbrella::ISBuildCursorMouse::OnSquareSelected onSquareSelected
boolean isValid
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

Static Public Attributes

static IsoSprite spriteRender
Static Public Attributes inherited from ISBuildingObject
static IsoSprite floorCursorSprite

Constructor & Destructor Documentation

◆ ISBuildCursorMouse()

ISBuildCursorMouse::ISBuildCursorMouse ( IsoPlayer character,
umbrella::ISBuildCursorMouse::OnSquareSelected onSquareSelected,
umbrella::ISBuildCursorMouse::ValidationFunction isValid )

Member Function Documentation

◆ create()

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

◆ deactivate()

void ISBuildCursorMouse::deactivate ( )

◆ hideTooltip()

void ISBuildCursorMouse::hideTooltip ( )

◆ IsVisible()

boolean ISBuildCursorMouse::IsVisible ( )
static

◆ render()

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

◆ renderTooltip()

void ISBuildCursorMouse::renderTooltip ( )

Member Data Documentation

◆ character

IsoPlayer ISBuildCursorMouse::character

◆ chosenSprite

string ISBuildCursorMouse::chosenSprite

◆ isValid

boolean ISBuildCursorMouse::isValid

◆ noNeedHammer

boolean ISBuildCursorMouse::noNeedHammer

◆ onSquareSelected

umbrella::ISBuildCursorMouse::OnSquareSelected ISBuildCursorMouse::onSquareSelected

◆ player

integer ISBuildCursorMouse::player

◆ previousSprite

string ISBuildCursorMouse::previousSprite

◆ skipBuildAction

boolean ISBuildCursorMouse::skipBuildAction

◆ spriteRender

IsoSprite ISBuildCursorMouse::spriteRender
static

◆ sq

IsoGridSquare ISBuildCursorMouse::sq

◆ tooltip

ISToolTip ISBuildCursorMouse::tooltip

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