Enums¶
Every finite set of game constants, one module per area. empire_core.enums also exports the generated
game-data id enums (Unit, Tool, Research, ...), documented under Game data.
enums.alliance¶
Alliance ranks, diplomacy, member presence, help requests, bookmarks, buffs and the chronicle.
Classes:
| Name | Description |
|---|---|
AllianceRank |
A member's rank in an alliance; a lower value is a higher rank. |
DiplomacyStatus |
An alliance's standing with another alliance. |
OnlineState |
How recently an alliance member was online. |
HelpType |
What an alliance help request asks for. |
BookmarkType |
What a map bookmark marks. |
AllianceChronicleAction |
What an entry of the alliance chronicle records. |
AllianceBuffType |
An alliance upgrade or boost: the series an alliance buff's levels belong to. |
Bases: IntEnum
A member's rank in an alliance; a lower value is a higher rank.
Client: AllianceConst.RANK_* (dll line 18805)
Attributes:
| Name | Type | Description |
|---|---|---|
LEADER |
|
|
COLEADER |
|
|
MARSHAL |
|
|
TREASURER |
|
|
DIPLOMAT |
|
|
RECRUITER |
|
|
GENERAL |
|
|
SERGEANT |
|
|
MEMBER |
|
|
APPLICANT |
|
|
text_id |
str
|
The text id of the rank's name, |
property
¶
text_id: str
The text id of the rank's name, dialog_alliance_rank<n>, numbered in an order of its own:
text(AllianceRank.COLEADER.text_id) is "Deputy" (empire_core.texts.text).
Client: "dialog_alliance_rank" + CastleAllianceData.getTextIDForRank(rank) (bundle line
44529), numbered by CastleAllianceData.TEXT_IDS_FOR_RANK_IDS (bundle line 11626)
Bases: IntEnum
An alliance's standing with another alliance.
Client: AllianceConst.DIPLOMACY_* (dll line 18805)
Attributes:
| Name | Type | Description |
|---|---|---|
IN_WAR |
|
|
NEUTRAL |
|
|
SOFT_ALLIED |
|
|
REAL_ALLIED |
|
|
text_id |
str
|
The text id of the status's name, |
Bases: IntEnum
How recently an alliance member was online.
Client: AllianceConst.ONLINESTATE_* (dll line 18805)
Attributes:
| Name | Type | Description |
|---|---|---|
ONLINE |
|
|
LAST_12_HOURS |
|
|
LAST_48_HOURS |
|
|
LAST_1_WEEK |
|
|
LONG_AGO |
|
Bases: IntEnum
What an alliance help request asks for.
Client: AllianceConst.ALLIANCE_HELP_* (dll line 18805)
Attributes:
| Name | Type | Description |
|---|---|---|
RECRUITMENT |
|
|
HEAL_UNIT |
|
|
REPAIR |
|
|
BUILD |
|
|
LOOP_RECRUIT |
|
|
RECRUITMENT_LIST |
|
Bases: IntEnum
What a map bookmark marks.
Client: AllianceConst.BOOKMARK_TYPE_* (dll line 18805)
Attributes:
| Name | Type | Description |
|---|---|---|
PLAYER_ENEMY |
|
|
PLAYER_FRIEND |
|
|
ALLIANCE_FREE_ATTACK |
|
|
ALLIANCE_DEFEND |
|
|
ALLIANCE_ATTACK_ORDER |
|
Bases: IntEnum
What an entry of the alliance chronicle records.
Names follow AllianceConst with its abbreviations spelled out
(C1 coins, C2 rubies, RES resources, TRIBUT tribute, METROPOL metropolis).
Client: AllianceConst action values (dll line 18805)
Attributes:
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
Bases: IntEnum
An alliance upgrade or boost: the series an alliance buff's levels belong to.
Names follow AllianceConst.TYPE_* (DAIYMO spelled DAIMYO); MEMBERS raises the member limit and
FORGE_UPGRADE upgrades the alliance smithy.
Client: AllianceConst.TYPE_* (dll line 18805), the series ids of
allianceBuffData.getAllianceBuffVoBySeriesIDAndLevel (bundle line 27189); 22 to 25 are
AllianceRaidConst.BUFF_SERIES_RAID_BOSS_ATTACK_* (bundle line 33863)
Attributes:
| Name | Type | Description |
|---|---|---|
MEMBERS |
|
|
DEFENSE_SPEED_BOOST |
|
|
MARKET_SPEED_BOOST |
|
|
DEPOSIT_BONUS |
|
|
MARAUDER_BONUS |
|
|
ATTACK_SPEED_BOOST |
|
|
FORGE_UPGRADE |
|
|
TEMP_ATTACK_POWER_BOOST |
|
|
TEMP_DEFENSE_POWER_BOOST |
|
|
TEMP_GLORY_BOOST |
|
|
TEMP_DEFENSE_SPEED_BOOST |
|
|
NOBLE_HOUSE |
|
|
RAGE_POINT_BOOST |
|
|
COOLDOWN_REDUCTION_KHAN |
|
|
COOLDOWN_REDUCTION_NOMADS |
|
|
INFLUENCE_POINT_BOOST |
|
|
ALIEN_ATTACK_BOOST |
|
|
DAIMYO_ATTACK_BOOST |
|
|
KHAN_DEFENSE_BOOST |
|
|
HEALING_SPEED_BOOST |
|
|
COOLDOWN_REDUCTION_SAMURAI_CAMP |
|
|
COOLDOWN_REDUCTION_DAIMYO |
|
|
TEMP_RAID_BOSS_COMMON_ATTACK_BOOST |
|
|
TEMP_RAID_BOSS_RARE_ATTACK_BOOST |
|
|
TEMP_RAID_BOSS_EPIC_ATTACK_BOOST |
|
|
TEMP_RAID_BOSS_LEGENDARY_ATTACK_BOOST |
|
|
text_id |
str | None
|
The text id of the buff's name, None for |
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
enums.army¶
Unit production lists and slots.
Classes:
| Name | Description |
|---|---|
ProductionListId |
The client's unit package lists, one per kind of production. |
SlotType |
Whether a slot is the one producing now or one waiting in the queue. |
Bases: IntEnum
The client's unit package lists, one per kind of production.
Client: UnitProductionConst (dll line 19891), picked by
CastleMilitaryData.getListIdByCategory (bundle line 138870)
Attributes:
| Name | Type | Description |
|---|---|---|
SOLDIERS |
|
|
TOOLS |
|
|
HOSPITAL |
|
|
AUXILIARIES |
|
Whether a slot is the one producing now or one waiting in the queue.
Client: RecruitmentConst.PRODUCTION_SLOT_TYPE_NAME / QUEUE_SLOT_TYPE_NAME
(dll line 19660)
Attributes:
| Name | Type | Description |
|---|---|---|
PRODUCTION |
|
|
QUEUE |
|
enums.castle¶
Castle buildings, resource carts, market goods, market scopes and tax collection.
Classes:
| Name | Description |
|---|---|
BuildingState |
What a building in a castle is doing. |
ResourceCartType |
The resource a resource cart carries, the |
Resource |
A resource a market carriage can carry, by its wire key in |
MarketScope |
Which castles a market info request covers, the |
ExpansionType |
How a castle expansion is paid for, the |
TaxStatus |
Where a tax collection stands. |
KingdomTransferType |
What a transfer to another kingdom carries, the |
Bases: IntEnum
What a building in a castle is doing.
Client: IsoBuildingStateEnum (bundle line 3443); an id it does not
define reads as INITIAL (getTypeById, bundle line 3422)
Attributes:
A resource a market carriage can carry, by its wire key in G of crm.
The send dialog offers these on three tabs: classic (wood, stone, food),
kingdom (coal, oil, glass, iron) and mead (honey, mead, beef). Aquamarine
(A) is a collectable too but on none of the tabs.
Client: CastleSendGoodsComponent.resCollectableEnums* (bundle line 44358),
each CollectableItem*VO.SERVER_KEY (bundle lines 10679, 10670, 16811,
23303, 23326, 23310, 23317, 23333, 19934, 17834)
Attributes:
| Name | Type | Description |
|---|---|---|
WOOD |
|
|
STONE |
|
|
FOOD |
|
|
COAL |
|
|
OIL |
|
|
GLASS |
|
|
IRON |
|
|
HONEY |
|
|
MEAD |
|
|
BEEF |
|
Bases: IntEnum
Which castles a market info request covers, the S of cmi.
Client: C2SMarketInfoVO.SCOPE_* (bundle line 27014)
Attributes:
| Name | Type | Description |
|---|---|---|
CURRENT_KINGDOM |
|
|
ALL_KINGDOMS |
|
Bases: IntEnum
Where a tax collection stands.
Client: TaxInfoVO.TAXSTATUS_* (bundle line 29576)
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
|
|
COLLECTING |
|
|
WAIT_FOR_COLLECT |
|
Bases: IntEnum
What a transfer to another kingdom carries, the TT of a transfer skip.
The client names no constant; it passes the numbers itself.
Client: KingdomUnitsTravelMinuteSkipProperties.getMinuteSkipCommand (bundle line 37497),
KingdomGoodsTravelMinuteSkipProperties.getMinuteSkipCommand (bundle line 55567)
Attributes:
| Name | Type | Description |
|---|---|---|
UNITS |
|
|
GOODS |
|
enums.collectables¶
What a reward, a cost or a list of goods can hold.
Classes:
| Name | Description |
|---|---|
CollectableKind |
The kind of a collectable: the client's |
BoosterId |
Booster ids, as a booster reward ( |
RewardGrantType |
Who a reward goes to. |
The kind of a collectable: the client's CollectableEnum types a server key can name.
The value is the client's type name, server_key the key the server sends it under. A
currency (CURRENCY) has no key of its own: it comes under the currency's key. OTHER
stands for a key the client has no type for; the client drops such an entry.
Client: CollectableEnum.__initialize_static_members (bundle lines 419-551); each item
class's SERVER_KEY and XML_KEY (e.g. CollectableItemUnitVO, bundle line 15494)
Attributes:
| Name | Type | Description |
|---|---|---|
server_key |
str
|
The key the server sends this kind under; empty for |
xml_keys |
tuple[str, ...]
|
The columns the items tables give this kind under, as in a |
RELIC_EQUIPMENT |
|
|
WOOD |
|
|
STONE |
|
|
FOOD |
|
|
COAL |
|
|
OIL |
|
|
GLASS |
|
|
IRON |
|
|
AQUAMARINE |
|
|
MEAD |
|
|
BEEF |
|
|
HONEY |
|
|
COINS |
|
|
RUBIES |
|
|
CURRENCY |
|
|
UNITS |
|
|
PLAGUE_DOCTORS |
|
|
EQUIPMENT_RARENESS |
|
|
EQUIPMENT_UNIQUE |
|
|
EQUIPMENT_UNIQUE_ENCHANTED |
|
|
HERO_RANDOM |
|
|
GEM |
|
|
GEM_RANDOM |
|
|
BOOSTER |
|
|
GLORY_BOOSTER |
|
|
XP_BOOSTER |
|
|
GALLANTRY_BOOSTER |
|
|
KHAN_TABLET_BOOSTER |
|
|
SAMURAI_BOOSTER |
|
|
ALLIANCE_COIN_BOOSTER |
|
|
LONG_TERM_POINT_EVENT_BOOSTER |
|
|
REPUTATION_BOOSTER |
|
|
RAGE_POINT_BOOSTER |
|
|
KHAN_MEDAL_POINT_BOOSTER |
|
|
VIP_POINTS |
|
|
VIP_TIME |
|
|
XP |
|
|
SKIP_DISCOUNT |
|
|
EXTINGUISH_FIRE |
|
|
ALIEN_PROTECTION |
|
|
DUNGEON_PROTECTION |
|
|
BUILDING |
|
|
RESOURCE_POINTS |
|
|
ACHIEVEMENT_POINTS |
|
|
CREST_SYMBOL |
|
|
CONSTRUCTION_ITEM |
|
|
ALLIANCE_GIFT |
|
|
PERMANENT_UNIT_SLOT |
|
|
PERMANENT_TOOL_SLOT |
|
|
CONSTRUCTION_ITEM_BLUEPRINT |
|
|
MATERIAL_BAG |
|
|
PAYMENT_DOUBLER |
|
|
GIFT_PACKAGE |
|
|
LOOT_BOX |
|
|
ALLIANCE_CREST_LAYOUT |
|
|
OTHER |
|
instance-attribute
¶
server_key: str
The key the server sends this kind under; empty for CURRENCY and OTHER.
instance-attribute
¶
The columns the items tables give this kind under, as in a rewards row; empty for none.
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
LONG_TERM_POINT_EVENT_BOOSTER = ('longTermPointEventBooster', 'LTB', ('longTermPointEventBooster',))
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
Bases: IntEnum
Booster ids, as a booster reward ({"ID": booster id, "D": duration}) names them.
Client: BoosterConst (dll line 18853)
Attributes:
Bases: IntEnum
Who a reward goes to.
Client: RewardConst.PLAYER, ALLIANCE, ALLIANCE_MEMBER (dll line 19709)
Attributes:
| Name | Type | Description |
|---|---|---|
PLAYER |
|
|
ALLIANCE |
|
|
ALLIANCE_MEMBER |
|
enums.combat¶
Attack options and the effect ids the combat maths reads.
Classes:
| Name | Description |
|---|---|
AttackType |
Values for the ATT field. |
LootPriority |
The resource an attack loots first, the LP field; NO loots everything evenly. |
AutoSkipCooldownType |
How the target's cooldown is skipped when the attack lands, the ASCT field. |
AttackAdvisorType |
The attack advisor that sent an attack, the AAT field. |
Flank |
Battle flanks. |
BattleLogFlank |
The flank a general's ability took effect on, as a battle log names it. |
CombatEffectType |
Effect type ids the library reads: a subset of the client's effect types. |
TargetRead |
A read |
Bases: IntEnum
Values for the ATT field.
Client: CombatConst.ATTACK_TYPE_* (dll line 18941)
Attributes:
| Name | Type | Description |
|---|---|---|
ATTACK |
|
|
OUTPOST_CONQUER |
|
|
VILLAGE_CONQUER |
|
|
CAPITAL_CONQUER |
|
|
METROPOL_CONQUER |
|
|
KINGTOWER_CONQUER |
|
|
CONQUER |
|
|
MONUMENT_CONQUER |
|
|
LABORATORY_CONQUER |
|
Bases: IntEnum
The resource an attack loots first, the LP field; NO loots everything evenly.
The client offers the dropdown from player level LOOT_PRIO_MIN_LEVEL (20).
Client: CombatConst.LOOT_PRIO_* (dll line 18941), offered by
CastlePostAttackDialog.initLootPriority (bundle line 38351)
Attributes:
| Name | Type | Description |
|---|---|---|
NO |
|
|
WOOD |
|
|
STONE |
|
|
FOOD |
|
|
COAL |
|
|
OIL |
|
|
GLASS |
|
|
AQUAMARINE |
|
|
IRON |
|
|
HONEY |
|
|
MEAD |
|
|
BEEF |
|
Bases: IntEnum
How the target's cooldown is skipped when the attack lands, the ASCT field.
RUBIES pays rubies to skip it.
Client: AutoSkipCooldownConst (dll line 18836), picked in
CastlePostAttackHorseDialog.selectAutoskipOption (bundle line 99902)
Attributes:
| Name | Type | Description |
|---|---|---|
OFF |
|
|
MINUTE_SKIP |
|
|
RUBIES |
|
Bases: IntEnum
The attack advisor that sent an attack, the AAT field.
NONE is the client's default for an attack no advisor sent; it has no constant.
Client: AttackAdvisorConst.ADVISOR_TYPE_* (dll line 18832), the default _advisorType=0
(bundle line 30619), read as advisorType>0 (bundle line 14344)
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
|
|
NOMAD |
|
|
SAMURAI |
|
|
BERIMOND |
|
|
BARON |
|
Bases: IntEnum
Battle flanks.
REINFORCEMENT_SUMMARY is not a flank troops stand on; it only appears in the battle log.
Client: ClientConstCastle.FLANK_* (bundle line 1004), the summary used by
CastleBattleLogDetailAdvancedDialog (bundle line 135711)
Attributes:
| Name | Type | Description |
|---|---|---|
LEFT |
|
|
MIDDLE |
|
|
RIGHT |
|
|
YARD |
|
|
REINFORCEMENT |
|
|
REINFORCEMENT_SUMMARY |
|
The flank a general's ability took effect on, as a battle log names it.
Client: CastleBattleLogPopUpDialog.getFlankNameBattleLog (bundle lines 135871-135877) maps the
dialog's flank to these names; -2 and -3, its PW and EW, are the dialog's
WAVE_INDEX_PRE_ATTACK and WAVE_INDEX_POST_ATTACK (bundle line 135994)
Attributes:
| Name | Type | Description |
|---|---|---|
LEFT |
|
|
MIDDLE |
|
|
RIGHT |
|
|
YARD |
|
|
PRE_ATTACK |
|
|
POST_ATTACK |
|
Bases: IntEnum
Effect type ids the library reads: a subset of the client's effect types.
Names are the client's minus the EFFECT_TYPE_ prefix.
Client: EffectTypeEnum (bundle line 1322)
Attributes:
A read fill_attack makes of its target, naming what it filled without in FilledAttack.unread.
TILE is the map scan (gaa), PRECALCULATION the attack pre-calculation,
GENERAL_SKILLS the general's skills (gie) and LEGEND_SKILLS the player's (skl).
Attributes:
| Name | Type | Description |
|---|---|---|
TILE |
|
|
PRECALCULATION |
|
|
GENERAL_SKILLS |
|
|
LEGEND_SKILLS |
|
enums.commanders¶
Commander enums: equipment slots, wearers, origins and rarities.
Classes:
| Name | Description |
|---|---|
EquipmentSlot |
Slot an equipment item occupies. |
WearerType |
Who may wear an equipment item. |
EquipmentType |
Origin of an equipment item. |
Rareness |
Rarity of an equipment item; hero items have their own range. |
Bases: IntEnum
Who may wear an equipment item.
The client treats any id but 1 and 2 as wearable by all
(BasicEquippableVO.getLordType, bundle line 4837).
Client: EquipmentConst.UNDEFINED_WEARER_ID, BARON_WEARER_ID and
COMMANDER_WEARER_ID (dll line 19249)
Attributes:
| Name | Type | Description |
|---|---|---|
UNDEFINED |
|
|
CASTELLAN |
|
|
COMMANDER |
|
Bases: IntEnum
Origin of an equipment item.
Client: EquipmentConst.EQUIPMENT_TYPE_ID_* (dll line 19249)
Attributes:
| Name | Type | Description |
|---|---|---|
GENERATED |
|
|
UNIQUE |
|
|
UNIQUE_TEMPORARY |
|
|
RELIC |
|
Bases: IntEnum
Rarity of an equipment item; hero items have their own range.
Client: EquipmentConst.RARENESS_* (dll line 19249)
Attributes:
| Name | Type | Description |
|---|---|---|
UNIQUE |
|
|
COMMON |
|
|
RARE |
|
|
EPIC |
|
|
LEGENDARY |
|
|
RELIC |
|
|
HERO_UNIQUE |
|
|
HERO_BEGINN |
|
|
HERO_COMMON |
|
|
HERO_RARE |
|
|
HERO_EPIC |
|
|
HERO_LEGENDARY |
|
|
HERO_RELIC |
|
enums.errors¶
The server's error codes.
Classes:
| Name | Description |
|---|---|
GGEError |
The status codes the server answers commands with. |
Bases: IntEnum
The status codes the server answers commands with.
Names are the client's, except that coins and rubies are named as such where the client says currency 1 and 2 (C1, C2).
Client: ERROR enum (dll line 20067)
Methods:
| Name | Description |
|---|---|
from_code |
|
Attributes:
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
enums.gamedata¶
The fixed values of the items tables' text columns, as the client compares them.
Classes:
| Name | Description |
|---|---|
UnitRole |
A soldier's role, the |
ToolSide |
Whether a tool is used in attack or in defence, the |
ToolCategory |
A tool's category, the |
BuildingGroup |
The |
BuildingGroundType |
The ground a building stands on, its |
QuestConditionType |
What a quest condition counts, the first part of each |
TitleDisplayType |
Whether a title goes before or after the name, a title's |
PlayerRelation |
The relationship to the target an effect is limited to, an effect's |
RelicEffectType |
A relic effect's kind, its |
CastleEffect |
A construction item's fixed bonus, one column of its row named after the bonus, e.g. |
EffectTemplate |
Which of the game's texts describes an effect, by where it is shown. |
The group column of a building, tower, gate or moat.
Client: ClientConstCastle.GROUP_* (bundle line 1004)
Attributes:
| Name | Type | Description |
|---|---|---|
EXPANSION |
|
|
TOWER |
|
|
BACKGROUND |
|
|
RESOURCES |
|
|
CASTLEWALL |
|
|
GATE |
|
|
TOWERBASE |
|
|
BUILDING |
|
|
MAPOBJECT |
|
|
MAPMOVEMENT |
|
|
UNIT |
|
|
DEFENCE |
|
|
SURROUNDINGS |
|
|
FIXED_POSITION_BUILDING |
|
|
TRAVELBOOSTER |
|
|
MOAT |
|
|
EVENT |
|
|
MOVING |
|
class-attribute
instance-attribute
¶
What a quest condition counts, the first part of each conditions entry.
The client names only these; quests count more types, which only the server reads.
Client: ClientConstQuestCondition.QUESTTYPE_* (bundle line 9773)
Attributes:
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
The relationship to the target an effect is limited to, an effect's playerRelation column.
Client: EffectVO.RELATION_* (bundle line 41739)
Attributes:
| Name | Type | Description |
|---|---|---|
SAME_ALLIANCE |
|
|
ALLIANCE_IN_WAR |
|
|
SAME_PLAYER |
|
A construction item's fixed bonus, one column of its row named after the bonus, e.g. recruitCostReduction.
Members are in the client's order, the order a construction item lists them in.
Client: CastleEffectEnum (bundle line 3770), read by CastleEffectVO.createFromXML (bundle line 79059)
Attributes:
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
Bases: Enum
Which of the game's texts describes an effect, by where it is shown.
Attributes:
| Name | Type | Description |
|---|---|---|
CONSTRUCTION_ITEM |
|
|
BUILDING |
|
|
EQUIPMENT |
|
class-attribute
instance-attribute
¶
ci_effect_<name>: a construction item's bonuses (ConstructionItemVO.effectText, bundle line 47766).
class-attribute
instance-attribute
¶
effect_name_<name>, with the effect's cap when it has one: a decoration's effects
(ADecoBuildingVO.createAdditionalEffectItems, bundle line 11897).
class-attribute
instance-attribute
¶
equip_effect_description_<name>: an equipment item's or a gem's bonus (BonusVO.descriptionText,
EquipmentBonusVO.descriptionText and GemBonusVO.descriptionText, bundle lines 5711, 20944 and 46807).
enums.login¶
The login's version check.
Classes:
| Name | Description |
|---|---|
VersionCheckStatus |
The version check ( |
Bases: IntEnum
The version check (vck) refusals, which are not GGEError codes.
Client: VCKCommand.VERSION_TOO_LOW and VERSION_TOO_HIGH (dll line 14473),
matched by CastleVCKCommand.executeCommand (bundle line 120444)
Attributes:
| Name | Type | Description |
|---|---|---|
VERSION_TOO_LOW |
|
|
VERSION_TOO_HIGH |
|
enums.map¶
Kingdom ids, map area types and NPC owner ids.
Classes:
| Name | Description |
|---|---|
Kingdom |
Kingdom identifiers used throughout the game. |
MapItemType |
Area types: the first field of a map row, as in a scan's AI array. |
NPCOwner |
The player ids the game gives its NPC owners; every NPC id is below 0. |
PeaceModeStatus |
Where the player's peace mode stands, a |
Bases: IntEnum
Kingdom identifiers used throughout the game.
Each kingdom has different terrain and unit types.
Client: WorldClassic.KINGDOM_ID (dll line 19928), WorldDessert
(20019), WorldIce (20035), WorldVolcano (20067), WorldIsland
(20051), FactionConst.KINGDOM_ID (19333)
Attributes:
| Name | Type | Description |
|---|---|---|
GREEN |
|
|
SANDS |
|
|
ICE |
|
|
FIRE |
|
|
STORM |
|
|
BERIMOND |
|
|
text_id |
str
|
The text id of the kingdom's name, |
property
¶
text_id: str
The text id of the kingdom's name, kingdomName_<kingdomName>: text(Kingdom.SANDS.text_id) is
"The Burning Sands" (empire_core.texts.text).
Client: CastleKingdomVO.kingdomNameString (bundle line 134711), with the kingdomName
column of the items kingdoms table (CastleKingdomVO.fillFromParamXML, bundle line 134695)
Bases: IntEnum
Area types: the first field of a map row, as in a scan's AI array.
These mirror the game client's own WorldConst.AREA_TYPE_* constants,
a superset of the types WorldmapObjectFactory.mapObjectVOs (bundle
line 5357) registers a map object for: NO_LANDMARK (14), TROOP_HOSTEL
(20), SAMURAI_ALIEN_CAMP (33) and NO_OUTPOST (99) have none, so the client
cannot read a map row of those types.
Two things that are not separate types:
- A ruin is not an item type: the client registers no ruin map object, and
the flag lives on the owner record instead (
Rin a scan's OI list, exposed asMapObject.is_ruin). - The nomad khan camp, which appears while the nomad event runs, is
ALLIANCE_NOMAD_CAMP(NomadKhanCampMapObjectVO).
The same ids type a movement's area rows (TA/SA) and every
area_type input.
Client: WorldConst.AREA_TYPE_* (dll line 20003)
Attributes:
class-attribute
instance-attribute
¶
Bases: IntEnum
The player ids the game gives its NPC owners; every NPC id is below 0.
Members take the client's names, with its kingdom words (desert, ice,
volcano, island for the Sands, Ice, Fire and Storm kingdoms). Some owners
are a run of ids the client computes and names only by their first:
robber barons are ROBBER_BARON minus 0 to 12, nomad camps
NOMAD_CAMP minus 0 to 3, kingdom dungeons DESERT_DUNGEON minus 0
to 4, and villages VillageConst.DEFAULT_OWNER_OFFSET (-400) minus the
kingdom id less one, -399 to -403.
ABG_CULTISTS is the same id as VOLCANO_DUNGEON, so
NPCOwner(-222) is VOLCANO_DUNGEON.
Client: DungeonConst (dll line 19157), OutpostConst (19549),
VillageConst (19897), SpyConst.PLAGUEMONK_OWNER_ID (19757),
ClientConstNPCs (bundle lines 5046-5047),
CastleNPCOwnerFactory.generateUnknownNPC (14582)
Attributes:
enums.messages¶
Mailbox message types and the subtypes of spy and battle logs.
Classes:
| Name | Description |
|---|---|
MessageType |
What a mailbox message is. |
LogResult |
How the mission or battle a spy log or battle log reports ended. |
BattleLogAttackType |
The kind of attack a battle log reports: the second number of its header. |
Bases: IntEnum
What a mailbox message is.
Client: MessageConst.MESSAGE_TYPE_* and MESSAGE_RUIN_INFO (dll line 19516)
Attributes:
Bases: IntEnum
How the mission or battle a spy log or battle log reports ended.
The second number of a spy log's header, the third of a battle log's. A spy log's spies were lost when the attacker failed or the defender succeeded.
Client: MessageConst.SUBTYPE_ATTACKER_* and SUBTYPE_DEFENDER_* (dll line 19516),
AMessageSpyVO.isFailedSpyLog (bundle line 40204)
Attributes:
| Name | Type | Description |
|---|---|---|
ATTACKER_SUCCESS |
|
|
DEFENDER_SUCCESS |
|
|
ATTACKER_FAILED |
|
|
DEFENDER_FAILED |
|
enums.movements¶
Army movement types.
Classes:
| Name | Description |
|---|---|
MovementType |
Army movement type, the |
Bases: IntEnum
Army movement type, the T of a movement record.
A returning army is not a type: any type can be on its way home, which is
the movement's D flag. SIEGE and OCCUPY_FACTION keep the client's
names; the game shows both as occupations (see is_occupation).
Client: ClientConstCastle.MOVEMENTTYPE_* (bundle line 1004)
Attributes:
| Name | Type | Description |
|---|---|---|
ATTACK |
|
|
DEFENCE |
|
|
TRAVEL |
|
|
SPY |
|
|
MARKET |
|
|
SIEGE |
|
|
TREASUREHUNT |
|
|
NPC_ATTACK |
|
|
PLAGUEMONK |
|
|
OCCUPY_FACTION |
|
|
ALIEN_ATTACK |
|
|
FACTION_ATTACK |
|
|
ALLIANCE_CITY_ATTACK |
|
|
ALLIANCE_CAMP_TAUNT_ATTACK |
|
|
ALLIANCE_CAMP_ATTACK |
|
|
COLLECTOR |
|
|
COLLECTOR_TEMP_SERVER |
|
|
RANKSWAP_TEMP_SERVER |
|
|
DAIMYO_TOWNSHIP_DEFENSE |
|
|
DAIMYO_TAUNT_ATTACK |
|
|
DAIMYO_CASTLE_ATTACK |
|
|
ALLIANCE_BATTLE_GROUND_COLLECTOR_ATTACK |
|
|
TEMPSERVER_PVE_CHARGE |
|
|
TEMPSERVER_PVP_CHARGE |
|
|
ABG_ALLIANCE_TOWER_SUPPORT |
|
|
ABG_ALLIANCE_TOWER_ATTACK |
|
|
WOLFKING_TAUNT_ATTACK |
|
|
is_attack |
bool
|
Types the client parses as an attack army ( |
is_support |
bool
|
Types the client parses as a support army ( |
is_occupation |
bool
|
Types the client parses as |
class-attribute
instance-attribute
¶
property
¶
is_attack: bool
Types the client parses as an attack army (ArmyAttackMapmovementVO or a subclass).
property
¶
is_support: bool
Types the client parses as a support army (SupportDefenceMapmovementVO).
property
¶
is_occupation: bool
Types the client parses as SiegeMapmovementVO: an occupation, SIEGE and OCCUPY_FACTION.
Players see it as the "Occupying forces" that hold an area after a capture attack won
(RenderSiege, bundle line 67408, dialog_moveOverview_siege). The capture attack
before it is an attack whose attack type is conquer (isConquerMovement, bundle line 14404).
enums.player¶
Player progress constants.
Classes:
| Name | Description |
|---|---|
TitleSystem |
A title system: the |
PremiumAccountType |
The premium account's type, a |
MercenaryMissionState |
Where a mercenary mission stands, an |
MercenaryMissionRarity |
A mercenary mission's rarity, an |
Bases: IntEnum
The premium account's type, a boi's PT.
Client: PremiumConst.PREMIUM_ACCOUNT_* (dll line 19628), compared with PT in
TaxConst.getCollectorC2Costs (dll line 19779); PT also indexes the three-entry
PremiumConst.FACTOR_* arrays (dll lines 19622-19625, bundle line 90238)
Attributes:
| Name | Type | Description |
|---|---|---|
BRONZE |
|
|
SILVER |
|
|
GOLD |
|
Bases: IntEnum
Where a mercenary mission stands, an mpe mission's S.
Client: CastleMercenaryData.MISSION_STATE_DEFAULT to MISSION_STATE_COLLECTED (bundle line 28881)
Attributes:
| Name | Type | Description |
|---|---|---|
OPEN |
|
|
STARTED |
|
|
COLLECTABLE |
|
|
COLLECTED |
|
enums.ranking¶
Highscore list types.
Classes:
| Name | Description |
|---|---|
RankingType |
A highscore list, the |
Bases: IntEnum
A highscore list, the LT of hgh, llsp, llsw and slse.
The client's PLAYER_BUILDINGS (6) and ALLIANCE_BUILDINGS (11) are
other names for PLAYER_MIGHT_POINTS and ALLIANCE_MIGHT_POINTS.
Client: HighscoreConst (dll line 19438)
Attributes:
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
class-attribute
instance-attribute
¶
enums.rewards¶
Free daily reward constants.
Classes:
| Name | Description |
|---|---|
LoginBonusSpecial |
A special login bonus, collected instead of a pick: the alliance or the VIP bonus. |
enums.spy¶
Spy mission types, spy log subtypes and spy-report army positions.
Classes:
| Name | Description |
|---|---|
SpyType |
Kind of spy mission, the ST field of |
SpyLogType |
Kind of mission a spy log in the mailbox is about: the first number of its header. |
SpyArmySection |
A position in a spy report's army block, in wire order. |
SpyStep |
The command a spy mission was at when it ended. |
SpyOutcome |
How a spy mission ended. |
Bases: IntEnum
Kind of spy mission, the ST field of csm and of a spy movement.
SE in csm is the accuracy (50-100) for a military or economy
mission and the damage (10-50) for sabotage. The client sends plague
monks with cpm, never with csm.
Client: ClientConstCastle.SPYTYPE_* (bundle line 1004),
CastlePostSpyDialog.spyCastle (bundle line 38459),
CastleSpyDialogPlagueState.spyCastle (bundle line 72135)
Attributes:
| Name | Type | Description |
|---|---|---|
MILITARY |
|
|
ECO |
|
|
SABOTAGE |
|
|
PLAGUE |
|
Bases: IntEnum
Kind of mission a spy log in the mailbox is about: the first number of its header.
These differ from SpyType: a military mission's log is DEFENCE.
SABOTAGE (0) is also the subtype of an aborted mission.
Client: MessageConst.SUBTYPE_SPY_* (dll line 19516)
Attributes:
| Name | Type | Description |
|---|---|---|
SABOTAGE |
|
|
DEFENCE |
|
|
ECO |
|
|
PLAGUE_MONK |
|
A position in a spy report's army block, in wire order.
Iterating the enum gives the order the client shifts the S entries in;
RESERVE is optional and only read when an entry is left.
Client: CastleSpyArmyInfoVO.parseArmyInfo (bundle line 30699)
Attributes:
| Name | Type | Description |
|---|---|---|
LEFT |
|
|
MIDDLE |
|
|
RIGHT |
|
|
KEEP |
|
|
STRONGHOLD |
|
|
SUPPORT |
|
|
RESERVE |
|
|
is_wall |
bool
|
One of the flanks (left, middle, right) an attack on the wall meets. |
How a spy mission ended.
Attributes:
| Name | Type | Description |
|---|---|---|
SUCCESS |
The report was read. |
|
SENT |
The mission was sent; its report is not waited for. |
|
NO_SPIES_AVAILABLE |
No spy was free, after polling |
|
RISK_OVER_BUDGET |
Even the whole pool stays above the risk ceiling, so nothing was sent. |
|
COMMAND_FAILED |
A request failed; |
|
TIMEOUT |
No report for this mission arrived before the deadline. |
|
REPORT_TARGET_MISMATCH |
Only reports for other areas of the target's owner arrived before the deadline. |
|
DISCONNECTED |
The connection dropped while waiting for the report. |
|
CANCELLED |
The caller cancelled; |
|
SPY_CAUGHT |
The spies were caught or kept away. |
|
NO_SPY_DATA |
The mission brought no army back, or the server has no report ( |
class-attribute
instance-attribute
¶
The mission was sent; its report is not waited for.
class-attribute
instance-attribute
¶
No spy was free, after polling ssi for returning spies.
class-attribute
instance-attribute
¶
Even the whole pool stays above the risk ceiling, so nothing was sent.
class-attribute
instance-attribute
¶
A request failed; SpyResult.error holds why and step which one.
class-attribute
instance-attribute
¶
No report for this mission arrived before the deadline.
class-attribute
instance-attribute
¶
Only reports for other areas of the target's owner arrived before the deadline.
class-attribute
instance-attribute
¶
The connection dropped while waiting for the report.
class-attribute
instance-attribute
¶
The caller cancelled; SpyResult.mission is set when the spies had
already left, and they keep going until recalled.
class-attribute
instance-attribute
¶
The spies were caught or kept away.
class-attribute
instance-attribute
¶
The mission brought no army back, or the server has no report (bsd
error 130 or 66, then in SpyResult.error); the area is not known to
be empty.