Package com.minecolonies.api.colony

Interface ICitizen

All Known Subinterfaces:
ICitizenData, ICitizenDataView, ICivilianData, IVisitorData, IVisitorViewData
All Known Implementing Classes:
CitizenData, CitizenDataView, VisitorData, VisitorDataView
public interface ICitizen
Higher level Citizen data (Englobes server and client side variants).

  • Method Summary

    Modifier and Type
    Method
    Description
    IColony
    getColony()
    Returns the visitor's colony
    int
    getId()
    Returns the id of the citizen.
    InventoryCitizen
    getInventory()
    Get the inventory of the citizen.
    String
    getName()
    Returns the name of the citizen.
    double
    getSaturation()
    Getter for the saturation.
    boolean
    isChild()
    Check if the entity is a child
    boolean
    isFemale()
    Returns true if citizen is female, false for male.
    boolean
    isPaused()
    Check if the citizen is paused.
    void
    setPaused(boolean p)
    Check if the citizen is paused.

  • Method Details

    • getId

      int getId()
      Returns the id of the citizen.
      Returns:
      id of the citizen.

    • getName

      String getName()
      Returns the name of the citizen.
      Returns:
      name of the citizen.

    • isFemale

      boolean isFemale()
      Returns true if citizen is female, false for male.
      Returns:
      true for female, false for male.

    • getSaturation

      double getSaturation()
      Getter for the saturation.
      Returns:
      the saturation.

    • isChild

      boolean isChild()
      Check if the entity is a child
      Returns:
      true if child

    • getInventory

      InventoryCitizen getInventory()
      Get the inventory of the citizen.
      Returns:
      the inventory of the citizen.

    • setPaused

      void setPaused(boolean p)
      Check if the citizen is paused.
      Parameters:
      p - true if paused, else false.

    • isPaused

      boolean isPaused()
      Check if the citizen is paused.
      Returns:
      true for paused, false for working.

    • getColony

      IColony getColony()
      Returns the visitor's colony
      Returns:
      colony