CorsixTH Lua Documentation

function Humanoid:Humanoid(...)

Parameters:

Declared on: line 338 of Lua/entities/humanoid.lua.

function Humanoid:_handleEmptyActionQueue()

Handle an empty action queue in some way instead of crashing.

Declared on: line 747 of Lua/entities/humanoid.lua.

function Humanoid:afterLoad(old, new)

Save game compatibility

Parameters:

Overrides: Entity:afterLoad.
Declared on: line 360 of Lua/entities/humanoid.lua.

function Humanoid:changeAttribute(attribute, amount)

Adjusts one of the `Humanoid`'s attributes.

Parameters:

Declared on: line 955 of Lua/entities/humanoid.lua.

function Humanoid:despawn()

Despawn the humanoid.

Declared on: line 466 of Lua/entities/humanoid.lua.

function Humanoid:dump()

Declared on: line 433 of Lua/entities/humanoid.lua.

function Humanoid:findObjectsInSquare(size, object_spec)

Collect the objects in a square around the humanoid within the same room.

Parameters:

Declared on: line 535 of Lua/entities/humanoid.lua.

function Humanoid:finishAction(action)

Parameters:

Declared on: line 699 of Lua/entities/humanoid.lua.

function Humanoid:getAttribute(attribute, default_value)

Get attribute value

Parameters:

Declared on: line 1207 of Lua/entities/humanoid.lua.

function Humanoid:getCurrentAction()

Declared on: line 1125 of Lua/entities/humanoid.lua.

function Humanoid:getCurrentMood()

Declared on: line 529 of Lua/entities/humanoid.lua.

function Humanoid.getIdleAnimation(humanoid_class)

Parameters:

Declared on: line 525 of Lua/entities/humanoid.lua.
Note: Is a function rather than a method.

function Humanoid:getRoom()

Overrides: Entity:getRoom.
Declared on: line 429 of Lua/entities/humanoid.lua.

function Humanoid:goingToUseObject(object_type)

Helper function that finds out if there is an action queued to use the specified object

Parameters:

Declared on: line 1022 of Lua/entities/humanoid.lua.

function Humanoid:handleRemovedObject(object)

Parameters:

Declared on: line 923 of Lua/entities/humanoid.lua.

function Humanoid:hasDressingAndLeavingAction()

Check if there is "use_screen is_leaving" action in the action queue

Declared on: line 737 of Lua/entities/humanoid.lua.

function Humanoid:hasLeavingAction()

Check if there is "is_leaving" action in the action queue

Declared on: line 727 of Lua/entities/humanoid.lua.

function Humanoid:isEnteringRoom()

Check if the humanoid is entering room

Declared on: line 719 of Lua/entities/humanoid.lua.

function Humanoid:isKnockingDoor()

Check if the humanoid is knocking on a door

Declared on: line 714 of Lua/entities/humanoid.lua.

function Humanoid:isLeaving()

Check if the humanoid is running actions intended to leave the room, as indicated by the flag

Declared on: line 709 of Lua/entities/humanoid.lua.

function Humanoid:isMeandering()

Check whether humanoids (staff and Inspector) are meandering

Declared on: line 1251 of Lua/entities/humanoid.lua.

function Humanoid:isMoodActive(mood)

Is the given mood in the list of active moods.

Parameters:

Declared on: line 510 of Lua/entities/humanoid.lua.

function Humanoid:isObscuringArea(x1, x2, y1, y2)

Checks whether a humanoid is within the specified area or is currently walking into it. To properly check whether a humanoid is entering an area, pass coordinates 1 tile outside the square where actually need to build. For example, if the intended wall of the room being built is outside the perimeter (x1, y1) (x2, y2), then need to pass (x1-1, y1-1) (x2+1, y2+1). Example input parameters: (50, 55, 60, 65).

Parameters:

Declared on: line 1215 of Lua/entities/humanoid.lua.

function Humanoid:isType(humanoid_class)

Parameters:

Declared on: line 845 of Lua/entities/humanoid.lua.

function Humanoid:leaveArea()

Function attempts to expel the humanoid from the area. It does not require any input parameters since it expects that the area to be left is already marked with the `avoidTile` tile flag.

Declared on: line 863 of Lua/entities/humanoid.lua.

function Humanoid:notifyNewRoom(room)

Parameters:

Overrides: Entity:notifyNewRoom.
Declared on: line 1048 of Lua/entities/humanoid.lua.

function Humanoid:notifyOfStaffChange(staff)

