Abstract class
Extendable
Category: Data

Cloneable

Runtime only, Savegame

• Type: MANDATE_TYPE
• Expected: asset ID

Runtime only, Savegame

• Type: RESOURCE_COLLECTION_VALUE
• Can also be built from: list<RESOURCE_QUANTITY_PAIR>
• Expected: RESOURCE_COLLECTION_VALUE value or list of RESOURCE_QUANTITY_PAIR values

Runtime only, Savegame

• Type: COMP_VILLAGER
• Expected: pair of asset ID and component data type

Runtime only, Savegame

• Type: boolean
• Expected: boolean value
• Default value: false

void initialize(mandateType)

Call after creation of your instance

Virtual function

void init()

This is called on load of the game

Virtual function

void update(level)

Virtual function

void startMandate()

This is called when the Bailiff starts this mandate

Virtual function

string getCurrentStateText()

float getDurationInSec()

float getRemainingTime()

INST_UNLOCKABLE_COST getCost()

void addMandateCostModifier(costMultiplicator)

void removeMandateCostModifier(costMultiplicator)

void addMandateTimeModifier(timeMultiplicator)

void removeMandateTimeModifier(timeMultiplicator)

void decreaseRemainingTime(deltaTime)

float getRemainingTimeRatio()

boolean isRequiringBailiff()

COMP_VILLAGER getAssignedVillager()

void setAssignedVillager(assignedVillager)

boolean isEnabled()

boolean isVisible()

boolean isActive()

boolean isDisabled()

void setEnabled(isEnabled)

void setVisible(isVisible)

void addDelayBeforeEnabled(timeDelay [, disableMandate])

integer_and_unsigned_integer getDelayBeforeEnabledInDays()

Virtual function

void cancelMandate()

Virtual function

void completeMandate()

float getDelayBeforeEnabledTimeRatio()

float getDelayBeforeEnabled()

Virtual function

boolean isValid()

Virtual function, Protected function

void internalOnStartClickCallback(assetRelatedJob)

This is called when you click on the \'start\' button of the mandate in the Mandate Window

ON_MANDATE_STATE_CHANGED() Call this event when you update your mandate. This will update the status string in the UI.