CorsixTH Lua Documentation

function Staff:Staff(...)

Parameters:

Declared on: line 31 of Lua/entities/humanoids/staff.lua.

function Staff:adviseWrongPersonForThisRoom()

Declared on: line 493 of Lua/entities/humanoids/staff.lua.

function Staff:afterLoad(old, new)

Parameters:

Overrides: Humanoid:afterLoad.
Declared on: line 651 of Lua/entities/humanoids/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 377 of Lua/entities/humanoids/staff.lua.

function Staff:checkIfWaitedTooLongForRaise()

Declared on: line 157 of Lua/entities/humanoids/staff.lua.

function Staff:despawn()

Despawns the staff member and removes them from the hospital

Overrides: Humanoid:despawn.
Declared on: line 275 of Lua/entities/humanoids/staff.lua.

function Staff:die()

Declared on: line 265 of Lua/entities/humanoids/staff.lua.

function Staff:dump()

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

function Staff:fire()

Immediately terminate the staff member's employment.

Overrides: Humanoid:fire.
Declared on: line 233 of Lua/entities/humanoids/staff.lua.

function Staff:fulfillsCriterion(criterion)

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

Parameters:

Declared on: line 487 of Lua/entities/humanoids/staff.lua.

function Staff:getServiceQuality()

Estimate staff service quality based on skills, restfulness (inverse of fatigue) and happiness.

Overrides: Humanoid:getServiceQuality.
Declared on: line 724 of Lua/entities/humanoids/staff.lua.

function Staff:goToStaffRoom()

Declared on: line 433 of Lua/entities/humanoids/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 589 of Lua/entities/humanoids/staff.lua.

function Staff:isCrackUpTired()

Judge crack up tiredness based on the level config (which has a default of 800)

Declared on: line 753 of Lua/entities/humanoids/staff.lua.

function Staff:isIdle()

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

Declared on: line 512 of Lua/entities/humanoids/staff.lua.

function Staff:isResting()

Declared on: line 218 of Lua/entities/humanoids/staff.lua.

function Staff:isTiring()

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

function Staff:isVeryTired()

Judge tiredness based on the level config (which has a default of 700)

Declared on: line 747 of Lua/entities/humanoids/staff.lua.

function Staff:notifyNewRoom(room)

Parameters:

Overrides: Humanoid:notifyNewRoom.
Declared on: line 427 of Lua/entities/humanoids/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 281 of Lua/entities/humanoids/staff.lua.

function Staff:onDestroy()

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

function Staff:onPickup()

Declared on: line 459 of Lua/entities/humanoids/staff.lua.

function Staff:onPlaceInCorridor()

Declared on: line 467 of Lua/entities/humanoids/staff.lua.

function Staff:removeQueuedStaffMessage()

Destroys any raise request window that may be queued

Declared on: line 228 of Lua/entities/humanoids/staff.lua.

function Staff:requestRaise()

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

Declared on: line 561 of Lua/entities/humanoids/staff.lua.

function Staff:setDynamicInfoText(text)

Sets dynamic info text before the dynamic info update

Parameters:

Declared on: line 616 of Lua/entities/humanoids/staff.lua.

function Staff:setHospital(hospital)

Sets the Hospital for a member of staff

Parameters:

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

function Staff:setPickup(ui, window_to_close)

Function to set pickup action on staff. Pickup action can be deferred.

Parameters:

Declared on: line 447 of Lua/entities/humanoids/staff.lua.

function Staff:setProfile(profile)

Parameters:

Declared on: line 320 of Lua/entities/humanoids/staff.lua.

function Staff:tick()

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

function Staff:tickDay()

Handle daily adjustments to staff.

Overrides: Humanoid:tickDay.
Declared on: line 40 of Lua/entities/humanoids/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 328 of Lua/entities/humanoids/staff.lua.

function Staff:tostring()

Return string representation

Overrides: Humanoid:tostring.
Declared on: line 740 of Lua/entities/humanoids/staff.lua.

function Staff:updateDynamicInfo()

Updates a staff member's dynamic info

Declared on: line 623 of Lua/entities/humanoids/staff.lua.

function Staff:updateSpeed()

Update the movement speed

Overrides: Humanoid:updateSpeed.
Declared on: line 345 of Lua/entities/humanoids/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 338 of Lua/entities/humanoids/staff.lua.