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

Public Member Functions

void create (number x, number y, number z, boolean north, string sprite)
boolean walkTo (number x, number y, number z)
boolean isValid (IsoGridSquare square)
void render (number x, number y, number z, IsoGridSquare square)
void renderOpaqueObjectsInWorld (number x, number y, number z, IsoGridSquare square)
void deactivate ()
void drawPrompt (integer playerNum, ISEquippedItem ui)
number getSurface (IsoGridSquare square)
number rotateDelta ()
number clamp (number rot)
void checkSelectSurfaceKey ()
void checkRotateKey ()
void checkRotateJoypad ()
void handleRotate (boolean pressed, boolean reverse)
void checkPositionJoypad ()
void onJoypadPressButton (integer joypadIndex, JoypadData joypadData, integer button)
unknown onJoypadDirDown (JoypadData joypadData)
unknown onJoypadDirUp (JoypadData joypadData)
unknown onJoypadDirRight (JoypadData joypadData)
unknown onJoypadDirLeft (JoypadData joypadData)
string getAPrompt ()
string getBPrompt ()
string getXPrompt ()
string getYPrompt ()
string getLBPrompt ()
string getRBPrompt ()
boolean onObjectLeftMouseButtonDown (IsoObject object, number x, number y)
 ISPlace3DItemCursor (IsoPlayer character, InventoryItem[] items)
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 ()

Public Attributes

boolean placeAll
boolean keepOnSquare
number surfaceSelected
integer keepOnSquareX
integer keepOnSquareY
number render3DItemXOffset
number render3DItemYOffset
number render3DItemZOffset
IsoGridSquare selectedSqDrop
table surfacesPossible
boolean rotatePressed
number render3DItemRot
boolean rotating
boolean rotateReverse
number rotateStart
boolean joypadPositionActive
number joypadPositionX
number joypadPositionY
IsoPlayer chr
IsoPlayer character
InventoryItem[] items
integer player
boolean skipBuildAction
boolean noNeedHammer
boolean isYButtonResetCursor
boolean isPlace3DCursor
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 Member Functions inherited from ISBuildingObject
static void onDestroy (IsoThumpable thump, IsoPlayer player)
static void removeFromGround (IsoGridSquare square)
Static Public Attributes inherited from ISBuildingObject
static IsoSprite floorCursorSprite

Constructor & Destructor Documentation

◆ ISPlace3DItemCursor()

ISPlace3DItemCursor::ISPlace3DItemCursor ( IsoPlayer character,
InventoryItem[] items )

Member Function Documentation

◆ checkPositionJoypad()

void ISPlace3DItemCursor::checkPositionJoypad ( )

◆ checkRotateJoypad()

void ISPlace3DItemCursor::checkRotateJoypad ( )

◆ checkRotateKey()

void ISPlace3DItemCursor::checkRotateKey ( )

◆ checkSelectSurfaceKey()

void ISPlace3DItemCursor::checkSelectSurfaceKey ( )

◆ clamp()

number ISPlace3DItemCursor::clamp ( number rot)

◆ create()

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

◆ deactivate()

void ISPlace3DItemCursor::deactivate ( )

◆ drawPrompt()

void ISPlace3DItemCursor::drawPrompt ( integer playerNum,
ISEquippedItem ui )

◆ getAPrompt()

string ISPlace3DItemCursor::getAPrompt ( )

◆ getBPrompt()

string ISPlace3DItemCursor::getBPrompt ( )

◆ getLBPrompt()

string ISPlace3DItemCursor::getLBPrompt ( )

◆ getRBPrompt()

string ISPlace3DItemCursor::getRBPrompt ( )

◆ getSurface()

number ISPlace3DItemCursor::getSurface ( IsoGridSquare square)

◆ getXPrompt()

string ISPlace3DItemCursor::getXPrompt ( )

◆ getYPrompt()

string ISPlace3DItemCursor::getYPrompt ( )

◆ handleRotate()

void ISPlace3DItemCursor::handleRotate ( boolean pressed,
boolean reverse )

◆ isValid()

boolean ISPlace3DItemCursor::isValid ( IsoGridSquare square)

◆ onJoypadDirDown()

unknown ISPlace3DItemCursor::onJoypadDirDown ( JoypadData joypadData)

◆ onJoypadDirLeft()

unknown ISPlace3DItemCursor::onJoypadDirLeft ( JoypadData joypadData)

◆ onJoypadDirRight()

unknown ISPlace3DItemCursor::onJoypadDirRight ( JoypadData joypadData)

◆ onJoypadDirUp()

unknown ISPlace3DItemCursor::onJoypadDirUp ( JoypadData joypadData)

◆ onJoypadPressButton()

void ISPlace3DItemCursor::onJoypadPressButton ( integer joypadIndex,
JoypadData joypadData,
integer button )

◆ onObjectLeftMouseButtonDown()

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

◆ render()

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

◆ renderOpaqueObjectsInWorld()

void ISPlace3DItemCursor::renderOpaqueObjectsInWorld ( number x,
number y,
number z,
IsoGridSquare square )

◆ rotateDelta()

number ISPlace3DItemCursor::rotateDelta ( )

◆ walkTo()

boolean ISPlace3DItemCursor::walkTo ( number x,
number y,
number z )

Member Data Documentation

◆ character

IsoPlayer ISPlace3DItemCursor::character

◆ chr

IsoPlayer ISPlace3DItemCursor::chr

◆ isPlace3DCursor

boolean ISPlace3DItemCursor::isPlace3DCursor

◆ isYButtonResetCursor

boolean ISPlace3DItemCursor::isYButtonResetCursor

◆ items

InventoryItem [] ISPlace3DItemCursor::items

◆ joypadPositionActive

boolean ISPlace3DItemCursor::joypadPositionActive

◆ joypadPositionX

number ISPlace3DItemCursor::joypadPositionX

◆ joypadPositionY

number ISPlace3DItemCursor::joypadPositionY

◆ keepOnSquare

boolean ISPlace3DItemCursor::keepOnSquare

◆ keepOnSquareX

integer ISPlace3DItemCursor::keepOnSquareX

◆ keepOnSquareY

integer ISPlace3DItemCursor::keepOnSquareY

◆ noNeedHammer

boolean ISPlace3DItemCursor::noNeedHammer

◆ placeAll

boolean ISPlace3DItemCursor::placeAll

◆ player

integer ISPlace3DItemCursor::player

◆ render3DItemRot

number ISPlace3DItemCursor::render3DItemRot

◆ render3DItemXOffset

number ISPlace3DItemCursor::render3DItemXOffset

◆ render3DItemYOffset

number ISPlace3DItemCursor::render3DItemYOffset

◆ render3DItemZOffset

number ISPlace3DItemCursor::render3DItemZOffset

◆ rotatePressed

boolean ISPlace3DItemCursor::rotatePressed

◆ rotateReverse

boolean ISPlace3DItemCursor::rotateReverse

◆ rotateStart

number ISPlace3DItemCursor::rotateStart

◆ rotating

boolean ISPlace3DItemCursor::rotating

◆ selectedSqDrop

IsoGridSquare ISPlace3DItemCursor::selectedSqDrop

◆ skipBuildAction

boolean ISPlace3DItemCursor::skipBuildAction

◆ surfaceSelected

number ISPlace3DItemCursor::surfaceSelected

◆ surfacesPossible

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