The lua files of the CorsixTH game

A reimplementation of the 1997 Bullfrog business sim Theme Hospital. As well as faithfully recreating the original, CorsixTH adds support for modern operating systems (Windows, macOS, Linux and BSD), high resolutions and much more.

Libraries

CorsixTH.CorsixTH.Lua.announcer Creates an announcement queue: a collection of announcements with queue semantics.
CorsixTH.CorsixTH.Lua.app Core function.
CorsixTH.CorsixTH.Lua.audio Layer which handles the Lua-facing side of loading and playing audio.
CorsixTH.CorsixTH.Lua.base_config New configuration values added in CorsixTH --
CorsixTH.CorsixTH.Lua.calls_dispatcher Called when a call is completed successfully.
CorsixTH.CorsixTH.Lua.cheats A holder for all cheats in the game
CorsixTH.CorsixTH.Lua.dialogs.adviser The (ideally) helpful advisor who pops up from the bottom dialog during a game.
CorsixTH.CorsixTH.Lua.dialogs.bottom_panel The multi-purpose panel for launching dialogs / screens and dynamic information.
CorsixTH.CorsixTH.Lua.dialogs.build_room Checks what rooms are now available to build
CorsixTH.CorsixTH.Lua.dialogs.confirm_dialog Dialog for "Are you sure you want to quit?" and similar yes/no questions.
CorsixTH.CorsixTH.Lua.dialogs.edit_room Check walls for having room for the door
CorsixTH.CorsixTH.Lua.dialogs.fullscreen Base class for 640x480px dialogs (fullscreen in original game resolution).
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.annual_report Annual Report fullscreen window shown at the start of each year.
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.bank_manager Bank manager (for loans / insurance companies) and bank statement fullscreen windows.
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.drug_casebook Drug Casebook fullscreen window (view disease statistics and set prices).
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.fax Faxes pause the game.
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.graphs Charts fullscreen window
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.hospital_policy Hospital policy fullscreen window (set staff tiredness and patient cure thresholds, etc.).
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.progress_report Progress Report fullscreen window (check level goals, competitors and alerts).
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.staff_management Staff management screen
CorsixTH.CorsixTH.Lua.dialogs.fullscreen.town_map Town map fullscreen window (purchase land, set radiator levels, map overview).
CorsixTH.CorsixTH.Lua.dialogs.furnish_corridor Dialog for purchasing `Object`s (for the corridor or for rooms).
CorsixTH.CorsixTH.Lua.dialogs.information Dialog that informs the player of for example what the goals for the level are.
CorsixTH.CorsixTH.Lua.dialogs.machine_dialog Function checks we can afford a new machine then offers player to purchase.
CorsixTH.CorsixTH.Lua.dialogs.menu The ingame menu bar which sits (nominally hidden) at the top of the screen.
CorsixTH.CorsixTH.Lua.dialogs.message Small fax notification window which sits on the bottom bar.
CorsixTH.CorsixTH.Lua.dialogs.patient Individual patient information dialog
CorsixTH.CorsixTH.Lua.dialogs.place_objects The dialog shown when placing objects.
CorsixTH.CorsixTH.Lua.dialogs.place_staff Invisible window which handles placing a `Staff` member in the world.
CorsixTH.CorsixTH.Lua.dialogs.queue_dialog Room / door / reception desk queue visualisation dialog.
CorsixTH.CorsixTH.Lua.dialogs.resizable Class for resizable windows.
CorsixTH.CorsixTH.Lua.dialogs.resizables.calls_dispatcher Calls Dispatcher Window
CorsixTH.CorsixTH.Lua.dialogs.resizables.cheats_dialog A dialog for activating cheats
CorsixTH.CorsixTH.Lua.dialogs.resizables.customise Customise window used in the main menu and ingame.
CorsixTH.CorsixTH.Lua.dialogs.resizables.directory_browser A tree node representing a directory in the physical file-system.
CorsixTH.CorsixTH.Lua.dialogs.resizables.dropdown Dropdown "window" used for selection of one item from a list.
CorsixTH.CorsixTH.Lua.dialogs.resizables.file_browser A tree node representing a file (or directory) in the physical file-system that meets a given file extension criterion.
CorsixTH.CorsixTH.Lua.dialogs.resizables.file_browsers.choose_font Window where the user can choose a font file.
CorsixTH.CorsixTH.Lua.dialogs.resizables.file_browsers.load_game Load Game Window
CorsixTH.CorsixTH.Lua.dialogs.resizables.file_browsers.load_map Load Map Window
CorsixTH.CorsixTH.Lua.dialogs.resizables.file_browsers.save_game Save Game Window
CorsixTH.CorsixTH.Lua.dialogs.resizables.file_browsers.save_map Save Map Window
CorsixTH.CorsixTH.Lua.dialogs.resizables.folder_settings Customise window used in the main menu and ingame.
CorsixTH.CorsixTH.Lua.dialogs.resizables.hotkey_assign Custom key bindings
CorsixTH.CorsixTH.Lua.dialogs.resizables.lua_console Interactive Lua Console for ingame debugging.
CorsixTH.CorsixTH.Lua.dialogs.resizables.main_menu Class for main menu window.
CorsixTH.CorsixTH.Lua.dialogs.resizables.map_editor Decide the highest possible placement for 'width' columns.
CorsixTH.CorsixTH.Lua.dialogs.resizables.menu_list_dialog A menu list with a scrollbar.
CorsixTH.CorsixTH.Lua.dialogs.resizables.menu_list_dialogs.custom_campaign Custom Campaign Window
CorsixTH.CorsixTH.Lua.dialogs.resizables.menu_list_dialogs.custom_game Custom Game Window
CorsixTH.CorsixTH.Lua.dialogs.resizables.new_game Class for the difficulty choice window.
CorsixTH.CorsixTH.Lua.dialogs.resizables.options Options window used in the main menu and ingame.
CorsixTH.CorsixTH.Lua.dialogs.resizables.tip_of_the_day Tip of the Day Window
CorsixTH.CorsixTH.Lua.dialogs.resizables.update Options window used in the main menu and ingame.
CorsixTH.CorsixTH.Lua.dialogs.staff_dialog Individual staff information dialog
CorsixTH.CorsixTH.Lua.dialogs.staff_rise Dialog for staff member requesting a salaray raise.
CorsixTH.CorsixTH.Lua.dialogs.tree_ctrl Interface for items within a UI tree control
CorsixTH.CorsixTH.Lua.dialogs.watch Timer / clock / watch / countdown dialog for emergencies / level start The timer lasts approximately 100 days, split into 13 segments
CorsixTH.CorsixTH.Lua.entities.humanoid An `Entity` which occupies a single tile and is capable of moving around the map.
CorsixTH.CorsixTH.Lua.entities.humanoids.patient A `Humanoid` who is in the hospital for diagnosis and/or treatment.
CorsixTH.CorsixTH.Lua.entities.humanoids.staff A Doctor, Nurse, Receptionist, Handyman, or Surgeon
CorsixTH.CorsixTH.Lua.entities.humanoids.staff.doctor A Doctor (Researcher, Surgeon, Psychologist).
CorsixTH.CorsixTH.Lua.entities.humanoids.staff.handyman The third class of staff.
CorsixTH.CorsixTH.Lua.entities.humanoids.staff.nurse The second class of staff.
CorsixTH.CorsixTH.Lua.entities.humanoids.staff.receptionist The fourth class of staff.
CorsixTH.CorsixTH.Lua.entities.humanoids.vip ]]
CorsixTH.CorsixTH.Lua.entities.machine An `Object` which needs occasional repair (to prevent explosion).
CorsixTH.CorsixTH.Lua.entities.object An `Entity` which occupies at least a single map tile and does not move.
CorsixTH.CorsixTH.Lua.entity Abstraction for visible gameplay things which sit somewhere on the map.
CorsixTH.CorsixTH.Lua.filesystem Layer for abstracting away differences in file systems.
CorsixTH.CorsixTH.Lua.game_ui Variant of UI for running games
CorsixTH.CorsixTH.Lua.graphics Layer for loading (and subsequently caching) graphical resources.
CorsixTH.CorsixTH.Lua.hospital Checks if a room has been discovered
CorsixTH.CorsixTH.Lua.hospitals.player_hospital Give advice to the player at the end of a day.
CorsixTH.CorsixTH.Lua.humanoid_action Humanoid action base class.
CorsixTH.CorsixTH.Lua.humanoid_actions.die
CorsixTH.CorsixTH.Lua.humanoid_actions.idle Set the direction of facing while standing idle.
CorsixTH.CorsixTH.Lua.humanoid_actions.knock_door Constructor for knocking on the door action.
CorsixTH.CorsixTH.Lua.humanoid_actions.multi_use_object Construct a multi-use object action.
CorsixTH.CorsixTH.Lua.humanoid_actions.queue Queue for something (door or reception desk).
CorsixTH.CorsixTH.Lua.humanoid_actions.seek_room Find another room (and go to it).
CorsixTH.CorsixTH.Lua.humanoid_actions.spawn Spawn an entity.
CorsixTH.CorsixTH.Lua.humanoid_actions.use_object Construct a 'use object' action.
CorsixTH.CorsixTH.Lua.humanoid_actions.use_screen Action to use the screen.
CorsixTH.CorsixTH.Lua.humanoid_actions.walk Action to walk to a given position.
CorsixTH.CorsixTH.Lua.map Lua extensions to the C++ THMap class
CorsixTH.CorsixTH.Lua.movie_player Layer which handles the Lua-facing side of loading and playing video.
CorsixTH.CorsixTH.Lua.objects.bench This function is automatically called after loading a game and serves for compatibility.
CorsixTH.CorsixTH.Lua.objects.chair This function is automatically called after loading a game and serves for compatibility.
CorsixTH.CorsixTH.Lua.objects.door Updates a door's dynamic info
CorsixTH.CorsixTH.Lua.objects.helicopter An `Object` which drops off emergency patients.
CorsixTH.CorsixTH.Lua.objects.litter Remove the litter from the world.
CorsixTH.CorsixTH.Lua.objects.plant An `Object` which needs watering now and then.
CorsixTH.CorsixTH.Lua.objects.reception_desk Handle a patient at the reception desk.
CorsixTH.CorsixTH.Lua.persistance Save a game to disk.
CorsixTH.CorsixTH.Lua.queue Manages a list of `Humanoid`s which are waiting to use an `Object`.
CorsixTH.CorsixTH.Lua.research_department Manages all things related to research for one hospital.
CorsixTH.CorsixTH.Lua.room Get the tile next to the door.
CorsixTH.CorsixTH.Lua.rooms.operating_theatre Returns true if an operation is ongoing
CorsixTH.CorsixTH.Lua.run_debugger This script is responsible for starting a DBGp client for CorsixTH's Lua scripts and then connecting this to a running DBGp server.
CorsixTH.CorsixTH.Lua.staff_profile Give the staff member some personal properties.
CorsixTH.CorsixTH.Lua.strict ! Wrap a function so that it is freely able to set global variables [[ Some existing functions (for example, `require`) should be allowed to read
CorsixTH.CorsixTH.Lua.string_extensions Custom format function for our proxy strings.
CorsixTH.CorsixTH.Lua.strings Layer which handles the loading of localised text.
CorsixTH.CorsixTH.Lua.ui Top-level container for all other user-interface components.
CorsixTH.CorsixTH.Lua.utility Find the smallest bucket with its upper value less or equal to a given number, and return the value of the bucket, or its index.
CorsixTH.CorsixTH.Lua.window Base class for user-interface dialogs.
CorsixTH.CorsixTH.Lua.world Manages entities, rooms, and the date.

Manual

Readme.md
generated by LDoc TESTING Last updated 2015-01-01 12:00:00