Parameters:

Declared on: line 1054 of Lua/entities/humanoid.lua.

function Humanoid:onClick(ui, button)

Function which is called when the user clicks on the `Humanoid`.

Parameters:

Declared on: line 420 of Lua/entities/humanoid.lua.

function Humanoid:onDestroy()

Called when the humanoid is about to be removed from the world.

Overrides: Entity:onDestroy.
Declared on: line 440 of Lua/entities/humanoid.lua.

function Humanoid:queueAction(action, pos)

Parameters:

Declared on: line 686 of Lua/entities/humanoid.lua.

function Humanoid:registerRoomBuildCallback(callback)

Registers a new build callback for this humanoid.

Parameters:

Declared on: line 1032 of Lua/entities/humanoid.lua.

function Humanoid:registerRoomRemoveCallback(callback)

Registers a new remove callback for this humanoid.

Parameters:

Declared on: line 1060 of Lua/entities/humanoid.lua.

function Humanoid:registerStaffChangeCallback(callback)

Registers a new staff change callback for this humanoid.

Parameters:

Declared on: line 1081 of Lua/entities/humanoid.lua.

function Humanoid:setCallCompleted()

Declared on: line 504 of Lua/entities/humanoid.lua.

function Humanoid:setHospital(hospital)

Set the `Hospital` which is responsible for treating or employing the `Humanoid`. In single player games, this has little effect, but it is very important in multiplayer games.

Parameters:

Declared on: line 454 of Lua/entities/humanoid.lua.

function Humanoid:setIfHoverMoodsVisible()

Set whether this humanoid should display its mood on hover.

Declared on: line 520 of Lua/entities/humanoid.lua.

function Humanoid:setMood(mood_name, activate)

Function to activate/deactivate moods of a humanoid. If mood_name is nil it is considered a refresh only.

Parameters:

Overrides: Entity:setMood.
Declared on: line 472 of Lua/entities/humanoid.lua.

function Humanoid:setNextAction(action, high_priority)

Parameters:

Declared on: line 615 of Lua/entities/humanoid.lua.

function Humanoid:setType(humanoid_class)

Parameters:

Declared on: line 816 of Lua/entities/humanoid.lua.

function Humanoid:startAction()

Start the next (always first) action in the queue.

Declared on: line 587 of Lua/entities/humanoid.lua.

function Humanoid:tickDay()

Check if it is cold or hot around the humanoid and increase/decrease the feeling of warmth accordingly. Returns whether the calling function should proceed.

Overrides: Entity:tickDay.
Declared on: line 984 of Lua/entities/humanoid.lua.

function Humanoid:tire(amount)

Stub functions for handling fatigue. These are overridden by the staff subclass, but also defined here, so we can just call it on any humanoid

Parameters:

Declared on: line 911 of Lua/entities/humanoid.lua.

function Humanoid:tostring()

Return string representation

Returns string representation of the humanoid like status and action queue

Declared on: line 1133 of Lua/entities/humanoid.lua.

function Humanoid:unexpectFromRoom(dest_room)

Unexpects humanoid from a room, if validly entering this room

Parameters:

Declared on: line 1191 of Lua/entities/humanoid.lua.

function Humanoid:unregisterCallbacks()

Function called when a humanoid is sent away from the hospital to prevent further actions taken as a result of a callback

Declared on: line 1103 of Lua/entities/humanoid.lua.

function Humanoid:unregisterRoomBuildCallback(callback)

Unregisters a build callback for this humanoid.

Parameters:

Declared on: line 1042 of Lua/entities/humanoid.lua.

function Humanoid:unregisterRoomRemoveCallback(callback)

Unregisters a remove callback for this humanoid.

Parameters:

Declared on: line 1071 of Lua/entities/humanoid.lua.

function Humanoid:unregisterStaffChangeCallback(callback)

Unregisters a staff change callback for this humanoid.

Parameters:

Declared on: line 1091 of Lua/entities/humanoid.lua.

function Humanoid:updateSpeed()

Declared on: line 919 of Lua/entities/humanoid.lua.

function Humanoid:wake(amount)

Parameters:

Declared on: line 916 of Lua/entities/humanoid.lua.

function Humanoid:walkTo(tile_x, tile_y, must_happen)

Helper function for the common case of instructing a `Humanoid` to walk to a position on the map. Equivalent to calling `setNextAction` with a walk action.

Parameters:

Declared on: line 849 of Lua/entities/humanoid.lua.