CorsixTH Lua Documentation

function Hospital:Hospital(world, name)

Parameters:

Declared on: line 23 of Lua/hospital.lua.

function Hospital:addHandymanTask(object, taskType, priority, x, y, call)

Parameters:

Declared on: line 1582 of Lua/hospital.lua.

function Hospital:addInsuranceMoney(company, amount)

Parameters:

Declared on: line 1369 of Lua/hospital.lua.

function Hospital:addPatient(patient)

Parameters:

Declared on: line 1399 of Lua/hospital.lua.

function Hospital:addStaff(staff)

Parameters:

Declared on: line 1393 of Lua/hospital.lua.

function Hospital:afterLoad(old, new)

Parameters:

Declared on: line 339 of Lua/hospital.lua.

function Hospital:assignHandymanToTask(handyman, taskIndex, taskType)

Parameters:

Declared on: line 1623 of Lua/hospital.lua.

function Hospital:boilerBreakdown()

Called when the hospitals's boiler has broken down. It will remain broken for a certain period of time.

Declared on: line 849 of Lua/hospital.lua.

function Hospital:boilerFixed()

When the boiler has been repaired this function is called.

Declared on: line 870 of Lua/hospital.lua.

function Hospital:canConcentrateResearch(disease)

Function that returns true if concentrating research on the disease is possible.

@param disease (string): the disease to be checked.

Parameters:

Declared on: line 1749 of Lua/hospital.lua.

function Hospital:cashLow()

Remind the player when cash is low that a loan might be available

Declared on: line 319 of Lua/hospital.lua.

function Hospital:changeReputation(reason, disease, valueChange)

Normally reputation is changed based on a reason, and the affected

disease also has its own reputation meter.

Parameters:

Declared on: line 1477 of Lua/hospital.lua.

function Hospital:checkDiseaseRequirements(disease)

i.e. a list of rooms (ordered the same as disease.treatment_rooms), and a set of humanoid_classes with

the needed amount of that class as the value

Parameters:

Declared on: line 1529 of Lua/hospital.lua.

function Hospital:checkFacilities()

A range of checks to help a new player. These are set days apart and will show no more than once a month

Declared on: line 625 of Lua/hospital.lua.

function Hospital:coldWarning()

Declared on: line 833 of Lua/hospital.lua.

function Hospital:countPatients()

Declared on: line 611 of Lua/hospital.lua.

function Hospital:createEmergency(emergency)

Creates complete emergency with patients, what disease they have, what's needed to cure them and the fax.

Parameters:

Declared on: line 1117 of Lua/hospital.lua.

function Hospital:createVip()

Creates VIP

Declared on: line 1228 of Lua/hospital.lua.

function Hospital:findHandymanTaskSubtable(taskType)

Parameters:

Declared on: line 1609 of Lua/hospital.lua.

function Hospital:getAveragePatientAttribute(attribute)

Parameters:

Declared on: line 1516 of Lua/hospital.lua.

function Hospital:getDebugPatient()

Declared on: line 1254 of Lua/hospital.lua.

function Hospital:getHeliportPosition()

Returns the heliport x and y coordinates or nil if none exist.

Declared on: line 804 of Lua/hospital.lua.

function Hospital:getHeliportSpawnPosition()

Returns the tile on which patients should spawn when getting out of the helicopter.

Declared on: line 816 of Lua/hospital.lua.

function Hospital:getIndexOfTask(x, y, taskType)

Parameters:

Declared on: line 1705 of Lua/hospital.lua.

function Hospital:getObjectBuildCost(name)

Returns how much a given object currently costs to purchase. The cost may be affected by research progress.

Parameters:

Declared on: line 1263 of Lua/hospital.lua.

function Hospital:getPlayerIndex()

Declared on: line 799 of Lua/hospital.lua.

function Hospital:getTaskObject(taskIndex, taskType)

Parameters:

Declared on: line 1619 of Lua/hospital.lua.

function Hospital:getTreatmentPrice(disease)

Function to determine the price for a treatment, modified by reputation and percentage Treatment charge should never be less than the starting price if reputation falls below 500

Parameters:

Declared on: line 1356 of Lua/hospital.lua.

function Hospital:hasRoomOfType(type)

Checks if the hospital has a room of a given type.

Returns false if none, else number of that type found

Parameters:

Declared on: line 1436 of Lua/hospital.lua.

function Hospital:hasStaffOfCategory(category)

"Surgeon", "Researcher" or "Consultant"

returns false if none, else number of that type employed

Parameters:

Declared on: line 1414 of Lua/hospital.lua.

function Hospital:hasStaffedDesk()

