CorsixTH Lua Documentation

The following table gives all classes present in the source code, in alphabetical order, along with short descriptions.
AIHospital
AnimationManager Utility class for setting animation markers and querying animation length.
App
Audio Layer which handles the Lua-facing side of loading and playing audio.
BloodMachineRoom
Button A region of a `Panel` which causes some action when clicked.
CardiogramRoom
DecontaminationRoom
DirTreeNode A tree node representing a directory in the physical file-system
Door
DummyRootNode A tree node which can be used as a root node to give the effect of having multiple root nodes.
ElectrolysisRoom
Entity Abstraction for visible gameplay things which sit somewhere on the map.
EntranceDoor
FileSystem Layer for abstracting away differences in file systems
FractureRoom
GPRoom
GameUI Variant of UI for running games
GeneralDiagRoom
Graphics Layer for loading (and subsequently caching) graphical resources.
HairRestorationRoom
Helicopter An `Object` which drops of emergency patients.
Hospital
Humanoid An `Entity` which occupies a single tile and is capable of moving around the map.
InflationRoom
JellyVatRoom
Litter
Machine An `Object` which needs occasional repair (to prevent explosion).
Map Lua extensions to the C++ THMap class
Object An `Entity` which occupies at least a single map tile and does not move.
Panel The basic component which makes up most `Window`s.
Patient A `Humanoid` who is in the hospital for diagnosis and/or treatment.
PharmacyRoom
Plant An `Object` which needs watering now and then.
PsychRoom
Queue Manages a list of `Humanoid`s which are waiting to use an `Object`.
ReceptionDesk
Room
ScannerRoom Handyman is called to "diagnosis machine", all other diagnosis rooms have their own, more specific handyman call though room.handyman_call_sound = "maint011.wav"
Scrollbar A window element used to scroll in lists
SlackTongueRoom
Staff A Doctor, Nurse, Receptionist, Handyman, or Surgeon
StaffProfile
StaffRoom
Strings Layer which handles the loading of localised text.
SwingDoor
Textbox A window element used to enter text
ToiletRoom
TrainingRoom
TreeControl A control (to be placed on a window) which allows the user to navigate a tree of items and select one item from it.
TreeNode Iterface for items within a UI tree control
UI Top-level container for all other user-interface components.
UIAdviser The (ideally) helpful advisor who pops up from the bottom dialog during a game.
UIBankManager Bank manager (for loans / insurance companies) and bank statement fullscreen windows.
UIBottomPanel The multi-purpose panel for launching dialogs / screens and dynamic information.
UIBuildRoom
UICasebook Drug Casebook fullscreen window (view disease statistics and set prices).
UIConfirmDialog Dialog for "Are you sure you want to quit?" and similar yes/no questions.
UICustomGame Custom Game Window
UIDirBrowser Prompter for Theme Hospital install directory
UIEditRoom
UIFax
UIFullscreen Base class for 640x480px dialogs (fullscreen in original game resolution).
UIFurnishCorridor Dialog for purchasing `Object`s (for the corridor or for rooms).
UIHireStaff
UIInformation Dialog that informs the player of for example what the goals for the level are.
UIJukebox
UILoadGame Load Game Window
UIMachine
UIMainMenu Class for main menu window.
UIMenu
UIMenuBar The ingame menu bar which sits (nominally hidden) at the top of the screen.
UIMenuList A menu list with a scrollbar. Used by load_game, save_game and custom_game.
UIMessage Small fax notification window which sits on the bottom bar.
UIOptions Options window used in the main menu and ingame.
UIPatient Individual patient information dialog
UIPlaceObjects The dialog shown when placing objects.
UIPlaceStaff Invisible window which handles placing a `Staff` member in the world.
UIPolicy Hospital policy fullscreen window (set staff tiredness and patient cure thresholds, etc.).
UIProgressReport Progress Report fullscreen window (check level goals, competitors and alerts).
UIQueue Room / door / reception desk queue visualisation dialog.
UIResizable Class for resizable windows.
UISaveGame Save Game Window
UIStaff Individual staff information dialog
UIStaffManagement Staff management screen
UIStaffRise Dialog for staff member requesting a salaray raise.
UITipOfTheDay Tip of the Day Window
UITownMap Town map fullscreen window (purchase land, set radiator levels, map overview).
UIWatch Timer / clock / watch / countdown dialog for emergencies / level start
UltrascanRoom
WardRoom
Window Base class for user-interface dialogs.
World
XRayRoom
Page generated on Thu Jun 24, 2010 at 02:46:54 by LDocGen.