CorsixTH Lua Documentation

function Staff:Staff(...)

Parameters:

Declared on: line 24 of Lua/entities/staff.lua.

function Staff:adviseWrongPersonForThisRoom()

Declared on: line 701 of Lua/entities/staff.lua.

function Staff:afterLoad(old, new)

Parameters:

Overrides: Humanoid:afterLoad.
Declared on: line 859 of Lua/entities/staff.lua.

function Staff:assignHandymanTask(taskIndex, taskType)

Parameters:

Declared on: line 949 of Lua/entities/staff.lua.

function Staff:checkIfNeedRest()

Check if fatigue is over a certain level (decided by the hospital policy), and go to the StaffRoom if it is.

Declared on: line 544 of Lua/entities/staff.lua.

function Staff:checkIfWaitedTooLong()

Declared on: line 197 of Lua/entities/staff.lua.

function Staff:die()

Declared on: line 383 of Lua/entities/staff.lua.

function Staff:dump()

Overrides: Humanoid:dump.
Declared on: line 417 of Lua/entities/staff.lua.

function Staff:fire()

Immediately terminate the staff member's employment.

Declared on: line 353 of Lua/entities/staff.lua.

function Staff:fulfillsCriterion(criterion)

Helper function to decide if Staff fulfills a criterion (one of "Doctor", "Nurse", "Psychiatrist", "Surgeon", "Researcher" and "Handyman")

Parameters:

Declared on: line 675 of Lua/entities/staff.lua.

function Staff:getDrawingLayer()

Overrides: Humanoid:getDrawingLayer.
Declared on: line 970 of Lua/entities/staff.lua.

function Staff:goToStaffRoom()

Declared on: line 621 of Lua/entities/staff.lua.

function Staff:increaseWage(amount)

Increases the wage of the staff member. Also increases happiness and clears any request raise dialogs.

Parameters:

Declared on: line 813 of Lua/entities/staff.lua.

function Staff:interruptHandymanTask()

Declared on: line 889 of Lua/entities/staff.lua.

function Staff:isIdle()

Function to decide if staff currently has nothing to do and can be called to a room where he's needed

Declared on: line 726 of Lua/entities/staff.lua.

function Staff:isLearning()

Determine if the staff member should increase their skills

Declared on: line 286 of Lua/entities/staff.lua.

function Staff:isLearningOnTheJob()

Declared on: line 295 of Lua/entities/staff.lua.

function Staff:isResearching()

Determine if the staff member should contribute to research

Declared on: line 278 of Lua/entities/staff.lua.

function Staff:isResting()

Declared on: line 269 of Lua/entities/staff.lua.

function Staff:isTiring()

Declared on: line 248 of Lua/entities/staff.lua.

function Staff:leaveAnnounce()

Declared on: line 233 of Lua/entities/staff.lua.

function Staff:needsWorkStation()

Declared on: line 456 of Lua/entities/staff.lua.

function Staff:onClick(ui, button)

Function which is called when the user clicks on the staff member. Responsible for opening a staff information dialog on left click and picking up the staff member on right click.

Parameters:

Overrides: Humanoid:onClick.
Declared on: line 394 of Lua/entities/staff.lua.

function Staff:onDestroy()

Overrides: Humanoid:onDestroy.
Declared on: line 850 of Lua/entities/staff.lua.

function Staff:onPlaceInCorridor()

Declared on: line 638 of Lua/entities/staff.lua.

function Staff:requestRaise()

Makes the staff member request a raise of 10%, or a wage exactly inbetween their current and a fair one, whichever is more.

Declared on: line 791 of Lua/entities/staff.lua.

function Staff:searchForHandymanTask()

Declared on: line 899 of Lua/entities/staff.lua.

function Staff:setCrazy(crazy)

Parameters:

Declared on: line 602 of Lua/entities/staff.lua.

function Staff:setDynamicInfoText(text)

Parameters:

Declared on: line 829 of Lua/entities/staff.lua.

function Staff:setHospital(hospital)

Parameters:

Overrides: Humanoid:setHospital.
Declared on: line 661 of Lua/entities/staff.lua.

function Staff:setProfile(profile)

Parameters:

Declared on: line 440 of Lua/entities/staff.lua.

function Staff:tick()

Overrides: Entity:tick.
Declared on: line 145 of Lua/entities/staff.lua.

function Staff:tickDay()

Overrides: Humanoid:tickDay.
Declared on: line 31 of Lua/entities/staff.lua.

function Staff:tire(amount)

Function for increasing fatigue. Fatigue can be between 0 and 1, so amounts here should be appropriately small comma values.

Parameters:

Overrides: Humanoid:tire.
Declared on: line 500 of Lua/entities/staff.lua.

function Staff:trainSkill(consultant, trait, skill_thres, room_factor, staff_count)

Parameters:

Declared on: line 343 of Lua/entities/staff.lua.

function Staff:updateDynamicInfo()

Declared on: line 834 of Lua/entities/staff.lua.

function Staff:updateSkill(consultant, trait, amount)

Parameters:

Declared on: line 304 of Lua/entities/staff.lua.

function Staff:updateSpeed()

Update the movement speed

Overrides: Humanoid:updateSpeed.
Declared on: line 514 of Lua/entities/staff.lua.

function Staff:updateStaffTitle()

Declared on: line 465 of Lua/entities/staff.lua.

function Staff:wake(amount)

Function for decreasing fatigue. Fatigue can be between 0 and 1, so amounts here should be appropriately small comma values.

Parameters:

Overrides: Humanoid:wake.
Declared on: line 507 of Lua/entities/staff.lua.