Declared on: line 1096 of Lua/hospital.lua.

function Hospital:hotWarning()

Declared on: line 841 of Lua/hospital.lua.

function Hospital:humanoidDeath(humanoid)

Parameters:

Declared on: line 1406 of Lua/hospital.lua.

function Hospital:initOwnedPlots()

Declared on: line 1715 of Lua/hospital.lua.

function Hospital:isInHospital(x, y)

Test if a given map tile is part of the hospital.

Parameters:

Declared on: line 825 of Lua/hospital.lua.

function Hospital:isPlayerHospital()

Returns whether this hospital is controlled by a real person or not.

Declared on: line 1091 of Lua/hospital.lua.

function Hospital:logTransaction(transaction)

Add a transaction to the hospital's transaction log.

Parameters:

Declared on: line 1379 of Lua/hospital.lua.

function Hospital:modifyHandymanTaskPriority(taskIndex, newPriority, taskType)

Parameters:

Declared on: line 1589 of Lua/hospital.lua.

function Hospital:msgCured()

Messages regarding numbers cured and killed

Declared on: line 243 of Lua/hospital.lua.

function Hospital:msgKilled()

So the messages don't show too often there will need to be at least 10 days before one can show again.

Declared on: line 256 of Lua/hospital.lua.

function Hospital:noStaffroom_msg()

Seasoned players will know these things, but it does not harm to be reminded if there is no staff room or toilet

Declared on: line 204 of Lua/hospital.lua.

function Hospital:noToilet_msg()

Declared on: line 218 of Lua/hospital.lua.

function Hospital:onEndDay()

Called at the end of each day.

Declared on: line 879 of Lua/hospital.lua.

function Hospital:onEndMonth()

Called at the end of each month.

Declared on: line 982 of Lua/hospital.lua.

function Hospital:onEndYear()

Called at the end of each year

Declared on: line 1100 of Lua/hospital.lua.

function Hospital:praiseBench()

Give praise where it is due

Declared on: line 230 of Lua/hospital.lua.

function Hospital:purchasePlot(plot_number)

Parameters:

Declared on: line 779 of Lua/hospital.lua.

function Hospital:receiveMoney(amount, reason, changeValue)

Increases the player's money by the given amount and logs the transaction.

Parameters:

Declared on: line 1301 of Lua/hospital.lua.

function Hospital:receiveMoneyForProduct(patient, amount, reason)

Parameters:

Declared on: line 1374 of Lua/hospital.lua.

function Hospital:receiveMoneyForTreatment(patient)

Determines how much the player should receive after a patient is treated in a room.

Parameters:

Declared on: line 1319 of Lua/hospital.lua.

function Hospital:removeDebugPatient(patient)

Parameters:

Declared on: line 1244 of Lua/hospital.lua.

function Hospital:removeHandymanTask(taskIndex, taskType)

Parameters:

Declared on: line 1596 of Lua/hospital.lua.

function Hospital:removePatient(patient)

Parameters:

Declared on: line 1464 of Lua/hospital.lua.

function Hospital:removeStaff(staff)

Parameters:

Declared on: line 1460 of Lua/hospital.lua.

function Hospital:resolveEmergency()

Called when the timer runs out during an emergency or when all emergency patients are cured or dead.

Declared on: line 1186 of Lua/hospital.lua.

function Hospital:roomNotYetResearched(disease)

has not been researched yet.

param disease (string): the disease to be checked.

Parameters:

Declared on: line 1734 of Lua/hospital.lua.

function Hospital:searchForHandymanTask(handyman, taskType)

Parameters:

Declared on: line 1636 of Lua/hospital.lua.

function Hospital:spawnPatient()

Declared on: line 1240 of Lua/hospital.lua.

function Hospital:spendMoney(amount, reason, changeValue)

Lowers the player's money by the given amount and logs the transaction.

Parameters:

Declared on: line 1283 of Lua/hospital.lua.

function Hospital:tick()

Called each tick, also called 'hours'. Check hours_per_day in

world.lua to see how many times per day this is.

Declared on: line 756 of Lua/hospital.lua.

function Hospital:updatePercentages()

Declared on: line 1509 of Lua/hospital.lua.

function Hospital:warningBench()

Warn if the hospital is lacking some basics

Declared on: line 270 of Lua/hospital.lua.

function Hospital:warningThirst()

Declared on: line 308 of Lua/hospital.lua.

function Hospital:warningTooCold()

Warn when it is too cold

Declared on: line 295 of Lua/hospital.lua.

function Hospital:warningTooHot()

Warn when it is too hot

Declared on: line 282 of Lua/hospital.lua.