Project Zomboid Lua Docs 42.20.3
Unofficial documentation for Project Zomboid's Lua
Loading...
Searching...
No Matches
ISMap Class Reference
Inheritance diagram for ISMap:
ISPanelJoypad ISUIElement ISBaseObject

Public Member Functions

void instantiate ()
void createChildren ()
void destroy ()
void onButtonClick (ISButton button)
boolean onMouseDown (number x, number y)
boolean onMouseUp (number x, number y)
boolean canWrite ()
boolean canErase ()
void onConfirmRemove (ISButton button, integer note)
void onMouseUpOutside ()
boolean onMouseWheel (number del)
boolean onMouseMove (number dx, number dy)
void onMouseMoveOutside (number dx, number dy)
boolean onRightMouseDown (number x, number y)
void prerender ()
void render ()
void renderJoypadIcons ()
number renderButtonTextureAndText (Texture texture, string text, number x, number y)
void update ()
void initMapData ()
void updateJoypad ()
void updateButtons ()
void onGainJoypadFocus (JoypadData joypadData)
void onJoypadDown (JoypadButton button, JoypadData joypadData)
void copySymbolsToWorldMap ()
void revealOnWorldMap ()
 ISMap (number x, number y, number width, number height, MapItem map, integer player)
Public Member Functions inherited from ISPanelJoypad
void initialise ()
void setVisible (boolean visible, JoypadData joypadData)
ISButton[] insertNewLineOfButtons (ISButton button1, ISButton button2, ISButton button3, ISButton button4, ISButton button5, ISButton button6, ISButton button7, ISButton button8, ISButton button9, ISButton button10)
void insertNewListOfButtons (ISButton[] list)
boolean removeListOfButtons (ISButton[] list)
void addJoypadButtonRows (ISButton[][] rows)
void removeJoypadButtonRows (ISButton[][] rows)
void autoGenerateJoypadButtonsLists ()
void clearJoypadButtonsList ()
ISPanelJoypad noBackground ()
void close ()
void setISButtonForA (ISButton button)
void setISButtonForB (ISButton button)
void setISButtonForY (ISButton button)
void setISButtonForX (ISButton button)
void clearISButtonA ()
void clearISButtonB ()
void clearISButtonX ()
void clearISButtonY ()
void clearISButtons ()
void onJoypadDown (JoypadButton button, JoypadData joypadData)
integer getChildJoypadIndexY (ISButton child)
integer getChildJoypadIndex (ISButton child)
ISButton[] getVisibleChildren (integer joypadIndexY)
integer getMinVisibleRow ()
integer getMaxVisibleRow ()
integer getPrevVisibleRow (integer row)
integer getNextVisibleRow (integer row)
ISUIElement getClosestChildOnRow (number rowIndex, ISUIElement fromChild)
integer getClosestChild (ISUIElement[] children, ISUIElement fromChild)
void onJoypadDirLeft (JoypadData joypadData)
void onJoypadDirRight (JoypadData joypadData)
void onJoypadDirUp (JoypadData joypadData)
void onJoypadDirDown (JoypadData joypadData)
ISUIElement findNextNavigableChildY (ISUIElement fromChild, number yDir)
ISUIElement findNextNavigableChildX (ISUIElement fromChild, number xDir)
ISUIElement findClosestNavigableChildAlongBounds (ISUIElement fromChild, ISBounds fromChildBounds, ISBounds projectedBounds, number minDistance, fun(boundsA:ISBounds, boundsB:ISBounds):number distanceToFunc, { foundChild:ISUIElement, foundChildDistance:number }[] results)
ISUIElement getJoypadFocus ()
boolean setJoypadFocus (ISUIElement child, JoypadData joypadData)
boolean setJoypadFocusTopLeft (JoypadData joypadData)
void restoreJoypadFocus (JoypadData joypadData)
void clearJoypadFocus (JoypadData joypadData)
umbrella::ISPanelJoypad::JoypadState recordJoypadState ()
void restoreJoypadState (umbrella::ISPanelJoypad::JoypadState state)
void doRightJoystickScrolling (number dx, number dy)
void ensureVisible ()
boolean isFocusOnControl ()
void onMouseUp (number x, number y)
void onMouseUpOutside (number x, number y)
void onMouseDown (number x, number y)
void onMouseMoveOutside (number dx, number dy)
void onMouseMove (number dx, number dy)
void prerender ()
void render ()
void renderDebugUINavigation ()
 ISPanelJoypad (number x, number y, number width, number height)
