UIEditRoom Class
Inheritance: UIEditRoom » UIPlaceObjects » Window
Method Index
- abortRoom()
- addBevelPanel(x, y, w, h, colour, highlight_colour, shadow_colour, disabled_colour) (inherited from Window)
- addColourPanel(x, y, w, h, r, g, b) (inherited from Window)
- addKeyHandler(key, handler, ...) (inherited from Window)
- addObjects(object_list, pay_for) (inherited from UIPlaceObjects)
- addPanel(sprite_index, x, y, w, h) (inherited from Window)
- addWindow(window) (inherited from Window)
- afterLoad(old, new) (inherited from Window)
- beginDrag(x, y) (inherited from Window)
- bringToTop() (inherited from Window)
- calculateBestPlacementPosition(x, y) (inherited from UIPlaceObjects)
- cancel() (overrides UIPlaceObjects:cancel)
- checkEnableConfirm()
- checkReachability()
- clearArea()
- clearBlueprint() (inherited from UIPlaceObjects)
- close(...) (overrides UIPlaceObjects:close)
- computeAverageContents()
- confirm(force) (overrides UIPlaceObjects:confirm)
- draw(canvas, ...) (overrides UIPlaceObjects:draw)
- enterDoorPhase()
- enterObjectsPhase()
- enterWindowsPhase()
- finishRoom()
- getSavedWindowPositionName() (inherited from Window)
- getTooltipAt(x, y) (inherited from Window)
- getTooltipForElement(elem, x, y) (inherited from Window)
- getWindow(window_class) (inherited from Window)
- getWindows(window_class) (inherited from Window)
- hitTest(x, y) (inherited from Window)
- hitTestPanel(x, y, panel) (inherited from Window)
- isHumanoidObscuringArea(entity, x1, x2, y1, y2)
- makeButtonOnPanel(panel, x, y, w, h, sprite, on_click, on_click_self, on_rightclick) (inherited from Window)
- makeDynamicTooltip(callback, x, y, r, b, tooltip_x, tooltip_y) (inherited from Window)
- makeScrollbarOnPanel(panel, slider_colour, callback, min_value, max_value, page_size, value) (inherited from Window)
- makeTextboxOnPanel(panel, confirm_callback, abort_callback) (inherited from Window)
- makeTooltip(text, x, y, r, b, tooltip_x, tooltip_y) (inherited from Window)
- nextOrientation() (inherited from UIPlaceObjects)
- onChangeLanguage() (inherited from Window)
- onChangeResolution() (inherited from Window)
- onCursorWorldPositionChange(x, y) (overrides UIPlaceObjects:onCursorWorldPositionChange)
- onMouseDown(button, x, y) (overrides Window:onMouseDown)
- onMouseMove(x, y, ...) (overrides Window:onMouseMove)
- onMouseUp(button, x, y) (overrides UIPlaceObjects:onMouseUp)
- onTick() (overrides Window:onTick)
- onWorldTick() (inherited from Window)
- pickupItems() (overrides UIPlaceObjects:pickupItems)
- placeObject() (overrides UIPlaceObjects:placeObject)
- placeWindowBlueprint()
- purchaseItems() (overrides UIPlaceObjects:purchaseItems)
- removeAllObjects(refund) (inherited from UIPlaceObjects)
- removeAllPanels() (inherited from Window)
- removeObject(object, dont_close_if_empty, refund) (inherited from UIPlaceObjects)
- removeObjects(object_list, refund) (inherited from UIPlaceObjects)
- removeWindow(window) (inherited from Window)
- resize(num_slots) (inherited from UIPlaceObjects)
- returnToDoorPhase()
- returnToWallPhase(early)
- screenToWall(x, y)
- selectObjectType(object_type) (inherited from UIPlaceObjects)
- sendToBottom(window) (inherited from Window)
- sendToTop(window) (inherited from Window)
- setActiveIndex(index) (inherited from UIPlaceObjects)
- setBlueprintCell(x, y) (inherited from UIPlaceObjects)
- setBlueprintRect(x, y, w, h)
- setDefaultPosition(x, y) (inherited from Window)
- setDoorBlueprint(x, y, wall)
- setOrientation(orient) (inherited from UIPlaceObjects)
- setPosition(x, y) (inherited from Window)
- setWindowBlueprint(x, y, wall)
- startButtonBlinking(button_index) (inherited from Window)
- stopButtonBlinking() (inherited from Window)
- stopPickupItems()
- tryNextOrientation() (inherited from UIPlaceObjects)
- verifyOrAbortRoom()
Member Index
- active_button (*)
- active_index
- active_scrollbar (*)
- anims
- blink_counter (*)
- blinking_button (*)
- blue_font (*)
- blueprint_door
- blueprint_rect
- blueprint_wall_anims
- blueprint_window
- btn_repeat_delay (*)
- buttons (*)
- buttons_down (*)
- cell_outline
- check_for_clear_area_timer
- closed (*)
- closed_cleanly
- confirm_button
- confirm_dialog_open
- default_button_sound (*)
- desc_text
- draggable (*)
- dragging (*)
- height
- humanoids_to_watch
- in_pickup_mode
- key_handlers (*)
- list_header (*)
- map (*)
- modal_class (*)
- mouse_cell_x
- mouse_cell_y
- mouse_down_x
- mouse_down_y
- move_rect
- move_rect_x
- move_rect_y
- num_slots (*)
- object_anim (*)
- object_blueprint_good (*)
- object_cell_x
- object_cell_y
- object_footprint (*)
- object_orientation (*)
- object_slave_anim (*)
- objects
- objects_backup
- paid
- panel_sprites (*)
- panels (*)
- parent (*)
- phase
- pickup_button
- place_objects
- purchase_button
- resize_rect
- room
- room_type
- scrollbars (*)
- textboxes (*)
- title_text
- tooltip_regions (*)
- ui
- visible
- white_font (*)
- width
- windows (*)
- world
- x
- x_original (*)
- y
- y_original (*)
function UIEditRoom:UIEditRoom(ui, room_type)
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | ? | ? |
| room_type | ? | ? |
Declared on: line 29 of Lua/dialogs/edit_room.lua.
function UIEditRoom:cancel()
Overrides: UIPlaceObjects:cancel.
Declared on: line 161 of Lua/dialogs/edit_room.lua.
function UIEditRoom:checkEnableConfirm()
checks if all required objects are placed, and enables/disables the confirm button accordingly.
also returns the new state of the confirm button
Declared on: line 1377 of Lua/dialogs/edit_room.lua.
function UIEditRoom:checkReachability()
Function to check if the tiles adjacent to the room are still reachable from each other.
NB: the passable flags of the room have to be set to false already before calling this function
Declared on: line 770 of Lua/dialogs/edit_room.lua.
function UIEditRoom:close(...)
Parameters:
| Name | Type | Description |
|---|---|---|
| ... | ? | ? |
Overrides: UIPlaceObjects:close.
Declared on: line 92 of Lua/dialogs/edit_room.lua.
function UIEditRoom:computeAverageContents()
Decide contents of the new room based on average content of previous built rooms
of the same type.
Declared on: line 893 of Lua/dialogs/edit_room.lua.
function UIEditRoom:confirm(force)
Parameters:
| Name | Type | Description |
|---|---|---|
| force | ? | ? |
Overrides: UIPlaceObjects:confirm.
Declared on: line 200 of Lua/dialogs/edit_room.lua.
function UIEditRoom:draw(canvas, ...)
Parameters:
| Name | Type | Description |
|---|---|---|
| canvas | ? | ? |
| ... | ? | ? |
Overrides: UIPlaceObjects:draw.
Declared on: line 928 of Lua/dialogs/edit_room.lua.
function UIEditRoom:isHumanoidObscuringArea(entity, x1, x2, y1, y2)
Parameters:
| Name | Type | Description |
|---|---|---|
| entity | ? | ? |
| x1 | ? | ? |
| x2 | ? | ? |
| y1 | ? | ? |
| y2 | ? | ? |
Declared on: line 253 of Lua/dialogs/edit_room.lua.
function UIEditRoom:onCursorWorldPositionChange(x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
Overrides: UIPlaceObjects:onCursorWorldPositionChange.
Declared on: line 1279 of Lua/dialogs/edit_room.lua.
function UIEditRoom:onMouseDown(button, x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
| button | ? | ? |
| x | ? | ? |
| y | ? | ? |
Overrides: Window:onMouseDown.
Declared on: line 944 of Lua/dialogs/edit_room.lua.
function UIEditRoom:onMouseMove(x, y, ...)
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
| ... | ? | ? |
Overrides: Window:onMouseMove.
Declared on: line 991 of Lua/dialogs/edit_room.lua.
function UIEditRoom:onMouseUp(button, x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
| button | ? | ? |
| x | ? | ? |
| y | ? | ? |
Overrides: UIPlaceObjects:onMouseUp.
Declared on: line 977 of Lua/dialogs/edit_room.lua.
function UIEditRoom:onTick()
Overrides: Window:onTick.
Declared on: line 343 of Lua/dialogs/edit_room.lua.
function UIEditRoom:pickupItems()
callback for item pick up button
Overrides: UIPlaceObjects:pickupItems.
Declared on: line 534 of Lua/dialogs/edit_room.lua.
function UIEditRoom:placeObject()
Overrides: UIPlaceObjects:placeObject.
Declared on: line 1409 of Lua/dialogs/edit_room.lua.
function UIEditRoom:purchaseItems()
Overrides: UIPlaceObjects:purchaseItems.
Declared on: line 496 of Lua/dialogs/edit_room.lua.
function UIEditRoom:returnToWallPhase(early)
Parameters:
| Name | Type | Description |
|---|---|---|
| early | ? | ? |
Declared on: line 557 of Lua/dialogs/edit_room.lua.
function UIEditRoom:screenToWall(x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
Declared on: line 672 of Lua/dialogs/edit_room.lua.
function UIEditRoom:setBlueprintRect(x, y, w, h)
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
| w | ? | ? |
| h | ? | ? |
Declared on: line 997 of Lua/dialogs/edit_room.lua.
function UIEditRoom:setDoorBlueprint(x, y, wall)
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
| wall | ? | ? |
Declared on: line 1051 of Lua/dialogs/edit_room.lua.
function UIEditRoom:setWindowBlueprint(x, y, wall)
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
| wall | ? | ? |
Declared on: line 1212 of Lua/dialogs/edit_room.lua.
function UIEditRoom:verifyOrAbortRoom()
Called when building/editing of the room is about to stop because another
dialog is being opened. If the room is in the objects phase and all
required objects have been placed it will be completed. Otherwise
it is cancelled instead.
--
Declared on: line 120 of Lua/dialogs/edit_room.lua.