Public Member Functions inherited from ISUIElement
fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) void initialise ()
void doLayout ()
void setController (integer c)
integer getController ()
ISBounds getBounds ()
ISBounds getLocalBounds ()
ISBounds getAbsoluteBounds ()
ISBounds toLocalBounds (ISBounds absoluteBounds)
ISBounds getScrollableBounds ()
void setBounds (ISBounds bounds)
void setAnchorBottom (boolean bAnchor)
void setAnchorTop (boolean bAnchor)
void setAnchorLeft (boolean bAnchor)
void setAnchorRight (boolean bAnchor)
void setAnchorsTBLR (boolean bAnchorT, boolean bAnchorB, boolean bAnchorL, boolean bAnchorR)
void setAnchors (boolean bAnchor)
boolean getKeepOnScreen ()
void setX (number x)
void setY (number y)
void setCenterY (number y)
void setCenterX (number x)
void setWidth (number w)
void setHeight (number h)
number getWidth ()
number getHeight ()
number getLeft ()
number getRight ()
number getAbsoluteRight ()
number getTop ()
number getBottom ()
number getAbsoluteBottom ()
number getXScroll ()
void setWidthAndParentWidth (number wi)
void setHeightAndParentHeight (number h)
number getYScroll ()
number getMouseX ()
number getMouseY ()
number getSelfCenterX ()
number getCenterX ()
number getCenterY ()
number getAbsoluteCenterX ()
number getAbsoluteCenterY ()
number getX ()
number getY ()
boolean isEnabled ()
void setEnabled (boolean en)
number getAbsoluteX ()
boolean isMouseOver ()
boolean isPointOver (number screenX, number screenY)
boolean isMouseOverChild ()
boolean isPointOverChild (number screenX, number screenY)
void suspendStencil ()
void resumeStencil ()
void setStencilRect (number x, number y, number w, number h)
void setStencilCircle (number x, number y, number w, number h)
void clearStencilRect ()
void repaintStencilRect (number x, number y, number w, number h)
number clampStencilRectToParent (number x, number y, number w, number h)
void ignoreWidthChange ()
number getMaxDrawHeight ()
void setMaxDrawHeight (number height)
void clearMaxDrawHeight ()
void ignoreHeightChange ()
number getAbsoluteY ()
void recalcSize ()
void onResize ()
void setCapture (boolean bCapture)
boolean getIsCaptured ()
unknown isCapture ()
void setFollowGameWorld (boolean bFollow)
boolean getIsFollowGameWorld ()
boolean isFollowGameWorld ()
void setRenderThisPlayerOnly (integer playerNum)
integer getRenderThisPlayerOnly ()
void onLoseJoypadFocus (JoypadData joypadData)
void onGainJoypadFocus (JoypadData joypadData)
void setJoypadFocused (boolean focused, JoypadData joypadData)
void setVisible (boolean bVisible)
UIElement getJavaObject ()
boolean getIsVisible ()
boolean isVisible ()
boolean isReallyVisible ()
void onJoypadDown (JoypadButton button, JoypadData joypadData)
void onJoypadButtonReleased (integer button, JoypadData joypadData)
void onJoypadDirUp (JoypadData joypadData)
void onJoypadDirDown (JoypadData joypadData)
void onJoypadDirLeft (JoypadData joypadData)
void onJoypadDirRight (JoypadData joypadData)
void onJoypadButtonReleased_Descendant (ISUIElement descendant, JoypadButton button, JoypadData joypadData)
void onJoypadDown_Descendant (ISUIElement descendant, JoypadButton button, JoypadData joypadData)
void onJoypadDirUp_Descendant (ISUIElement descendant, JoypadData joypadData)
void onJoypadDirDown_Descendant (ISUIElement descendant, JoypadData joypadData)
void onJoypadDirLeft_Descendant (ISUIElement descendant, JoypadData joypadData)
void onJoypadDirRight_Descendant (ISUIElement descendant, JoypadData joypadData)
void onJoypadBeforeDeactivate (JoypadData joypadData)
void onJoypadBeforeDeactivate_Descendant (ISUIElement descendant, JoypadData joypadData)
boolean hasConflictWithJoypadNavigateStart ()
number getJoypadNavigateStartDelay ()
void onJoypadNavigateStart (JoypadData joypadData)
void onJoypadNavigateEnd (JoypadData joypadData)
void onJoypadNavigateUp (JoypadData joypadData)
void onJoypadNavigateDown (JoypadData joypadData)
void onJoypadNavigateLeft (JoypadData joypadData)
void onJoypadNavigateRight (JoypadData joypadData)
void onJoypadNavigateParent (JoypadData joypadData)
void onJoypadNavigateStart_Descendant (ISUIElement descendant, JoypadData joypadData)
void renderJoypadFocus (number x, number y, number w, number h)
void renderJoypadNavigateOverlay (integer playerNum)
void renderJoypadNavigateCurrent (number x, number y, number w, number h)
void renderJoypadNavigateSelf ()
void renderJoypadNavigateHighlight (JoypadData joypadData, ISUIElement child)
void renderJoypadNavigateTexture (JoypadData joypadData, ISUIElement child, Texture texture)
boolean isDescendant (nil ui)
void instantiate ()
void createChildren ()
void drawTextureAllPoint (Texture|ISUITextureGetter texture, number tlx, number tly, number trx, number try, number brx, number bry, number blx, number bly, number r, number g, number b, number a)
void StartOutline (Texture tex, number outlineThickness, number r, number g, number b, number a)
void EndOutline ()
void drawTextureScaled (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number a, number r, number g, number b)
void drawSubTexture (Texture|ISUITextureGetter texture, number subX, number subY, number subW, number subH, number x, number y, number w, number h, number a, number r, number g, number b)
void drawTextureScaledUniform (Texture|ISUITextureGetter texture, number x, number y, number scale, number a, number r, number g, number b)
void drawTextureScaledAspect (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number a, number r, number g, number b)
void drawTextureScaledAspect2 (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number a, number r, number g, number b)
void drawTextureScaledAspect3 (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number a, number r, number g, number b)
void drawTexture (Texture|ISUITextureGetter texture, number x, number y, number a, number r, number g, number b)
void drawTextureTiled (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number r, number g, number b, number a)
void drawTextureTiledX (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number r, number g, number b, number a)
void drawTextureTiledY (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number r, number g, number b, number a)
void drawTextureTiledYOffset (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number r, number g, number b, number a)
void DrawTextureAngle (Texture|ISUITextureGetter texture, number centerX, number centerY, number angle)
void drawTextureScaledStatic (Texture|ISUITextureGetter texture, number x, number y, number w, number h, number a, number r, number g, number b)
void drawTextureStatic (Texture texture, number x, number y, number a, number r, number g, number b)
void drawItemIcon (InventoryItem item, number x, number y, number a, number w, number h)
void drawScriptItemIcon (Item scriptItem, number x, number y, number a, number w, number h)
void drawRect (number x, number y, number w, number h, number a, number r, number g, number b)
void drawRectBounds (ISBounds bounds, number a, number r, number g, number b)
void drawRectStatic (number x, number y, number w, number h, number a, number r, number g, number b)
void drawRectBorderStatic (number x, number y, number w, number h, number a, number r, number g, number b)
void drawRectBorder (number x, number y, number w, number h, number a, number r, number g, number b)
void drawLine2 (number x, number y, number x2, number y2, number a, number r, number g, number b)
void drawLine (Texture|ISUITextureGetter texture, number x, number y, number x2, number y2, number thickness, number a, number r, number g, number b)
void drawLineAbsolute (Texture|ISUITextureGetter texture, number x, number y, number x2, number y2, number thickness, number a, number r, number g, number b)
void drawPolygon (Texture tex, number x1, number y1, number x2, number y2, number x3, number y3, number x4, number y4, number r, number g, number b, number a)
void drawTextZoomed (string str, number x, number y, number zoom, number r, number g, number b, number a, UIFont font)
void drawTextUntrimmed (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void drawTextCentre (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void drawText (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void drawTextRight (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void setAlwaysOnTop (boolean b)
void drawTextStatic (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void drawTextCentreStatic (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void drawTextRightStatic (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void addToUIManager ()
void removeFromUIManager ()
void backMost ()
void addScrollBars (boolean addHorizontal)
void removeScrollBars ()
boolean isVScrollBarVisible ()
ISUIElement getParent ()
table< integer, ISUIElement > getChildren ()
ISUIElement[] getChildrenInOrder ()
integer numChildren ()
unknown visitAndAllDescendants (unknown param0, fun(target:unknown?, element:ISUIElement) visitor)
unknown visitAllDescendants (unknown param0, fun(target:unknown?, element:ISUIElement) visitor)
ISUIElement addChild (ISUIElement otherElement)
void removeChild (ISUIElement otherElement)
void clearChildren ()
void detachFromParent ()
boolean onMouseWheel (number del)
void onMouseUp (number x, number y)
void setOnMouseDoubleClick (unknown target, umbrella::ISUIElement::MouseDoubleClick onmousedblclick)
void onRightMouseUpOutside (number x, number y)
void onRightMouseDownOutside (number x, number y)
void onMouseUpOutside (number x, number y)
void onMouseDownOutside (number x, number y)
void onFocus (number x, number y)
void bringToTop ()
void onRightMouseUp (number x, number y)
void onRightMouseDown (number x, number y)
void onMouseMove (number dx, number dy)
void onMouseMoveOutside (number dx, number dy)
boolean containsPoint (number x, number y)
boolean containsPointLocal (number x, number y)
void shrinkY (number y)
void shrinkX (number x)
void update ()
void prerender ()
void render ()
void setScrollWidth (number w)
void setScrollHeight (number h)
number getScrollWidth ()
number getScrollHeight ()
void setScrollChildren (boolean b)
boolean getScrollChildren ()
void setScrollWithParent (boolean b)
boolean getScrollWithParent ()
void setYScroll (number y)
void updateScrollbars ()
void setXScroll (number x)
number getScrollAreaWidth ()
number getScrollAreaHeight ()
ISCollapsableWindow wrapInCollapsableWindow (string title, boolean resizable, ISCollapsableWindow subClass)
boolean isRemoved ()
void setRemoved (boolean bremove)
void setUIName (string name)
string getUIName (string name)
string toString ()
string tostring ()
void drawProgressBar (number x, number y, number w, number h, number f, umbrella::RGBA fg)
void stayOnSplitScreen (integer playerNum)
void setWantKeyEvents (boolean want)
void setWantMouseEvents (boolean want)
boolean isWantMouseEvents ()
void setWantExtraMouseEvents (boolean want)
void setForceCursorVisible (boolean force)
number getMaxWidthOfElements (ISUIElement ...)
number setElementWidthToMaxOf (ISUIElement ...)
void shrinkWrap (number padRight, number padBottom, umbrella::ISUIElement::ShrinkWrapPredicate predicate)
void centerOnScreen (integer playerNum)
string toDebugString ()
string toTypeNameString ()
string toPathString ()
void debugPrintTree (string indent)
ISStyle getStyle ()
 ISUIElement (number x, number y, number width, number height)
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 ()

Public Attributes

UIWorldMapV1 mapAPI
ISWorldMapSymbols symbolsUI
ISWorldMapKey mapKey
ISButton ok
ISButton showMapKey
ISButton editSymbolsBtn
ISButton scaleBtn
ISButton placeSymbBtn
ISButton revealBtn
number draggingStartingX
number draggingStartingY
number dragStartCX
number dragStartCY
number dragStartZoomF
number dragStartWorldX
number dragStartWorldY
boolean dragging
boolean dragMoved
boolean getJoypadFocus
number joypadPromptHgt
boolean setMapData
number updateMS
number LBumperZoom
number RBumperZoom
number povXms
number povYms
IsoPlayer character
integer playerNum
MapItem mapObj
Texture textCursor
Texture cross
table symbolTexList
UIWorldMap javaObject
Public Attributes inherited from ISPanelJoypad
ISButton[] joypadButtons
integer joypadIndexY
integer joypadIndex
ISButton[][] joypadButtonsY
table allJoypadButtons
boolean background
ISButton ISButtonA
ISButton ISButtonB
ISButton ISButtonY
ISButton ISButtonX
ISBounds lastProjectedBounds
ISBounds[] lastIntercepts
boolean moving
number downX
number downY
boolean mouseOver
umbrella::RGBA backgroundColor
umbrella::RGBA borderColor
boolean moveWithMouse
Public Attributes inherited from ISUIElement
table< integer, ISUIElement > children
ISUIElement[] childrenInOrder
integer ID
integer controller
boolean anchorBottom
boolean anchorTop
boolean anchorLeft
boolean anchorRight
number x
number y
number width
number height
boolean enabled
number minimumWidth
number minimumHeight
boolean joypadFocused
umbrella::XYWH joypadNavigatePrevRect
umbrella::ISUIElement::JoypadNavigateTransition joypadNavigateTransition
UIElement javaObject
boolean removed
ISScrollBar vscroll
ISScrollBar hscroll
umbrella::ISUIElement::MouseDoubleClick onMouseDoubleClick
unknown target
number scrollwidth
boolean wantKeyEvents
boolean wantMouseEvents
boolean wantExtraMouseEvents
boolean forceCursorVisible
string name
string creationCallStack
string dock
function onDoLayout
GameOption gameOption
number contentHorizontalAlignment
ISStyle style
boolean autoAddJoypadButton
umbrella::JoypadNavigate joypadNavigate
boolean ignoreAim
string internal
ISUIElement parent
boolean overrideBPrompt
Public Attributes inherited from ISBaseObject
string Type
ISBaseObject SuperType
table< string, table< function, unknown > > __eventListeners

Additional Inherited Members

Static Public Member Functions inherited from ISPanelJoypad
static string rowListToDebugString (ISUIElement[] list)
static ISUIElement[] autoGenerateJoypadButtonRowsFromUIElement (ISUIElement uiRootElement)
static boolean autoAddUIElementToJoypadButtons (ISUIElement[] allJoypadButtons, ISUIElement uiElement)
static ISUIElement[] getVisibleElements (ISUIElement[] uiElements)

Constructor & Destructor Documentation

◆ ISMap()

ISMap::ISMap ( number x,
number y,
number width,
number height,
MapItem map,
integer player )

Member Function Documentation

◆ canErase()

boolean ISMap::canErase ( )

◆ canWrite()

boolean ISMap::canWrite ( )

◆ copySymbolsToWorldMap()

void ISMap::copySymbolsToWorldMap ( )

◆ createChildren()

void ISMap::createChildren ( )

◆ destroy()

void ISMap::destroy ( )

◆ initMapData()

void ISMap::initMapData ( )

◆ instantiate()

void ISMap::instantiate ( )

◆ onButtonClick()

void ISMap::onButtonClick ( ISButton button)

◆ onConfirmRemove()

void ISMap::onConfirmRemove ( ISButton button,
integer note )

◆ onGainJoypadFocus()

void ISMap::onGainJoypadFocus ( JoypadData joypadData)

◆ onJoypadDown()

void ISMap::onJoypadDown ( JoypadButton button,
JoypadData joypadData )

◆ onMouseDown()

boolean ISMap::onMouseDown ( number x,
number y )

◆ onMouseMove()

boolean ISMap::onMouseMove ( number dx,
number dy )

◆ onMouseMoveOutside()

void ISMap::onMouseMoveOutside ( number dx,
number dy )

◆ onMouseUp()

boolean ISMap::onMouseUp ( number x,
number y )

◆ onMouseUpOutside()

void ISMap::onMouseUpOutside ( )

◆ onMouseWheel()

boolean ISMap::onMouseWheel ( number del)

◆ onRightMouseDown()

boolean ISMap::onRightMouseDown ( number x,
number y )

◆ prerender()

void ISMap::prerender ( )

◆ render()

void ISMap::render ( )

◆ renderButtonTextureAndText()

number ISMap::renderButtonTextureAndText ( Texture texture,
string text,
number x,
number y )

◆ renderJoypadIcons()

void ISMap::renderJoypadIcons ( )

◆ revealOnWorldMap()

void ISMap::revealOnWorldMap ( )

◆ update()

void ISMap::update ( )

◆ updateButtons()

void ISMap::updateButtons ( )

◆ updateJoypad()

void ISMap::updateJoypad ( )

Member Data Documentation

◆ character

IsoPlayer ISMap::character

◆ cross

Texture ISMap::cross

◆ dragging

boolean ISMap::dragging

◆ draggingStartingX

number ISMap::draggingStartingX

◆ draggingStartingY

number ISMap::draggingStartingY

◆ dragMoved

boolean ISMap::dragMoved

◆ dragStartCX

number ISMap::dragStartCX

◆ dragStartCY

number ISMap::dragStartCY

◆ dragStartWorldX

number ISMap::dragStartWorldX

◆ dragStartWorldY

number ISMap::dragStartWorldY

◆ dragStartZoomF

number ISMap::dragStartZoomF

◆ editSymbolsBtn

ISButton ISMap::editSymbolsBtn

◆ getJoypadFocus

boolean ISMap::getJoypadFocus

◆ javaObject

UIWorldMap ISMap::javaObject

◆ joypadPromptHgt

number ISMap::joypadPromptHgt

◆ LBumperZoom

number ISMap::LBumperZoom

◆ mapAPI

UIWorldMapV1 ISMap::mapAPI

◆ mapKey

ISWorldMapKey ISMap::mapKey

◆ mapObj

MapItem ISMap::mapObj

◆ ok

ISButton ISMap::ok

◆ placeSymbBtn

ISButton ISMap::placeSymbBtn

◆ playerNum

integer ISMap::playerNum

◆ povXms

number ISMap::povXms

◆ povYms

number ISMap::povYms

◆ RBumperZoom

number ISMap::RBumperZoom

◆ revealBtn

ISButton ISMap::revealBtn

◆ scaleBtn

ISButton ISMap::scaleBtn

◆ setMapData

boolean ISMap::setMapData

◆ showMapKey

ISButton ISMap::showMapKey

◆ symbolsUI

ISWorldMapSymbols ISMap::symbolsUI

◆ symbolTexList

table ISMap::symbolTexList

◆ textCursor

Texture ISMap::textCursor

◆ updateMS

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