UI Symbols Documentation

Contexts

Campaign

CcoCampaignAncillary

Component context wrapper for a campaign ancillary

Functions

Name	Return Type	Arguments	Description	Tags
ColourText	UniString	Void	Returns localised colour text from record
ProvidedBodyguards	ContextList	Void	Returns list of CcoMainUnitRecord that are provided as bodyguards as a result of ancillary being equipped
TypeIconPath	String	Void	Returns the icon path for the ancillary type
EffectText	UniString	Void	Returns localised effect text from record
MarkAsSeen	Void	Void	Marks the equipment as seen so that HasSeen will return false
EffectList	CcoEffect (list)	Void	Returns a list of CcoEffect given by this ancillary when equipped, prefiltered to not show those that shouldnt appear in ui
FuseTooltip	UniString	CcoCampaignAncillary	Returns the tooltip for fusing with the passed in ancillary
EffectUnfilteredList	CcoEffect (list)	Void	Returns a list of CcoEffect given by this ancillary when equipped, includes those not shown in ui	hide_in_uied
HasSeen	Bool	Void	Returns true if the user has already 'seen' this ancillary (MarkAsSeen has been called on it). This is to highlight new equipment
IsFusable	Bool	Void	Returns true if this ancillary can ever be fused.
TurnsEquipped	Int	Void	Returns the number of turns this has been equipped
CanCharacterEquip	Bool	CcoCampaignCharacter	Returns true if specified character can equip this ancillary
Salvage	Void	CcoCampaignFaction (optional)	Salvages the ancillary.
Name	UniString	Void	Returns localised name of ancillary
IconPath	String	Void	Returns icon path for images
SalvageValue	CcoCampaignResourceTransaction	CcoCampaignFaction (optional)	Returns an int with the value of the ancillary if it were to get salvaged.
EquipToCharacter	Void	CcoCampaignCharacter, CcoCampaignAncillary	Equips itself to the specified character, and swaps with the ancillary passed in if this exists.
RemoveAncillary	Void	Void	Removes itself from the character that it's equipped to.
AncillaryRecordContext	CcoAncillaryRecord	Void	Returns the ancillary record context.
CharacterEquippedToContext	CcoCampaignCharacter	Void	Returns the player character context where this ancillary is equipped, if any.
CanFuse	Bool	CcoCampaignAncillary	Returns true if can fuse with the specified ancillary
FuseForPlayer	Void	CcoCampaignAncillary	Fuses with the specified ancillary for the players faction (if possible)

CcoCampaignAreaOfInterest

Functions

Name	Return Type	Arguments
Key	Void	Void
Title	Void	Void
EffectBundleList	Void	Void
EffectList	Void	Void
IsMouseOver	Void	Void
Position	Void	Void
ZoomToClosest	Void	Void
Description	Void	Void
IconPath	Void	Void

CcoCampaignArmoryItemVariant

Class that wraps a family member and an armory item variant that this family member owns

Functions

Name	Return Type	Arguments	Description
IsCompatibleWithAgentSubtype	Bool	Void	Returns true if this variant if compatible with the agent subtype of the family member
EquipItemVariant	Void	Void	Equips this variant to the family member
IsEquipped	Bool	Void	Returns true if this variation is equipped on the character
CanEquipItem	Bool	Void	Returns true if this item can be equipped on the family member
ConflictingItemVariantList	CcoArmoryItemVariantRecord (list)	Void	Returns a list with all the armory item variants that conflict with this item.
IsAvailable	Bool	Void	Returns true if this variation is available to the family member
ArmoryItemVariantRecordContext	CcoArmoryItemVariantRecord	Void	Returns the context of the armory item variant
CharacterContext	CcoCampaignCharacter	Void	Returns the context of the character that owns this variant
UnequipItemVariant	Void	Void	Unequips this variant from the family member
EquipItemSet	Void	Void	Equips the set that this item is part of

CcoCampaignArmyPlague

Functions

Name	Return Type	Arguments	Description
SelectPlague	Void	CcoPlagueRecord	Selects the plague with the CcoPlagueRecord passed in
UnlockedPlagueList	CcoPlagueRecord (list)	Void	Returns a list of CcoPlagueRecord with the plagues that have been unlocked for this faciton
ActivePlagueContext	CcoCampaignBasePlague	Void	Returns a CcoCampaignBasePlague with the plague that is currently applied to the army
PlagueList	CcoCampaignBasePlague (list)	Void	Returns a list of CcoCampaignBasePlague with all plague for this faction

CcoCampaignBasePlague

Wrapper for a base plague

Functions

Name	Return Type	Arguments	Description
PlagueEffectContext	CcoPlagueEffectRecord	Void	Returns a CcoPlagueEffectRecord which contains all effect bundles for this plague
PlagueCompositionContext	CcoCampaignPlagueComposition	Void	Returns a CcoCampaignPlagueComposition which a plague composition with this base plague
Description	UniString	Void	Returns the description of the plague (currently taken from any of the effect bundles
PlagueRecordContext	CcoPlagueRecord	Void	Returns the record of the plague
Key	String	Void	Returns record key for the plague
Name	UniString	Void	Returns the name of the plague (currently taken from any of the effect bundles

CcoCampaignBattle

This is the wrapper for pending battles in campaign, use to get information for prebattle/postbattle screen

Functions

Name	Return Type	Arguments	Description
QuestBattleKey	String	Void	Returns set piece battle key for quest battle if this battle is a quest battle
IsActive	Bool	Void	Returns true if there is currently a pending battle (in prebattle or postbattle screen)
IsQuestBattle	Bool	Void	Returns true if current battle is a quest battle

CcoCampaignBuilding

Functions

Name	Return Type	Arguments	Description
UniqueId	String	Void	Returns the unique identifier of the building
IsAbandoned	Bool	Void	Returns true if this building is abandoned
IsRuined	Bool	Void	Returns true if this building is ruined
FoodCost	Int	Void	Returns an int with the amount of food this building is consuming
HealthPercent	Float	Void	Returns the health percentage of this building
UpkeepCost	Int	Void	Returns the upkeep cost of the building
DismantleRefundAmount	Int	Void	Returns the amount of gold this building will give when dismantled
Health	Int	Void	Returns the current health of the building
MaxHealth	Int	Void	Returns the maximum health of the building
BuildingCultureVariantRecordContext	CcoBuildingCultureVariantRecord	Void	Returns the culture variant from the faction that owns this building
EffectList	ContextList	Void	Returns a list of effects provided by this building
LongDescription	UniString	Void	Returns a long description of the building
BuildingLevelRecordContext	CcoBuildingLevelRecord	Void	Returns the context of the building level record from this building
Name	UniString	Void	Returns the name of the building
ShortDescription	UniString	Void	Returns a short description of the building
IsDamaged	Bool	Void	Returns true if this building is damaged
CanUpgrade	Bool	Void	Returns true if this building can be upgraded

CcoCampaignBuildingLifecycleState

Functions

Name	Return Type	Arguments	Description
SetCanLoop	Void	Bool	Sets the lifecycle to loop or not depending on the value of the bool passed in
BuildingCultureVariantRecordContext	CcoBuildingCultureVariantRecord	Void	Returns the building culture variant of the next building level
CanLeaveState	Bool	Void	Returns true if the lifecycle can leave the current state
CanLoop	Bool	Void	Returns true if the lifecycle is allowed to loop instead of demolishing the building at the end of the cycle
NextBuildingLevelContext	CcoBuildingLevelRecord	Void	Returns the building level which is currently in transition
CanEnterNextState	Bool	Void	Returns true if the lifecycle can transition to the next state
TurnsUntilNextState	Int	Void	Returns the amount of turns until the lifecycle transitions to the next building level
CurrentBuildingLevelContext	CcoBuildingLevelRecord	Void	Returns the building level whose effects are currently active

CcoCampaignBuildingSlot

Functions

Name	Return Type	Arguments	Description
CanConvert	Bool	Void	Returns true if the building in this slot can be converted to another building
Tooltip	UniString	Void	Returns a tooltip for this slot
PossibleBuildingSetList	CcoBuildingSetRecord (list)	Void	Returns a list of building sets that could be built in this slot
IsBuildingNew	Bool	Void	Returns true if there is a new building being built in this slot
HasInstantUpgradeFeature	Bool	Void	Returns true if this building slot has the feature to be instantly constructed
RepairCostTooltip	UniString	Void	Returns a tooltip with the cost to repair the building
PossibleBuildingChainsList	CcoBuildingChainRecord (list)	Bool (optional)	Returns a list with all the possible building chains that can be constructed in this slot
PossibleUpgradeList	CcoBuildingLevelRecord (list)	Bool (optional)	Returns a list of the possible upgrades from this slot. Optional bool parameter to specify whether want all buildable infos
RepairResourceContext	CcoCampaignResourceTransaction	Void	Returns the context of the pooled resource needed to repair a the building
IsPlayerFaction	Bool	Void	Returns true if this slot is owned by the player faction
CanDismantle	Bool	Void	Returns true if the building in this slot can be dismantled
PossibleDowngradeList	CcoBuildingLevelRecord (list)	Void	Returns a list with the possible downgrades in this slot
InstantUpgradeCostContext	CcoCampaignResourceTransaction	Void	Returns a CcoCampaignResourceTransaction with the transaction needed to instantly upgrade the building. Returns null is cannot instantly upgrade
ForeignSlotDiscoveredByFaction	Bool	CcoCampaignFaction	Returns true if this foreign slot has been discovered by the faction passed in
CanUpgrade	Bool	Void	Returns true if the building in this slot can be upgraded.
FactionContext	CcoCampaignFaction	Void	Returns the context of faction that owns this slot
IsAlliedSlot	Bool	Void	Returns true if this slot is an allied foreign slot
ShouldShowSlot	Bool	Void	Returns true if this slot can be currently shown in the ui
BuildingSlotList	CcoCampaignBuildingSlot (list)	Void	Returns a list with all the slots that exist on the slot manager
CanShowOptionsPopup	Bool	Void	Returns true if this slot can show the option popup that shows if the slot can be repaired, dismantled etc.
CanRepair	Bool	Void	Returns true if this building can be repaired (usually true when this building is damaged)
IsPrimary	Bool	Void	Returns true if this is the main/primary slot
UpgradeToFirstAvailableOption	Void	Void	If this slot can be upgraded, it just constructs the first possible upgrade. This is currently used for outposts where only one building option is available
CanShowUpgradeOptions	Bool	Void	Returns true if this slot can show a list of its upgrades
ConstructionItemContext	CcoCampaignConstructionItem	Void	Returns the context of the construction item (if building is demolishing, constructing etc)
IsPort	Bool	Void	Returns true if this slot is a port
RemoveForeignSlotManager	Void	CcoCampaignFaction (optional)	Removes the foreign slot manager associated with this slot, if this is a foreign slot. Optional can pass in the faction that wants to remove the manager
ShouldShowCategoriesPopup	Bool	Void	Returns true if this slot should show the categories popup
PlayerVariantBuildingChainContext	CcoBuildingChainRecord	Void	Returns the context of the player variant of the building in this slot
InstantUpgrade	Void	Void	Command that will instantly construct the current construction item
IsForeignSlot	Bool	Void	Returns true if this is a foreign slot
IsRegionSlot	Bool	Void	Returns true if this is a region slot
IsActive	Bool	Void	Returns true if the slot is active (not locked by primary slot requirement)
PrimarySlotContext	CcoCampaignBuildingSlot	Void	Returns the context of the primary slot from the slot manager, is any exists
CancelConstruction	Void	Bool	Command that cancels the current construction
CanAbandon	Bool	Void	Returns true if this is a region slot and the settlement that owns it can be abandoned
LifecycleStateContext	CcoCampaignBuildingLifecycleState	Void	Returns the context of the lifecycle state, if this slot contains a cyclic building
IsEmpty	Bool	Void	Returns true if there is no building in this slot.
IsPartOfCapital	Bool	Void	Returns true if this slot is part of capital.
Dismantle	Void	Void	Command that will dismantle the current building in the slot
SkavenDiscoverabilityThreshold	Int	Void	Returns the threshold of the skaven underworld empire being discovered
RemovalCost	Int	Void	Returns an int with how much it costs to remove the manager associated with this slot. Works only with foreign slots
CharacterContext	CcoCampaignCharacter	Void	Returns the context of the character that owns this slot, if any exists
IsHordeSlot	Bool	Void	Returns true if this is a horde slot
Construct	Void	CcoBuildingLevelRecord	Command that will construct the building level record passed in
RepairCost	Int	Void	Returns an int with how much it costs to repair this building
SettlementContext	CcoCampaignSettlement	Void	Returns the context of the settlement that owns the slot, if the slot if a region slot or a foreign slot.
IsConverting	Bool	Void	Returns true if the building in this slot is being converted.
BuildingRequirementsMet	Bool	CcoBuildingLevelRecord	Returns whether all dependent buildings have been built for the provided building level
PossibleUpgradeWithoutConversionsList	CcoBuildingLevelRecord (list)	Void	Returns a list with the possible upgrades in this slot, without any conversions.
AvailableDevelopmentPoints	Int	Void	Returns an int with the available development points of the owner of the building
IsDismantling	Bool	Void	Returns true if the building in this slot is being dismantled.
Repair	Void	Void	Command that will repair the current building in the slot
BuildingContext	CcoCampaignBuilding	Void	Returns the context of the building on this slot, if it has any
IsRepairing	Bool	Void	Returns true if the building in this slot is being repaired
PooledResourceDemolishTooltip	UniString	Void	Returns a tooltip for when demolishing recoups pooled resources
CanAffordInstantUpgrade	Bool	Void	Returns true if can afford to instantly construct in this slot
Index	Int	Void	Returns an int with the index of this slot in the slot list
SkavenDiscoverabilityFactorialList	CcoStringValue (list)	CcoCampaignFaction	Returns a list of factors that affected the skaven discoverability
IsUpgrading	Bool	Void	Returns true if the building in this slot is being upgraded.
HasConstructedBuilding	Bool	String	Returns true if the given building has been constructed in this slot
SlotActivateLevel	Int	Void	Returns the primary slot level when this slot will get unlocked
PossibleUpgradeOnlyConversionsList	CcoBuildingLevelRecord (list)	Bool (optional)	Returns a list with the possible conversions in this slot

CcoCampaignBuildingVariant

Functions

Name	Return Type	Arguments
ShortDescription	Void	Void
LongDescription	Void	Void
OnscreenName	Void	Void
OnscreenNameKey	Void	Void
BuildingLevelContext	Void	Void
CulturalVariantKey	Void	Void
Level	Void	Void
MaxLevel	Void	Void
FactionKey	Void	Void
Key	Void	Void
IconFilename	Void	Void
InfoFilename	Void	Void

CcoCampaignCaravan

Wrapper for a campaign caravan

Functions

Name	Return Type	Arguments	Description
Position	Vector4	Void	Returns the current display position of the caravan
PathNodeList	CcoCampaignRouteNode (list)	Void	Returns the a list of nodes that the caravan will transverse next
TurnsUntilReturn	Int	Void	Returns the turns until the caravan goes back to the starting point, this will only be > 0 after the caravan reaches its destination
MaximumCargo	Int	CcoCaravanContractRecord	Maximum cargo for the caravan and passed in contract
IsReturning	Bool	Void	Returns true if the caravan has already reached its destination and is now returning back to the starting point
BestJourneyTimeForNode	Int	CcoCampaignRouteNode	Time it takes to reach this node from destination if we take the best route
ClearStartingPath	Void	Void	Clears the starting path of the caravan
CargoAmount	Int	Void	Returns the amount of cargo that this caravan currently has
IsReserve	Bool	Void	Returns true if this is a reserve caravan
SetAutoPathTowardsNode	Void	CcoCampaignRouteNode, CcoCaravanContractRecord (optional)	Sets the caravan path towards the node passed in, if it's possible
DestinationNodeContext	CcoCampaignRouteNode	Void	Returns a CcoCampaignRouteNode context with the destination node choice of the player
SetStartingNode	Void	CcoCampaignRouteNode	Sets the starting node for this caravan
ChangePathSegment	Void	CcoCampaignRouteSegment, CcoCaravanContractRecord (optional)	Changes the current path to include the segment passed in an updates the rest of the path to make sure it's valid
StartingNodeContext	CcoCampaignRouteNode	Void	Returns a CcoCampaignRouteNode context with the starting node choice of the player
ContractContext	CcoCaravanContractRecord	Void	Returns a CcoCaravanContractRecord with the current contract for this caravan, if any
TravelledPathNodeList	CcoCampaignRouteNode (list)	Void	Returns the a list of nodes that the caravan has already traversed
CurrentNodeContext	CcoCampaignRouteNode	Void	Returns a CcoCampaignRoute node context where the caravan is currently positioned
CharacterContext	CcoCampaignCharacter	Void	Returns a CcoCampaignCharacter with the character that owns the caravan

CcoCampaignCaravanRecruitmentItem

Wrapper for a campaign FACTION_CARAVANS struct

Functions

Name	Return Type	Arguments	Description
CharacterContext	CcoCampaignCharacter	Void	Returns the caravan master character context
RecruitmentCost	Int	Void	Returns the cost to recruit this caravan master
RecruitmentRank	Int	Void	Returns the rank at which this caravan master will be spawned

CcoCampaignCharacter

Component context wrapper for a campaign character

Functions

Name	Return Type	Arguments	Description	Tags
IsWounded	Bool	Void	Returns true if this character is wounded
HighlightCharacter	Void	Bool	Highlights the character applying a visual effect to model on campaign (pass true to highlight, false to disable highlight)
IsIgnoredFromEndTurnNotifications	Bool	Void	Returns true if character is in end turn notification ignore list
InitiativeSetList	CcoCampaignInitiativeSet (list)	Void	Returns list of CcoCampaignInitiativeSet available to character
FactionFlagRotated	String	Void	Returns the filepath for rotated faction flag. PREFER to use FactionFlagDir	deprecated
PlagueCompositionContext	CcoCampaignPlagueComposition	Void	Returns a CcoCampaignPlagueComposition with the plague composition of this character, if any
TurnsToResurrection	Int	Void	Returns how many turns will be until character gets resurrected and is available again
IsOnScreen	Bool	Void	Returns true if this character is currently on screen
IsTravellingInTeleportationNode	Bool	Void	Returns true if the character is travelling in a teleportation node
ArmoryItemVariantList	CcoCampaignArmoryItemVariant (list)	Void	Returns a list with all the armory item variants that are registered to this character.
Upkeep	Int	Void	Returns the cost to maintain this character per turn (if army this is for whole army not just the individual)
CanUseAncillaryCategory	Bool	CcoAncillariesCategoryRecord	Returns true if this character can use the ancillary category passed in.
RadarIconPath	String	Void	Returns the icon path used for display on minimap
SettlementContext	CcoCampaignSettlement	Void	Returns a CcoCampaignSettlement with the settlement the character is currently in. Can be null for example if at sea
IsOnLand	Bool	Void	Returns true if this character is currently positioned on land and not sea
ToggleIgnoreFromEndTurnNotifications	Void	Void	Toggles adding or removing the character from the end turn notification ignore list based on whether it's already in the list or not
SelectSkillChoice	Void	CcoCampaignCharacterSkill	Selects the specified skill ready to be committed
FactionFlagMedium	String	Void	Returns the filepath for medium faction flag. PREFER to use FactionFlagDir	deprecated
IsFactionLeader	Bool	Void	Returns true if this character is a faction leader
CurrentXp	Int	Void	Returns the current raw xp value
HiddenSkillList	CcoCampaignCharacterSkill (list)	Void	Returns a list of CcoCampaignCharacterSkill that are hidden to the UI
AutoManagementContext	CcoCampaignCharacterAutoManagement	Void	Returns a CcoCampaignCharacterAutoManagement that handles auto management logic for this character
IsColonel	Bool	Void	Returns true if this character is a colonel (temporary general until general replaced on players next turn)
Rename	Void	Void	Brings up a dialog to rename this character
NextLevelThreshold	Int	Void	Returns the raw threshold level CurrentXP needs to be to reach next rank
IsAlive	Bool	Void	Returns true if this character is alive
CanOpenDetails	Bool	Void	Returns true if character details can be opened for this character
TeleportationSystemContext	CcoCampaignCharacterTeleportationSystem	Void	Returns a CcoCampaignCharacterTeleportationSystem that manages the character interacting with the teleportation network system
FactionFlagLarge	String	Void	Returns the filepath for large faction flag. PREFER to use FactionFlagDir	deprecated
IsPlayerCharacter	Bool	Void	Returns true if this character belongs to the player
CharacterTypeIconPath	String	Void	Returns the character type icon path
IsGarrisonCommander	Bool	Void	Returns true if this character is the commander of a settlement garrison
ClearSkillChoice	Void	CcoCampaignCharacterSkill	Clears specified skill choice currently made
CanBeLoadedInCampaign	Bool	Void	Returns true if character can be loaded in campaign and false if can only be loaded in custom battle
ChaosRealmTraitsList	CcoCharacterTraitLevelRecord (list)	Void	Returns list of CcoCampaignTrait that this character has that were gained in the chaos realms, these are highlighted in the UI in different ways
Rank	Int	Void	Returns the current rank level
CaravanContext	CcoCampaignCaravan	Void	Returns the CcoCampaignCaravan associated with this character if it exists
ClearAllSkillChoices	Void	Void	Clears all skill choices currently made
IsGarrisoned	Bool	Void	Returns true if this character is garrisoned
FactionFlagSmall	String	Void	Returns the filepath for small faction flag. PREFER to use FactionFlagDir	deprecated
IsAgent	Bool	Void	Returns true if this character is an agent
SkillList	CcoCampaignCharacterSkill (list)	Void	Returns list of CcoCampaignCharacterSkill that are available to a character (regardless of current state)
TransportedInMilitaryForceContext	CcoCampaignMilitaryForce	Void	Returns a CcoCampaignMilitaryForce with the force in which this character is part of (useful for getting force that an agent is part of)
IsInMotion	Bool	Void	Returns true if character is currently moving
CommitSkillChoices	Void	Void	Commits skills choices currently made
ActorVO	Int	Void	Returns the actor vo id
HasUncommitedSkills	Bool	Void	Returns true if this character has skill choices made but not committed (clicked on skills but not applied by closing screen for example)
CQI	Int	Void	Returns the unique command queue index of the character
TurnsLockedInLimbo	Int	Void	Returns the number of turns that the character will be locked in limbo. E.g. Packed up ogre camps stay in limbo for a number of turns.
UnitDetailsContext	CcoUnitDetails	ExpressionState	Returns the CcoUnitDetails for unit for use on unit info panel that shows unit stats from various sources
CanRecallSpawnedForce	Bool	Void	Checks if the spawned force can be recalled
ImageCardPath	String	Void	Returns portrait image path used on unit cards
CategoryIconPath	String	ExpressionState	Returns the unit category icon path
CanRename	Bool	Void	Returns true if this character can be renamed (immortal characters cannot be renamed for example)
ResetAllSkills	Void	Void	Resets all skills for this character and wounds them for a short period
TraitsList	CcoCharacterTraitLevelRecord (list)	Void	Returns list of CcoCampaignTrait that this character has
FamilyMemberCQI	Int	Void	Returns the unique command queue index of the family member
GovernorshipInteractionContext	CcoCampaignGovernorshipInteraction	Void	Returns the CcoCampaignGovernorshipInteraction for governor related queries/commands
IsSaveable	Bool	Void	Returns true if character can be saved as part of persistent character feature (so can load in other campaigns or custom battle)
AncillaryList	CcoCampaignAncillary (list)	Void	Returns list of equipped CcoCampaignAncillary
Select	Void	Bool (optional)	Selects this character. Plays character selection voice line. Pass false to not play VO.
CanAffordMovePreview	Bool	Void	Returns true if can afford to perform the current movement preview
IsVisible	Bool	Void	Returns true if character visible to player on map (not shrouded, hidden, etc)
SkillPointsAvailable	Int	Void	Returns the current amount of skill points have to spend
AgentRecordContext	CcoAgentRecord	Void	Returns the CcoAgentRecord
FactionFlagDir	String	Void	Returns directory faction flag images live in. Use this instead of getting from faction so works correctly for rebels
ActionPointPercent	Float	Void	Returns the remaining action point percent (0-1)
DevKill	Void	Void	Kills the character, useful for dev purposes (NOTE: doesnt kill the force, use CcoCampaignMilitaryForce::DevKill for that)	debug, hide_in_uied
RemainingTravelTime	Int	Void	Returns the remaining travel time of a character
CopyMemoryAddressToClipboard	Void	Void	Copies memory address of internal character to clipboard, useful for conditional breakpoints	debug, hide_in_uied
CanCharacterRankUp	Bool	Void	Returns true if this character can currently rank up
AgentSubtypeRecordContext	CcoAgentSubtypeRecord	Void	Returns the CcoAgentSubtypeRecord
ActionPointPreviewPercent	Float	Void	Returns the previewed action point percent for when previewing stance change or potential move (0-1)
UnitContext	CcoCampaignUnit	Void	Returns the CcoCampaignUnit if this character has one (if commander in army, or agent embedded in army)
EnterLimbo	Void	Bool	Move character to limbo or out of limbo)
PortraitPath	String	Void	Returns portrait image path used on portholes
UnitList	CcoCampaignUnit (list)	Void	Returns list of CcoCampaignUnit in this characters force
IsInLimbo	Bool	Void	Returns true if character is in limbo
Description	UniString	Void	Returns localised description of the character
AuthorityLevel	Int	Void	Returns the authority level
IsSelected	Bool	Void	Returns true if this character is selected
IsGovernor	Bool	Void	Returns true if this character is governing a province
BackgroundSkillContext	CcoCampaignCharacterSkill	Void	Returns to CcoCampaignCharacterSkill for the characters single background skill they start with
DevAddAllArmoryItems	Void	Void	Enables all armory items for character	debug, hide_in_uied
SelectAndZoom	Void	Bool (optional)	Selects and zooms to this character. Plays character selection voice line. Pass false to not play VO.
ZoomTo	Void	Vector4 (optional)	Zooms camera to this character. Can optionally provide an offset for the zoom.
IsPreviewingMove	Bool	Void	Returns true if currently previewing where to move for this character (holding right click down on map with character selected)
IsArmy	Bool	Void	Returns true if this character is a general of an army
CurrentXpPercent	Float	Void	Returns the current XP progress percent to next level (0-1)
SubterfugeLevel	Int	Void	Returns the subterfuge level
EffectBundleUnfilteredList	CcoEffectBundle (list)	Void	Returns list of active CcoEffectBundle, without any filtering (so includes those that dont show in the UI)	hide_in_uied
ShouldShowOnRadar	Bool	Bool (optional)	Returns true if should show on radar/radar lists, this handles all special cases of things we dont want to show like garrisons, etc. By default filters convalescing characters, but pass true in to not do that
CharacterTypeName	UniString	Void	Returns localised character type (general, agent type, faction leader, etc)
DevReRollInitiatives	Void	Void	Re-rolls all initiatives for this character	debug, hide_in_uied
CostForMultipleInitiativesFromSets	CcoCampaignResourceTransaction	ContextList	Gets the cost of initiatives which can come from multiple sets.
DevRankUp	Void	Void	Ranks up the character	debug, hide_in_uied
ActionPointsPerTurn	Int	Void	Returns the total action points available for this character per turn
MilitaryForceContext	CcoCampaignMilitaryForce	Void	Returns the CcoCampaignMilitaryForce if character is a general
IsDetailsOnly	Bool	Void	Returns true if we don't have a ptr to a CHARACTER object which means character is basically dead or doesnt exist yet, so has no live information such as map info, etc
IsOnMap	Bool	Void	Returns true if this character is currently on the map
Position	Vector4	Void	Returns the position on the map, will be VECTOR_4_ZERO if not not on map
FactionName	UniString	Void	Returns the factions localised name (use this instead of getting from faction so works correctly with rebels)
EffectBundleList	CcoEffectBundle (list)	Void	Returns list of active CcoEffectBundle, pre-filtered to only include those that should show in the UI
ZealLevel	Int	Void	Returns the zeal level
TintColour	Colour	Void	Returns the colour tint of the character, in wh3 this is used for daemon prince based on equipment select and alignment to gods
LoyaltyContext	CcoCampaignCharacterLoyalty	Void	Returns the CcoCampaignCharacterLoyalty
ToggleMultipleInitiativesFromSets	Void	ContextList	Toggles a list of initiatives which can come from multiple sets.
DevEnableAllSkills	Void	Void	Enables all the characters skills	debug, hide_in_uied
FactionNameWithIcon	UniString	Void	Returns the factions localised name with icon (use this instead of getting from faction so works correctly with rebels)
BreakForDebugging	Void	Void	Breaks into debugger so can inspect internal object in greater detail	debug, hide_in_uied
CanBeEmbedded	Bool	Void	Returns true if the character can be embedded into an army
ArmoryItemRecordList	CcoArmoryItemRecord (list)	Void	Returns a list with all the armory item records that are registered to this character.
ActionPointsRemaining	Int	Void	Returns the number of action points remaining this turn
CanEquipAncillary	Bool	CcoCampaignAncillary	Returns true if this character can equip the ancillary passed in.
IsEffectPresent	Bool	String	Returns true if the specified effect key is present on the character
InitiativeManager	CcoCampaignInitiativeManager	Void	Returns a CcoCampaignInitiativeManager
DevReplenishAp	Void	Void	Replenishes action points to be full	debug, hide_in_uied
CanUseAp	Bool	Void	Returns true if the character can use action points. Ex. Caravans and Ogre Camps can't use
SkillTree	TreeData	Void	Returns the skill tree data for creating a skill tree
Name	UniString	Void	Returns the localised name
HordeSnapshotBuildingList	CcoBuildingLevelRecord (list)	Void	Returns a list with all the buildings that the horde of this general will get back on resurrection.
FactionContext	CcoCampaignFaction	Void	Returns the CcoCampaignFaction of the character
CanUseArmoryItems	Bool	Void	Returns true if this character can use armory items.
IsActive	Bool	Void	Returns true if this character is currently alive and in use on the map

CcoCampaignCharacterAutoManagement

Wrapper for character auto-management logic

Functions

Name	Return Type	Arguments	Description	Tags	Events
ToggleAutoManaging	Void	Void	Activates the auto management for this character
IsAutoManaging	Bool	Void	Returns true if the character is currently being auto managed by the AI

CcoCampaignCharacterLoyalty

Functions

Name	Return Type	Arguments
IsLoyaltyApplicable	Void	Void
RangeState	Void	Void
OnScreenLoyalty	Void	Void
Loyalty	Void	Void

CcoCampaignCharacterSkill

Component context wrapper for a campaign character skill

Functions

Name	Return Type	Arguments	Description	Tags
Key	String	Void	Returns the campaign skill record key
Status	String	Void	Returns the status of the skill as an unlocalised string (available, complete, locked, etc)
CharacterContext	CcoCampaignCharacter	Void	Returns the owning CcoCampaignCharacter for this skill
Name	UniString	Void	Returns the localised name of the skill
Description	UniString	Void	Returns the localised description of the skill
NextLevelContext	CcoCampaignCharacterSkillLevelDetails	Void	Returns the next CcoCampaignCharacterSkillLevelDetails if add another skill point
DevSetSkillLevel	Void	Int	Sets skill level to specified numeric level. Used for testing skills in dev	debug, hide_in_uied
AddPoint	Void	Void	Adds a point into skill. Effects not applied until committed via character
RemovePoint	Void	Void	Removes a point from skill. Effects not applied until committed via character
SpawningUnitAndRankPairList	CcoPair (list)	Void	Returns a pair with units and their ranks, that characters with this skill will spawn with
CurrentLevelContext	CcoCampaignCharacterSkillLevelDetails	Void	Returns the current CcoCampaignCharacterSkillLevelDetails active
DevCycleSkillLevel	Void	Bool	Cycles skill level in specified direction (true forwards, false backwards) incrementing until reaches max and then resetting back to 0 if reach max. Used for testing skills in dev	debug, hide_in_uied
UnitAttributeList	ContextList	Void	Returns a list of CcoUnitAttributeRecord that we are currently providing
CanRemovePoint	Bool	Void	Returns true if can remove a point (added a point but didnt commit the skill choices)
LevelsDetailsList	ContextList	Void	Returns the list of CcoCampaignCharacterSkillLevelDetails for each level of this skill
EffectUnfilteredList	CcoEffect (list)	Void	Returns a list of CcoEffect that we are currently providing, including those filtered out usually to not show in ui	hide_in_uied
TotalLevels	Int	Void	Returns the max level of the skill
AbilityList	ContextList	Void	Returns a list of CcoUnitAbility that we are currently providing
IsBackgroundSkill	Bool	Void	Returns true if this is a characters background skill (automatic and not chosen)
ChildSkillsList	ContextList	Void	Returns list of CcoCampaignCharacterSkill which are child links to us (unlocked by us)
Indent	Int	Void	Returns the x grid position
EffectList	CcoEffect (list)	Void	Returns a list of CcoEffect that we are currently providing, prefiltered to not show those that shouldnt appear in ui
Level	Int	Void	Returns the current level of the skill
ParentSkillsList	ContextList	Void	Returns list of CcoCampaignCharacterSkill which are parent links to us (we are unlocked by)
ImagePath	String	Void	Returns the image path for the skill
Tier	Int	Void	Returns the y grid position

CcoCampaignCharacterSkillLevelDetails

Component context wrapper for a campaign character skill level details (each CcoCampaignCharacterSkill has multiple levels, each level represented by one of these)

Functions

Name	Return Type	Arguments	Description
UnitAttributeList	ContextList	Void	Returns a list of CcoUnitAttributeRecord provided by this skill level
Level	Int	Void	Returns the level index
RankRequired	Int	Void	Returns the rank required to research this skill level
EffectList	ContextList	Void	Returns list of CcoEffect provided by this skill level
AbilityList	ContextList	Void	Returns list of CcoUnitAbility provided by this skill level
IsLocked	Bool	Void	Returns if this skill level is currently locked

CcoCampaignCharacterTeleportationInteraction

Wrapper for a targetting interface that deals with teleport points on the map

Functions

Name	Return Type	Arguments	Description
SetTarget	Void	Context	Sets the target to the context passed in if valid
EnableTargetting	Void	Bool	Enables or disables the targetting depending on the bool passed in
ClearTarget	Void	Void	Clears the current target
ToggleTargetting	Void	Void	Toggles the targetting from active/inactive
IsTargettingActive	Bool	Void	Returns true if the targetting for this interface is active
IsValidTarget	Bool	Context	Returns true if the passed in target is valid
IsContextTargeted	Bool	Context	Returns whether the given context is targeted. (Allows child classes to add unique targeting conditions)
InvalidReasonsForTarget	UniString	Context	Returns the reason why a target cannot be selected
CurrentTargetContext	Context	Void	Returns the current target selected (should always be a CcoTeleportationNetworkNodeRecord)
SourceCharacterContext	CcoCampaignCharacter	Void	Returns a CcoCampaignCharacter with the interacting character

CcoCampaignCharacterTeleportationSystem

Wrapper for character teleportation logic

Functions

Name	Return Type	Arguments	Description
TravelingToNodeContext	CcoTeleportationNetworkNodeRecord	Void	Returns a CcoTeleportationNetworkNodeRecord with the node that the character is currently traveling to, if any
TeleportationCost	CcoCampaignResourceTransaction	CcoTeleportationNodeTemplateRecord	Returns a CcoCampaignResourceTransaction with much it costs for the character to teleport to the specified node
ClosureCost	CcoCampaignResourceTransaction	Void	Returns a CcoCampaignResourceTransaction with how much it costs for the character to close the node
TeleportationInteractionContext	CcoCampaignCharacterTeleportationInteraction	Void	Returns a CcoCampaignCharacterTeleportationInteraction that manages targetting the nodes on the 3d map
CanCharacterTeleport	Bool	Void	Returns true if the character can teleport (some charcter can only close nodes)
CharacterContext	CcoCampaignCharacter	Void	Returns a CcoCampaignCharacter with the character context
TeleportToRandomNodeInTemplate	Void	CcoTeleportationNodeTemplateRecord	Teleports the character to a random node with the template passed in
CloseTeleportationNode	Void	Void	Closes the teleportation node that the character is interacting with
TeleportToNode	Void	CcoTeleportationNetworkNodeRecord	Teleports the character to the passed in node
CanCloseTeleportationNode	Bool	Void	Returns true if the character can close the node that it's currently interacting with
CanTeleportToNode	Bool	CcoTeleportationNetworkNodeRecord	Closes true if the character can teleport to the passed in node
InteractingNodeContext	CcoTeleportationNetworkNodeRecord	Void	Returns a CcoTeleportationNetworkNodeRecord with the node that the character is currently interacting with, if any

CcoCampaignCharacterTrainingGroup

Wrapper for a campaign training group

Functions

Name	Return Type	Arguments	Description
TreasuryCost	Int	Void	Returns the cost of training a character
LocalisedName	UniString	Void	Returns the localised name of the group
StartCharacterTraining	Void	Void	Starts character training in next available slot
InitialPortraitPath	String	Void	Returns a string with the initial portrait path
CanStartCharacterTraining	Bool	Void	Returns true if character training can be started
TrainingSlotList	CcoCampaignCharacterTrainingSlot (list)	Void	Returns a list with all the training slots in this group, including dummy ones for locked slots
MaximumSlotCount	Int	Void	Returns an int with the maximum slots in the group
FactionContext	CcoCampaignFaction	Void	Returns the faction context of the group
SelectDilemmaChoice	Void	Int, Int	Selects dilemma choice for specified slot index and dilemma choice index

CcoCampaignCharacterTrainingSlot

Wrapper for a campaign training slot

Functions

Name	Return Type	Arguments	Description
TraitList	CcoCharacterTraitLevelRecord (list)	Void	Returns a list with the chosen traits
CharacterPortrait	String	Void	Returns a string with the character portrait path
AgentSubtypeAgentPairContext	CcoAgentSubtypeAgentPair	Void	Returns the selected agent subtype agent pair context
AgentSubtypeAgentPairContextList	CcoAgentSubtypeAgentPair (list)	Void	Returns all possible associated agent subtype agent pair context
AgentContext	CcoAgentRecord	Void	Returns the selected agent context
AgentSubTypeContext	CcoAgentSubtypeRecord	Void	Returns the selected agent subtype context
IsActive	Bool	Void	Returns true if the slot is active
Index	Int	Void	Returns the index of the slot in the training group that it's part of
RemainingDuration	Int	Void	Returns an int with the remaining duration of the slot
IsLocked	Bool	Void	Returns true if the slot is locked
ActiveDilemmaContext	CcoCharacterTrainingDilemmaRecord	Void	Returns the context of the active dilemma, if any
CharacterName	UniString	Void	Returns the name of the character from the slot
IsPurchaseButtonActive	Bool	Void	Returns true if this slot is purchasable
PossibleAbilityGroupList	CcoSpecialAbilityGroupRecord (list)	Void	Returns a list with possible abilities for this slot

CcoCampaignConstructionItem

Functions

Name	Return Type	Arguments
ShortDescription	Void	Void
LongDescription	Void	Void
UpkeepCost	Void	Void
Type	Void	Void
Name	Void	Void
Cost	Void	Void
DevPointCost	Void	Void
IsConversion	Void	Void
BuildingLevelRecordContext	Void	Void
BuildingCultureVariantRecordContext	Void	Void
TotalConstructionTime	Void	Void
PercentComplete	Void	Void
TurnsUnderConstruction	Void	Void
TurnConstructionStarted	Void	Void
IsPaused	Void	Void
TurnsToCompletion	Void	Void
IsDamaged	Void	Void
ClockAnimationState	Void	Void

CcoCampaignCorruptionCounter

Wrapper for a corruption counter

Functions

Name	Return Type	Arguments	Description
Amount	Int	Void	Returns the total amount of corruption from all the corruption types in this counter
Max	Int	Void	Returns the max corruption for this counter
ActiveIntervalList	CcoCorruptionCounterIntervalRecord (list)	Void	Returns a list of intervals that are currently active
IntervalList	CcoCorruptionCounterIntervalRecord (list)	Void	Returns a list of all intervals for this counter

CcoCampaignCursorContext

Component context wrapper for EMPIRECAMPAIGN::CURSOR_OVER_CONTEXT, so can get context information about current 3d mouseover

Functions

Name	Return Type	Arguments	Description	Tags
CurrentCursorKey	String	Void	Returns the current cursor_record key of the cursor being used
FactionContext	CcoCampaignFaction	Void	Returns the faction currently mousing over
LogicalPosition	String	Void	Returns logical position on map currently mousing over as a string	debug
CharacterContext	CcoCampaignCharacter	Void	Returns the character currently mousing over
SettlementContext	CcoCampaignSettlement	Void	Returns the settlement currently mousing over

CcoCampaignDiplomacyManager

Component context wrapper for the campaign diplomacy manager, so we can get pending negotiations for MPC sim turns, etc. Not meant as a full replacement for diplomacy since we dont have resource to rewrite diplomacy to cco in wh3!

Functions

Name	Return Type	Arguments	Description
OpenNegotiation	Void	CcoCampaignFaction	Opens up negotiation in diplomacy to accept/counter/modify if there is one
SentNegotiationList	CcoCampaignNegotiation (list)	Void	Returns a list of CcoCampaignNegotiaton which were sent by the player and are awaiting on responses from other players (only in mpc sim turns)
PendingNegotiationList	CcoCampaignNegotiation (list)	Void	Returns a list of CcoCampaignNegotiaton which are pending for the player (only in mpc sim turns)
NegotiationForFaction	CcoCampaignNegotiation	CcoCampaignFaction	Returns a CcoCampaignNegotiaton for the given proposing faction if there is one

CcoCampaignDiplomacyManipulationInfo

Wrapper for a diplomacy manipulation info

Functions

Name	Return Type	Arguments	Description
DiplomacyManipulationInteractionContext	CcoCampaignDiplomacyManipulationInteraction	Void	Returns the context of the diplomacy interaction of this info
PerformManipulation	Void	CcoCampaignFaction, CcoCampaignFaction (optional), Context (optional)	Performs the manipulation on targets passed in
ResourceTransactionContext	CcoCampaignResourceTransaction	CcoCampaignFaction, CcoCampaignFaction (optional), Context (optional)	Returns the cost for performing the manipulation, taking into account the specified source and objective
OwnerFactionContext	CcoCampaignFaction	Void	Returns the context of the faction that owns this diplomacy manipulation info
CooldownTime	Int	Void	Returns the the total cooldown time of the manipulation info
RemainingCooldown	Int	Void	Returns the remaining cooldown of the manipulation info
DisplayName	UniString	Void	Returns the localised name of the manipulation info
Description	UniString	Void	Returns the description of the manipulation info
Category	String	Void	Returns the category of the manipulation info
Icon	String	Void	Returns the icon path of the manipulation info

CcoCampaignDiplomacyManipulationInteraction

Class that manages targetting interface interaction for a manipulation info

Functions

Name	Return Type	Arguments	Description
IsActionLocked	Bool	Void	Returns true if the manipulation hasn't been unlocked yet
CurrentTargetContext	Context	Void	This will only return if the manipulation type is TRANSFER_SETTLEMENT and we have a settlement target stored. Else returns nul
IsActionBlockedByPendingBattle	Bool	Void	Returns true if the manipulation is blocked by active pending battle
SetTargetSelectionMode	Void	String	Informs the targeter of which mode of selection it should be doing. Valid arguments are as follows: 'force', 'region', 'force_or_region', 'source_faction' & 'objective_faction'
SetObjectiveFaction	Void	CcoCampaignFaction	Sets the objective faction for this manipulation
SetupInitialTargetFaction	Void	CcoCampaignFaction	Does the initial setup of the factions without notifying.
PerformAction	Void	Void	Performs the manipulation with the current source, objective and settlement target, if it can
ShouldDisplayFactionDropdown	Bool	Bool (optional)	Returns true if we should display the faction dropdown in the changing of the way panel
SetTarget	Void	Context	Sets the settlement target or the source/objective faction. Which faction will be set is determined by the m_setting_source flag
UpdateTargetFaction	Void	Void	Updates the faction with the current targetting interface faction. This is so all targetting interfaces are in sync
SetSourceFaction	Void	CcoCampaignFaction	Sets the source faction for this manipulation
EnableTargetting	Void	Bool	Is passed true, enables this as the targetting interface, else disables it.
AverageCorruption	Float	Void	Returns the average corruption between the source and objective factions
ToggleTargetting	Void	Void	Toggles the targetting system through the CampaignTargettingInterface.
ClearTarget	Void	Void	Clears the settlement target is this exists
AverageAttitide	Float	Void	Returns the average relations between source and objective factions
IsValidTarget	Bool	Context	Returns true if the passed in object is valid. Can also be used for checking source/objective factions
ValidSourceFactionList	CcoCampaignFaction (list)	Void	Returns a list of source factions that have at least 1 valid objective faction to target
ZoomToTarget	Void	Void	Zooms to the current settlement target, if this exists.
UsesObjectiveFaction	Bool	Void	Returns true if objective/second faction is needed for the manuipulation type
InvalidReasonsForTarget	UniString	Context	Returns reasons why a target cannot be set. Returns empty if object is valid. This can be used for a settlement or for source/objective faction
ActionPerformTooltip	UniString	Void	Returns a tooltip with reason why cannot perform the manipulation with current setup, or returns specific text if can perform
IsTargettingActive	Bool	Void	Returns true if this is the current targetting interface
ValidObjectiveFactionList	CcoCampaignFaction (list)	Bool (optional)	Returns a list with valid objective factions based on the selected source faction
ObjectiveFactionContext	CcoCampaignFaction	Void	Returns the context of the objective faction stored, if any
CanPerformAction	Bool	Void	Returns true if the manipulation can be performed with the current source faction, objective faction and settlement (if the settlement is needed)
ActionCost	CcoCampaignResourceTransaction	Void	Returns the cost for the manipulation with the current setup
DiplomacyManipulationInfoContext	CcoCampaignDiplomacyManipulationInfo	Void	Returns the context of the diplomacy manipulation info associated with this class
IsContextTargeted	Bool	Context	Returns whether the given context is targeted. (Allows child classes to add unique targeting conditions)
GetTargetSelectionModeString	String	Void	Gets the active target selection mode as a string. May return: 'force', 'region', 'force_or_region', 'source_faction' or 'objective_faction'
SourceFactionContext	CcoCampaignFaction	Void	Returns the context of the source faction stored, if any
SetDefaultTargetSelectionMode	Void	Void	Sets the default target selection mode using the current category

CcoCampaignElectorSeat

Functions

Name	Return Type	Arguments
CharacterContext	Void	Void
MaxLoyalty	Void	Void
LoyaltyPooledResourceContext	Void	Void
SeatHolderFactionHasLoyalty	Void	Void
SeatHolderFactionLoyalty	Void	Void
IsOwnedByNonHumanFaction	Void	Void
IsAbandonedRegion	Void	Void
ShouldShowElectorCountTitle	Void	Void
IsOwnedByPlayer	Void	Void
CanBeRemovedFromSeat	Void	Void
IsOwnedByHumanFaction	Void	Void
FactionContext	Void	Void
ElectorCountRecordContext	Void	Void
SettlementContext	Void	Void
ProvinceContext	Void	Void

CcoCampaignEventAgentTargetsCharacter

Functions

Name	Return Type	Arguments
IsReferingToPlayer	Void	Void
ActionResultContext	Void	Void
DiplomaticStateContext	Void	Void
TargetContext	Void	Void
AgentFactionContext	Void	Void
TargetFactionContext	Void	Void
AgentContext	Void	Void

CcoCampaignEventAgentTargetsSettlement

Functions

Name	Return Type	Arguments
ActionResultContext	Void	Void
AgentContext	Void	Void
TargetContext	Void	Void
AgentFactionContext	Void	Void
DiplomaticStateContext	Void	Void
IsReferingToPlayer	Void	Void
TargetFactionContext	Void	Void

CcoCampaignEventAncillaryOrTrait

Functions

Name	Return Type	Arguments
TraitLevelContext	Void	Void
TraitChainList	Void	Void
AncillaryRecord	Void	Void
Trait	Void	Void
Character	Void	Void
ZoomTo	Void	Void
Stolen	Void	Void
HasZoomLocation	Void	Void
EffectList	Void	Void
Description	Void	Void
Lost	Void	Void
TraitLevelValue	Void	Void
Faction	Void	Void

CcoCampaignEventArmoryItem

Context wrapper for a campaign ARMORY_ITEM custom layout event

Functions

Name	Return Type	Arguments	Description
HasZoomLocation	Bool	Void	Returns true if this event has a zoom location
ArmoryItemContext	CcoArmoryItemRecord	Void	Returns a CcoArmoryItemRecord with the item that was gained
ZoomTo	Void	Void	Zooms to the event location
CharacterContext	CcoCampaignCharacter	Void	Returns a CcoCampaignCharacter with the character that the item is available for

CcoCampaignEventBattleResult

Functions

Name	Return Type	Arguments
AttackingCharacterContext	Void	Void
DefendingBattleResult	Void	Void
PlayersBattleResult	Void	Void
DefendingFactionContext	Void	Void
AttackingBattleResult	Void	Void
DefendingCharacterContext	Void	Void
AttackingFactionContext	Void	Void

CcoCampaignEventBuildingConstructed

Functions

Name	Return Type	Arguments	Description	Tags	Events
Building	CcoCampaignBuildingVariant	Void	Returns a CcoCampaignBuildingVariant with the building variant data

CcoCampaignEventDilemma

Component context wrapper for an event dilemma

Functions

Name	Return Type	Arguments	Description
CampaignVODelay	Float	Void	Returns the delay of VO
SecondaryTargetCharacterContext	CcoCampaignCharacter	Void	Returns the secondary character target
CharacterTargetName	UniString	Void	Returns the character target name (Used for database text)
FirstTargetFactionName	UniString	Void	Returns the character first faction target name (Used for database text)
PrimaryTargetSettlementContext	CcoCampaignSettlement	Void	Returns the primary settlement target
Description	UniString	Void	Returns the description of the dilemma
CampaignVOEventName	String	Void	Returns the event name of VO
CampaignVOActorGroup	Int	Void	Returns the actor group of VO
DilemmaContext	CcoDilemmaRecord	Void	Returns the context of the dilemma record
PrimaryTargetCharacterContext	CcoCampaignCharacter	Void	Returns the primary character target
Category	String	Void	Returns a string with the category of the dilemma
MakeChoice	Void	String	Calls a command to choose the passed in choice
ChoiceKey	String	Void	Returns the key of the choice that has been made for this dilemma, empty if no choice made yet
ZoomTo	Void	Void	Zooms to the dilemma
EventCategory	String	Void	Returns a string with the event category of the dilemma
HasMadeChoice	Bool	Void	Retuns true if a choice has been made
HasZoomLocation	Bool	Void	Returns true if the dilemma has a zoom location
IsChoiceActive	Bool	String	Returns true if the passed in choice key is active/should be displayed
PrimaryTargetFactionContext	CcoCampaignFaction	Void	Returns a CcoCampaignFaction with the primary faction target for the dilemma
CanMakeChoice	Bool	String	Returns true if the choice with the key passed in is possible to be chosen
ChoiceDetailList	CcoCdirEventsDilemmaChoiceDetailRecord (list)	Void	Returns a list of choice details for this dilemma
FirstTargetFactionPooledResource	UniString	String	Returns the first faction pooled resource with the resource key passed in
NumberOfChoices	Int	Void	Returns the number of choices for this dilemma
SecondTargetFactionPooledResource	UniString	String	Returns the second faction pooled resource with the resource key passed in
AdditionalTreasureHuntContext	CcoTreasureHuntExtraInformationRecord	Void	Returns the treasure hunt context if this dilemma is a treasure hunt
SecondTargetFactionNameWithIcon	UniString	Void	Returns the character first faction target name with icon (Used for database text)
PayloadOfChoice	CcoCampaignPayloadInfo	String	Returns the context of the payload for the choice key passed in
RegionTargetName	UniString	Void	Returns the character region target name (Used for database text)
FirstTargetFactionNameWithIcon	UniString	Void	Returns the character first faction target name with icon (Used for database text)
PrimaryTargetMilitaryForceContext	CcoCampaignMilitaryForce	Void	Returns the primary force target
SecondTargetFactionName	UniString	Void	Returns the character second faction target name (Used for database text)
SecondaryTargetMilitaryForceContext	CcoCampaignMilitaryForce	Void	Returns the secondary force target

CcoCampaignEventDiplomacy

Functions

Name	Return Type	Arguments
HasZoomLocation	Void	Void
ZoomTo	Void	Void
IsTreatyBroken	Void	Void
EventIconPath	Void	Void
EventType	Void	Void
FirstFaction	Void	Void
SecondFaction	Void	Void

CcoCampaignEventFaction

Functions

Name	Return Type	Arguments
DiplomaticStateContext	Void	Void
HasZoomLocation	Void	Void
FirstFactionContext	Void	Void
SecondFactionContext	Void	Void

CcoCampaignEventFeed

Context wrapper for the event feed

Functions

Name	Return Type	Arguments	Description
CanCategoryInstantOpen	Bool	CcoEventFeedCategoryRecord	Returns whether this category of events is allowed to instant open
NextAutoOpenEventContext	CcoCampaignEventFeedMessageDetails	Void	Returns the context of the next auto open event if any
ToggleCategoryInstantOpen	Void	CcoEventFeedCategoryRecord	Toggles the passed in category as being or not being allowed to instant open
EventGroupList	CcoCampaignEventFeedGroup (list)	Void	Returns a list of event groups

CcoCampaignEventFeedCustomMission

Component context wrapper for an event mission

Functions

Name	Return Type	Arguments	Description
ZoomTo	Void	Void	Zooms to the location of the mission
Description	UniString	Void	Returns the description of the mission
MissionContext	CcoCampaignMission	Void	Returns a CcoCampaignMission with the mission context
HasZoomLocation	Bool	Void	Returns true if the misison has a zoom location
Title	UniString	Void	Returns the title of the mission
Subtitle	UniString	Void	Returns the subtitle of the mission

CcoCampaignEventFeedFilter

Functions

Name	Return Type	Arguments
ToggleCategory	Void	Void
InclusionState	Void	Void
IsCategoryIncluded	Void	Void

CcoCampaignEventFeedGroup

Functions

Name	Return Type	Arguments
Title	Void	Void
EventList	Void	Void
ShouldAutoExpand	Void	Void

CcoCampaignEventFeedMessageDetails

Functions

Name	Return Type	Arguments	Description
ZoomTo	Void	ExpressionState
IsRead	Bool	Void
IconPath	String	Void
HasZoomLocation	Bool	ExpressionState
CustomContext	Context	Void
HasSepiaFade	Bool	Void	Returns true if the incident has a sepia fade multiplier
MissionContext	CcoCampaignEventFeedCustomMission	Void
UseRevealingText	Bool	Void	Returns true if the event uses revealing text (currently only used for incidents)
EventType	String	Void
IsLargeIncident	Bool	Void	Returns true if we are an incident and event image is over default event size (current 800x450) as we use a different incident layout for these, originally for story panel on wh3
FlavourText	UniString	Void
SepiaFadeMultiplier	Float	Void	Returns the sepia fade multiplier, used for story panels to fade out a few seconds of at the end of the movie
FullFlavourText	UniString	Void
Position	Vector4	Void
PrimaryDetail	UniString	Void
ShouldReposition	Bool	Void
IsUsingLargeImage	Bool	Void	Returns true if event image is over default event size (current 800x450) as we use different component set for larger images for these important events for things like stories in wh3
SecondaryDetail	UniString	Void
MoviePath	String	Void
RequiresResponse	Bool	Void
Title	UniString	Void
EventSound	String	Void
Layout	String	Void
PrimaryDetailsWithTags	UniString	Void
ImagePath	String	Void
SecondaryDetailsWithTags	UniString	Void
MarkAsRead	Void	Void

CcoCampaignEventFeedOpenEvent

Functions

Name	Return Type	Arguments
ShouldReposition	Bool	Void
EventContext	CcoCampaignEventFeedMessageDetails	Void
IconContext	Context	Void

CcoCampaignEventFeedRecords

Functions

Name	Return Type	Arguments
YearContext	Void	Void
StartYear	Void	Void
YearList	Void	Void
EndYear	Void	Void
RoundsList	Void	Void

CcoCampaignEventFeedRound

Functions

Name	Return Type	Arguments
RoundTitle	Void	Void
IsEmpty	Void	Void
SummaryList	Void	Void

CcoCampaignEventFeedSummary

Functions

Name	Return Type	Arguments
MarkAsRead	Void	Void
TotalEvents	Void	Void
IsRead	Void	Void
FirstEventContext	Void	Void
EventList	Void	Void
Title	Void	Void
IconPath	Void	Void

CcoCampaignEventFeedYear

Functions

Name	Return Type	Arguments
CharacterList	Void	Void
FactionList	Void	Void
ProvinceList	Void	Void
RoundsList	Void	Void

CcoCampaignEventHostileAction

Functions

Name	Return Type	Arguments
IsReferingToPlayer	Void	Void
ActingFactionContext	Void	Void
DiplomaticStateContext	Void	Void
ActingCharacterContext	Void	Void
TargetFactionContext	Void	Void

CcoCampaignEventIncident

Context wrapper for a campaign incident

Functions

Name	Return Type	Arguments	Description
FirstTargetFactionName	UniString	Void	Returns the name of the faction of the first target
SecondTargetName	UniString	Void	Returns the name of the second target
HasZoomLocation	Bool	Void	Returns true if this incident can be zoomed to
Description	UniString	Void	Returns the description of the incident
FirstTargetName	UniString	Void	Returns the name of the first target
CampaignVOActorGroup	Int	Void	Returns the actor group of VO
Payload	CcoCampaignPayloadInfo	Void	Returns a CcoCampaignPayloadInfo with the payload of this incident
CampaignVODelay	Float	Void	Returns the delay of VO
ZoomTo	Void	Void	Zooms to the incident location
CampaignVOEventName	String	Void	Returns the event name of VO
Incident	CcoIncidentRecord	Void	Returns a CcoIncidentRecord with the record of this incident
PrimaryTargetMilitaryForceContext	CcoCampaignMilitaryForce	Void	Returns a CcoCampaignMilitaryForce with the primary force target
PrimaryTargetFactionContext	CcoCampaignFaction	Void	Returns a CcoCampaignFaction with the primary faction target
PrimaryTargetCharacterContext	CcoCampaignCharacter	Void	Returns a CcoCampaignCharacter with the primary character target
PrimaryTargetSettlementContext	CcoCampaignSettlement	Void	Returns a CcoCampaignSettlement with the primary settlement target
IsBloodEvent	Bool	Void	Returns true if the blood overlay needs to be shown for this incident
EventCategory	Int	String	Returns an it with the enum index of the event category passed in
SecondTargetFactionName	UniString	Void	Returns the name of the faction of the second target

CcoCampaignEventMercenaryUnitUnlock

Functions

Name	Return Type	Arguments	Description	Tags	Events
Unit	Void	Void

CcoCampaignEventTechnologyResearched

Functions

Name	Return Type	Arguments
ResearchedTechnology	Void	Void
NextTechnology	Void	Void
ZoomTo	Void	Void
Faction	Void	Void
HasZoomLocation	Void	Void

CcoCampaignEventTrainingDilemmaAvailable

Context wrapper for a campaign TRAINING_DILEMMA_AVAILABLE custom layout event

Functions

Name	Return Type	Arguments	Description	Tags	Events
HasZoomLocation	Bool	Void	Returns true if this event has a zoom location
ZoomTo	Void	Void	Zooms to the event location

CcoCampaignEventUnitRecruitment

Functions

Name	Return Type	Arguments
Agent	Void	Void
Name	Void	Void
Description	Void	Void
Unit	Void	Void

CcoCampaignFaction

Wrapper for a campaign faction

Functions

Name	Return Type	Arguments	Description	Tags
IsBankrupt	Bool	Void	Returns true if the players faction currently has negative funds
HasTradeAgreement	Bool	Void	Returns true if faction has a trade agreement with the player
UnitCapForAgent	Int	CcoAgentRecord	Returns unit cap modifier for provided agent record for this faction
PendingMissionList	CcoCampaignMission (list)	Void	Returns list of pending missions that are available to opt in to (contracts)
RitualContextForKey	CcoCampaignRitual	String	Returns the specified CcoCampaignRitual for a faction given a ritual key
FactionFlagDir	String	ExpressionState	Returns directory for faction flag icons - append image name including extension for use in setting images
EquippedShapeshiftFormContext	CcoShapeshiftForm	Void	Returns the current CcoShapeshiftForm equipped to a faction
AncillaryList	CcoCampaignAncillary (list)	Void	Returns list of all ancillaries in the faction ancillary pool, plus any assigned ones on the characters from this faction.
HasEnoughSlaves	Bool	Int	Returns true if specified amount of slaves are available
Position	Vector4	Void	Returns the faction position, depending on if the current campaign is the prologue
DevAddAllAncillaries	Void	Void	Enables all ancillaries for character	debug, hide_in_ui
EffectBundleUnfilteredList	CcoEffectBundle (list)	Void	Returns list of effect bundles currently active on the faction from various sources, without any filtering (so includes those that dont show in the UI)	hide_in_uied
ActiveMissionCount	Int	ArgumentPack	Returns the number of active missions if no args, or number of active mission matching any of the mission category strings passed in
FactionGovernorshipContext	CcoCampaignFactionGovernorship	Void	Returns the faction governorship context, manager responsible for all governor functionality
IsAlly	Bool	Void	Returns true if faction is a defensive ally of the player
TrespassWarningCooldown	Int	Void	Returns how many turns until can issue trespass warning again (cooldown)
AllianceState	String	Void	Returns the alliance state with the players faction
MercenaryPoolContext	CcoCampaignFactionMercenaryPool	Void	Returns the context of the faction mercenary pool
IsCampaignFeatureAvailable	Bool	ExpressionState, String	Returns true if the specified campaign feature key is available for this faction
DevEnableAllTech	Void	Void	Researches all techs for the faction instantly	debug, hide_in_ui
DevUnlockAllShapeshiftForms	Void	Void	Unlocks all shapeshift forms for this faction	debug, hide_in_ui
ChildFactionContext	CcoCampaignFaction	Void	Returns child faction (for waagh parents)
UnlockableRitualList	CcoCampaignRitual (list)	ArgumentPack	Returns the list of rituals not yet unlocked for a faction. Deprecated, please use the ritual manager instead	deprecated
AgentSubtypeCap	Int	CcoAgentSubtypeRecord	Returns the cap for the agent subtype for this faction
TechnologyManagerContext	CcoCampaignTechnologyManager	Void	Returns the context of the faction technology manager if the faction has one
TechnologyList	CcoCampaignTechnology (list)	Void	Returns a list of all technologies linked to this faction (regardless of state)
DevToggleHuman	Void	Void	Toggles whether faction played by human or AI	debug, hide_in_ui
IsDefensiveAlly	Bool	Void	Returns true if faction is an ally of the player
EffectBundleList	CcoEffectBundle (list)	Void	Returns list of effect bundles currently active on the faction from various sources, pre-filtered to only include those that should show in the UI
UnitCapForUnit	Int	CcoMainUnitRecord	Returns unit cap for provided main unit record for this faction
IsEffectPresent	Bool	ExpressionState, String	Returns true if a specified effect key is present on a faction
ParentFactionContext	CcoCampaignFaction	Void	Returns the parent faction (for waagh factions)
CanUseMortuaryCults	Bool	Void	Returns true if can use mortuary cults functionality (tomb kings usually use this on warhammer)
AgentSubtypeCount	Int	CcoAgentSubtypeRecord	Returns the count of the agent subtype for this faction
RitualManagerContext	CcoCampaignRitualManager	Void	Returns the context of the faction ritual manager if the faction has one
AcceptPendingMission	Void	String	Accepts the specified pending mission (contract)
StrengthValue	Int	Void	Returns the strength value used to evaluate a factions strength rank amongst all factions
ControllableMilitaryForceList	CcoCampaignMilitaryForce (list)	Void	Returns the list of all controllable military forces (non-caravan & non-garrison) in the faction
StrengthRank	Int	Void	Returns the rank amongst all current active factions in terms of strength
IsEnemy	Bool	Void	Returns true if faction is an enemy of the player
FactionFlagRotated	String	ExpressionState	Returns faction flag rotated icon path - prefer to use FactionFlagDir instead	deprecated, hide_in_uied
PooledResourceContext	CcoCampaignPooledResource	String	Returns the specified CcoCampaignPooledResource given a pooled resource key if it exists
PlaguesCompositionSystemContext	CcoCampaignPlaguesCompositionSystem	Void	Returns the plague system of the faction if it exists
CharacterTrainingActiveDilemmaList	CcoCharacterTrainingDilemmaRecord (list)	Void	Returns the list of active training group dilemmas
SalvageAncillaries	Void	ContextList	Salvages all the ancillaries passed into the context list
SpawnForceCost	CcoCampaignResourceTransaction	String	Returns the cost to spawn a conditionally spawnable force
MilitaryForceList	CcoCampaignMilitaryForce (list)	Void	Returns the list of all military forces in the faction
SetAutoManagementBudgetPercentage	Void	Float	Sets the auto management budget to use the percentage passed in of the faction's treasury
IsFactionFeatureAvailable	Bool	ExpressionState, String	Returns true if the specified faction feature key is available for this faction
CanPerformRituals	Bool	Void	Returns true if this faction can currently perform rituals
OpenDiplomacyWith	Void	Void	Starts negotiation with this faction
AvailableRitualList	CcoCampaignRitual (list)	ArgumentPack	Returns the list of available rituals for a faction (alreay unlocked). Deprecated, please use the ritual manager instead	deprecated
CorruptionCounterContext	CcoCampaignCorruptionCounter	Void	Returns the context of the corruption counter for this faction if it exists
RespawnableForces	CcoCampaignCharacter (list)	String	Returns the list of spawned forces that can be respawned
BreakForDebugging	Void	Void	Allows to step into code to fully inspec model side FACTION object	debug, hide_in_uied
CQI	Int	Void	Returns the command queue index for the faction
IsRebelFaction	Bool	Void	Returns true if faction is a rebel faction
IsTechSelectNeeded	Bool	Void	Returns true if this faction is not currently researching a tech but has the ability to do so (reminder for end turn)
DiplomaticThreatLevelContext	CcoDiplomacyThreatLevel	Void	Returns the faction CcoDiplomacyThreatLevel for this faction, if AI we show the threat of the player to the AI, if for the player we show the general threat the AI perceives
InitiativeSetList	CcoCampaignInitiativeSet (list)	Void	Returns the list of available initiative sets
FactionFlagMedium	String	ExpressionState	Returns faction flag medium icon path - prefer to use FactionFlagDir instead	deprecated, hide_in_uied
Rename	Void	Void	Renames the faction to the given name, opens a text prompt to do so)
CharacterList	CcoCampaignCharacter (list)	Void	Returns the list of all characters in the faction
AddPooledResource	Void	CcoCampaignPooledResource, String, Int	Adds an amount of pooled resource with the given factor
TurnIndex	Int	Void	Returns the index of this faction in the end turn process (which turn is theirs)
FactionIcon	String	Void	Returns faction flag icon path - prefer to use FactionFlagDir instead	deprecated, hide_in_uied
IsIdleHuman	Bool	Void	Returns true if this faction used to be controlled by human but the player has disconnected from the game
FactionFlagLarge	String	ExpressionState	Returns faction flag large icon path - prefer to use FactionFlagDir instead	deprecated, hide_in_uied
MainRivalDiplomaticThreatLevelContext	CcoDiplomacyThreatLevel	Void	Returns the faction CcoDiplomacyThreatLevel for the faction this faction considers its main threat (only for AI, returns null for human players)
CharacterTrainingGroupList	CcoCampaignCharacterTrainingGroup (list)	Void	Returns the list of character training groups
AutoManagementBudgetPercentage	Float	Void	Returns the percentage of the faction's treasury that's being used for auto managing provinces/characters
AttitudeCategory	Int	Void	Returns the attitude category with the players faction (hostile->friendly)
SettlementCap	Int	Void	Returns the settlement cap for a faction. ( 0 if they dont have)
ZoomTo	Void	Vector4 (optional)	Zooms to the faction, tries capital first, then faction leader, then first character on map. Can optionally provide an offset for the zoom.
CapitalSettlementContext	CcoCampaignSettlement	Void	Returns the CcoCampaignSettlement of the factions capital (home region)
TreasuryAmount	Int	Void	Returns the current treasury amount of this faction
NetworkPlayerContext	CcoNetworkPlayer	Void	Returns the network player that is controlling this faction (humans steam info)
IsSameFaction	Bool	CcoCampaignFaction	Returns true if the specified faction is the same as this one
IsResearchingTech	Bool	Void	Returns true if this faction is currently researching a tech
FactionInteractionList	CcoCampaignFactionInteraction (list)	Void	Returns the list of faction interactions with all factions have interactions setup with (for things like waagh)
AttitudeTooltip	UniString	Void	Returns a localised string with the attitude towards the player (friendly, hostile etc)
CurrentTechContext	CcoCampaignTechnology	Void	Returns the current technology being researched
FoodTotal	Int	Void	Returns the total amount of food the faction has
FactionFlagSmall	String	ExpressionState	Returns faction flag small icon path - prefer to use FactionFlagDir instead	deprecated, hide_in_uied
DiscoveredProvinceList	CcoCampaignProvince (list)	Void	Returns a list of provinces this faction has discovered
ActiveMissionList	CcoCampaignMission (list)	Void	Returns the list of active missions
DevAdjustRelationsWith	Void	CcoCampaignFaction, Int	Adjusts the diplomatic relations with the given faction. A tad dodgy, factors added are permanent. Value has to be in the range -6 to 6	debug, hide_in_ui
FactionLeaderContext	CcoCampaignCharacter	Void	Returns the CcoCampaignCharacter of the factions current leader
IsHuman	Bool	Void	Returns true if this faction is currently under human control
FactionLevel	Int	Void	Returns the factions 'level' which determines things like how many armies can field, etc
FactionWomCompassContext	CcoCampaignFactionWomCompass	Void	Returns the faction CcoCampaignFactionWomCompass context if this faction can use the winds of magic compass feature
IsVassalOfPlayer	Bool	Void	Returns if the faction is vassal of the player
NumAncillariesAllowedPerCharacterForFaction	Int	CcoCampaignCharacter, String	Returns the number of ancillaries that can be equipped into this category per category for a (optionally provided) faction, e.g. 3 for runes
SettlementList	CcoCampaignSettlement (list)	Void	Returns a list of settlements owned by this faction
TechnologyResearchPointSurplus	Int	Void	Returns how many tech research points this faction has left from the last research requiring less points than those generated in a turn
IssueTrespassWarning	Void	CcoCampaignFaction	Sends a warning to specified faction from this faction to warn to get off land, otherwise will face diplomatic penalties (get off my land feature on wh3)
FactionCaravansContext	CcoCampaignFactionCaravans	Void	Returns the faction CcoCampaignFactionCaravans context if this faction can use the caravans system
WasConfederated	Bool	Void	Returns if the faction was confederated by another faction
MissionList	CcoCampaignMission (list)	Void	Returns list of current active missions for this faction
NumMilitaryForcesContributingToUpkeepIncreaseTotal	Int	Void	Returns the total number of military forces that are contributing to the factions upkeep increase
CultureContext	CcoCultureRecord	Void	Returns the CcoCultureRecord for this faction
Income	Int	Void	Returns the amount of income per turn this faction is earning
NameWithIcon	UniString	ExpressionState	Returns name of faction with faction flag as image tag next to it
FactionWarContracts	CcoCampaignFactionWarContracts	Void	Returns the faction CcoCampaignFactionWarContracts context
IsFactionReadyToEndTurn	Bool	Void	Returns true if this player has ended turn in simultaneous turns, and is just waiting for rest of players in their group to end turn before the turn is actually ended
ProvinceList	CcoCampaignProvince (list)	Void	Returns a list of provinces this faction has a stake in
PinnedMissionList	CcoCampaignMission (list)	Void	Returns list of the missions currently pinned for this faction
SubcultureContext	CcoSubcultureRecord	Void	Returns the CcoSubcultureRecord for this faction
HasValidPosition	Bool	Void	Returns true if faction has a valid position
SlavesAmount	Int	Void	Returns the current number of slaves the faction has
AllianceColour	Colour	Void	Returns the colour based on alliance to local player (as in colour based on player/ally/enemy/neutral)
PrisonSystem	CcoPrisonSystem	Void	Returns the faction's prison system
ClimatesList	CcoSettlementClimateTypeRecord (list)	String	Returns the list of climates that are applicable to this faction based on the supplied suitability key
IsDead	Bool	Void	Returns true if this faction has been killed
FactionRecordContext	CcoFactionRecord	Void	Returns the CcoFactionRecord for this faction
CanCaptureTerritory	Bool	Void	Returns true if faction can capture territory (so not a horde faction)
TotalArmyUpkeep	Int	Void	Returns the total upkeep cost of all this faction's armies
TechnologyResearchPoints	Int	Void	Returns how many tech research points this faction has
CanIssueTrespassWarning	Bool	CcoCampaignFaction	Returns true if can send faction a trespass warning (if cooldown expired since last did this or havent done yet)
TechnologyUiGroupList	CcoTechnologyUiGroupRecord (list)	Void	Returns a TreeCallback with all the ui groups that exists for the technologies in this faction(if any)
FactionInteractionContext	CcoCampaignFactionInteraction	CcoCampaignFaction	Returns the faction CcoCampaignFactionInteraction context with supplied target faction (for things like war coordination, loan armies, etc)
IsPlayersFaction	Bool	Void	Returns true if this is the players faction
Name	UniString	ExpressionState	Returns name of faction
PooledResourceList	CcoCampaignPooledResource (list)	Void	Returns the list of all pooled resources for the faction
AlliesCount	Int	Void	Returns the number of allies that this faction has
ModelFactionContext	CcoCampaignModelFaction	Void	Returns the CcoCampaignModelFaction for this faction
DiplomacyManipulationInfoList	CcoCampaignDiplomacyManipulationInfo (list)	Void	Returns list of the diplomacy manipulation infos, if the faction has any.
TradeState	String	Void	Returns trade state with players faction
PooledResourceManagerContext	CcoCampaignPooledResourceManager	Void	Returns the pooled resource manager which manages all responsibility for pooled resources on a faction
FactionsKnownList	CcoCampaignFaction (list)	Void	Returns a list of all the factions this faction knows (that it can see in diplomacy basically)
ActiveMissionForKey	CcoCampaignMission	String	Returns an active mission context for the given key if it exists on the mission manager
IsFactionsTurn	Bool	Void	Returns true if it is currently this factions turn
HasPendingAction	Bool	Void	Returns true if faction has an active battle or pending action, used to report that a player is blocking gameplay in simultaneous turns
EnemiesCount	Int	Void	Returns the number of enemies that this faction has
EnemyFactionList	CcoCampaignFaction (list)	Void	Returns a list of all the factions that this faction is at war with
AIMilitaryTargetList	CcoPair (list)	Void	Returns list of CcoPair which is a list of the factions forces and their current targets (settlement/character/force) designated by the AI
PrimaryColour	Colour	Void	Returns the primary colour for this faction
CookingSystem	CcoCookingSystem	Void	Returns the faction's cooking system
TechnologyTree	TreeData	CcoTechnologyUiTabRecord (optional)	Returns a TreeCallback with all the technologies for this faction

CcoCampaignFactionAlliedBuildings

Wrapper for a player faction and an ally faction, used to interact with outposts.

Functions

Name	Return Type	Arguments	Description
ConstructInSettlementCost	Int	CcoCampaignSettlement	Returns the cost of constructing the outpost in this settlement.
AllyPermittedSettlementList	CcoCampaignSettlement (list)	Void	Returns a list with settlements owned by the ally faction, in which an outpost can be constructed
LongDistanceThreshold	Int	Void	Returns the long distance threshold, used for displaying the correct shared enemy distance state
CanConstructInSettlement	Bool	CcoCampaignSettlement	Returns true if can construct the outpost in this settlement
SharedEnemyDistanceFromSettlement	Float	CcoCampaignSettlement	Returns the distance between the closest enemy from the allied settlement specified. Returns 0 if the 2 factions have no shared enemies
MiddleDistanceThreshold	Int	Void	Returns the middle distance threshold, used for displaying the correct shared enemy distance state
CanMoveToSettlement	Bool	CcoCampaignSettlement	Returns true if the slot can be moved to the passed in settlement
MoveToSettlementCost	Int	CcoCampaignSettlement	Returns the amount it will cost to move the slot to this settlement
RemoveAlliedBuilding	Void	Void	Removes the outpost from the settlement where it's constructed
RecruitableUnitsForSettlementList	CcoMainUnitRecord (list)	CcoCampaignSettlement	Returns a list with units that could be recruited if an outpost is built in the passed in settlement
MoveToSettlement	Void	CcoCampaignSettlement	Moves the current outpost to the settlement specified
AlliedSettlementContext	CcoCampaignSettlement	Void	Returns the context of the settlement where an outpost is built, if any
PlayerFactionContext	CcoCampaignFaction	Void	Returns the context of the faction that interacts with the outposts.
AllyFactionContext	CcoCampaignFaction	Void	Returns the context of the ally faction in whose regions the player faction can construct outposts
ConstructInSettlementTime	Int	CcoCampaignSettlement	Returns the amount of time it will take to construct the outpost in this settlement.
ConstructInSettlement	Void	CcoCampaignSettlement	Constructs an outpost in the passed in settlement

CcoCampaignFactionCaravans

Wrapper for a campaign FACTION_CARAVANS struct

Functions

Name	Return Type	Arguments	Description
CanRecruitCaravanMaster	Bool	CcoCampaignCharacter	Returns true if can recruit the passed in character as a caravan master
TooltipForCaravan	UniString	CcoCampaignCaravan, CcoCaravanContractRecord, Int	Returns a localised tooltip with the reason why the caravan cannot be dispatched
RecruitCaravan	Void	CcoCampaignCharacter	Recruits a caravan with the caravan master passed in
InitialZoomPosition	Vector4	Void	Returns a VECTOR_4 with a position where the camera should zoom when first opening the panel
MaximumCaravans	Int	Void	Returns an int with the maximum number of caravans that a faction can have active at the same time
StartCaravan	Void	CcoCampaignCaravan, CcoCaravanContractRecord, Int	Starts the caravan with the amount of cargo passed in
CaravanMasterList	CcoCampaignCaravanRecruitmentItem (list)	Void	Returns a list of CcoPair with the first entry as CcoCampaignCharacter and second as an int with the cost of recruiting the character as a caravan master
NodeList	CcoCampaignRouteNode (list)	Void	Returns a list of CcoCampaignRouteNode with all the route nodes that can be used by this faction
ActiveCaravanList	CcoCampaignCaravan (list)	Void	Returns a list of CcoCampaignCaravan with all active caravans
IdleCaravanList	CcoCampaignCaravan (list)	Void	Returns a list of CcoCampaignCaravan with all the caravans that are idle
FactionContext	CcoCampaignFaction	Void	Returns the faction context of this class

CcoCampaignFactionGovernorship

Functions

Name	Return Type	Arguments	Description
EstablishProvinceGovernorship	Void	CcoCampaignProvince, CcoCampaignCharacter	Establishes a new governorship with the province and governor passed in
GovernorList	CcoCampaignCharacter (list)	Void	Returns a list with all governors that can be used to establish new governorships
ProvinceList	CcoCampaignProvince (list)	Void	Returns a list with all provinces that the faction can use to establish governorship
ClosestPendingDecisionGovernorshipContext	CcoCampaignProvinceGovernorship	Void	Returns a CcoCampaignProvinceGovernorship with the closest governorship that has a pending decision, if no governorship has decisions then returns null
UnassignedGovernorsCount	Int	Void	Returns the number of unassigned governors
SelectFirstValidTargettingInterface	Void	Void	Selects the first valid governorship targetting interface, if any
ProvinceGovernashipFromProvince	CcoCampaignProvinceGovernorship	CcoCampaignProvince	Returns the province governorship that contains the passed in province, if any
MaximumGovernorCount	Int	Void	Returns the maximum number of governors that can be present
MoveProvinceGovernor	Void	CcoCampaignProvince, CcoCampaignProvince	Moves a governor from one province to another
ProvinceGovernashipFromGovernor	CcoCampaignProvinceGovernorship	CcoCampaignCharacter	Returns the province governorship that contains the passed in governor, if any
SelectProvinceDecisionChoice	Void	CcoCampaignProvince, CcoCampaignDecisionChoiceRecord	Select dilemma choice for the passed in governor
ProvinceGovernorshipList	CcoCampaignProvinceGovernorship (list)	Void	Returns a list of all province governorships that have been already established

CcoCampaignFactionInteraction

Component context wrapper for two factions interacting with each other, for the war coordination system (kind of a mirror to FACTION_INTERACTIONS_ENV).

Functions

Name	Return Type	Arguments	Description	Tags
IsWarCoordinationAvailable	Bool	Void	Returns true if the source and target faction have war coordination available (military allies)
SetTarget	Void	Context	Selects a war coordination target (CcoCampaignMilitaryForce or CcoCampaignSettlement)
FavourPoints	Int	Void	How many favour points have to spend between factions to pay for actions such as war coordination or requesting armies
HasAnyValidTargetToPick	Bool	String (optional)	Returns true if we have anything we can actually target now. Can optionally pass the targetting type(OFFENSIVE, DEFENSIVE, OCCUPY)
OpenWarCoordinationPanel	Void	String (optional)	Opens up the war coordination panel, pass a specific tab key to select that section otherwise defaults to first available
ReverseInteractionContext	CcoCampaignFactionInteraction	Void	Returns the interaction the opposite way around (so can see requests in opposite direction, etc)
TargetFactionContext	CcoCampaignFaction	Void	The target faction interacting with
EnableTargetting	Void	Bool	Sets the targetting mode on/off as specified to pick a target
AlliedBuildingsContext	CcoCampaignFactionAlliedBuildings	Void	Gets the CcoCampaignFactionAlliedBuildings context to deal with outposts
ZoomToTarget	Void	Void	Zooms the camera to the current war coordination target
WarCoordinationPendingRequestsList	CcoCampaignWarCoordinationRequest (list)	Void	Add favour points for dev functionality, can be positive or negative
CurrentTargetRequestContext	CcoCampaignWarCoordinationRequest	Void	Returns the CcoCampaignWarCoordinationRequest requested from the target faction to the source faction (for war coordinations requests from AI, the request accepted from WarCoordinationPendingRequestsList basically)
ClearTarget	Void	Void	Clears the curent war coordination target
SourceFactionContext	CcoCampaignFaction	Void	The source faction (usually player)
DevAddFavourPoints	Void	Int	Add favour points for dev functionality, can be positive or negative	debug, hide_in_uied
CheapestTargetFavourPointsCost	Int	String (optional)	Returns the favour point cost for the cheapest target. Can optionally pass the targetting type(OFFENSIVE, DEFENSIVE, OCCUPY) (used to show on tooltip so know how much need to use set target button for example). Returns 0 if no valid targets
IsValidTarget	Bool	Context	Returns true if supplied context is a valid war coordination target (CcoCampaignMilitaryForce or CcoCampaignSettlement)
IsTargettingActive	Bool	Void	Returns true if targetting mode is currently active
CanLoanMilitaryForce	Bool	CcoCampaignMilitaryForce	Returns true if the specified force of the target faction can be loaned to the source faction
FavourPointsCostForTarget	Int	Context	Returns the favour point cost to set a particular war coordination target (CcoCampaignMilitaryForce or CcoCampaignSettlement)
LoanMilitaryForce	Void	CcoCampaignMilitaryForce	Loans the specified force of the target faction to the source faction
MilitaryForcesLoanedList	CcoCampaignMilitaryForce (list)	Void	Returns a list of military forces loaned from the target to the source faction
IsContextTargeted	Bool	Context	Returns whether the given context is targeted. (Allows child classes to add unique targeting conditions)
FavourPointsCostToLoanMilitaryForce	Int	CcoCampaignMilitaryForce	Returns the favour point cost to loan the specified force from the target to the source faction
InvalidReasonsForTarget	UniString	Context	Returns the reasons if any as a localised string of why you cannot target a specified attack target (CcoCampaignMilitaryForce or CcoCampaignSettlement)
SharedEnemyList	CcoCampaignFaction (list)	Void	Returns a list of enemies common to both the source and target faction who can target with war coordination
NumAvailableWarCoordOptions	Int	Void	Returns the number of available war coord options, used for sorting
CurrentTargetContext	Context	Void	Returns the current target to attack or defend for war coordination (CcoCampaignMilitaryForce or CcoCampaignSettlement)
ToggleTargetting	Void	Void	Toggles targetting mode on/off to pick a target
MilitaryForcesToLoanList	CcoCampaignMilitaryForce (list)	Void	Returns a list of military forces available to loan from target faction to source faction
IsWarTargettingAllowed	Bool	Void	Returns true if can ever use war targetting (only disabled between human players at the minute)
FavourPointsChangePerTurn	Int	Void	How many favour points generate each turn (determined by relationship have between factions)
ToggleTargettingForType	Void	String	Enables targetting with the passed in option type

CcoCampaignFactionProvinceManager

Wrapper for a campaign FACTION_PROVINCE_MANAGER

Functions

Name	Return Type	Arguments	Description
PooledResourceContext	CcoCampaignPooledResource	String	Returns the pooled resource context for the key passed in
IsWealthEnabled	Bool	Void	Returns true if wealth is enabled for this province
GrossIncome	Int	Void	Returns the gross income that the province produces
CanSetInitiative	Bool	Void	Returns true if the selected initiative can be set
PredictedGrowthPercentage	Float	Void	Returns the percentage of predicted next turn growth to max growth
IsPublicOrderEnabled	Bool	Void	Returns true if public order is enabled for this province
IncomeBreakdownList	CcoStringValue (list)	Void	Returns a list of CcoStringValue with the breakdown of the income spent/gained
GeomanticWebLevel	Int	Void	Returns the current level of the geomantic web of the province
IsTaxExempt	Bool	Void	Returns true if the province is not currently taking tax
GrowthPercentage	Float	Void	Returns the percentage of current growth to max growth
InitiativeList	CcoProvinceInitiativeRecord (list)	Void	Returns a list of all province initiatives
CQI	Int	Void	Returns the unique command queue index identifier of this province
GrowthFactorList	CcoStringValue (list)	Void	Returns a list of CcoStringValue factors for the growth
TurnsUntilNextGrowthPoint	Int	Void	Returns how many turns it would take for the province to provide the next development point
EffectBundleAndSettlementsList	CcoPair (list)	Void	Returns a list of pairs with province effect bundles and settlements where those effect bundles are active
GrowthThresholdForPoint	Int	Void	Returns the growth threshold for the development points
AllEffectsList	CcoEffect (list)	Void	Returns a list of CcoEffect that are applied to the province, this include hidden effect bundles
GrowthPredictedNextTurn	Int	Void	Returns the amount of growth that the province is predicted to have next turn
AccumulatedGrowth	Int	Void	Returns the accumulated growth
PooledResourceDistributorContext	CcoCampaignPooledResourceDistributor	Void	Returns the context of the pooled resource distributor of this province
AutoManagementContext	CcoCampaignProvinceAutoManagement	Void	Returns the context of the auto management system of the province
GrowthPerTurn	Int	Void	Returns how much growth per turn the province provides
ZealLevel	Int	Void	Returns the current level of zeal
SetInitiative	Void	ExpressionState	Sets the CcoProvinceInitiativeRecord initiative that is stored on the component that calls this function
FactionContext	CcoCampaignFaction	Void	Returns the faction context
SlavesContext	CcoCampaignSlaves	Void	Returns the context of the slave system if the faction has access to the feature
FoodTotal	Int	Void	Returns the total food
DevelopmentPoints	Int	Void	Returns the current development point
AddPooledResource	Void	CcoCampaignPooledResource, String, Int	Adds a pooled resource to this province
PublicOrderContext	CcoCampaignPublicOrder	Void	Returns the public order context
CommandLevel	Int	Void	Returns the current level of the command/authority
HasMaxDevelopmentPoints	Bool	Void	Returns true if this province has maximum develpoment point currently
SubterfugeLevel	Int	Void	Returns the current level of subterfuge
ProvinceContext	CcoCampaignProvince	Void	Returns the province context
ToggleTaxExempt	Void	Void	Toggles the province to be tax exempt if it's currently not or the other way around
GeomanticWebLevelText	UniString	Void	Returns the geomantic web text for the current level
InstalledInitiative	CcoProvinceInitiativeRecord	Void	Returns the context of the currently installed initiative in this province
IsGrowthEnabled	Bool	Void	Returns true if growth is enabled for this province
SelectedInitiative	CcoProvinceInitiativeRecord	Void	Returns the context of the selected initiative that will be installed next turn

CcoCampaignFactionWarContracts

Wrapper for a campaign FACTION_WAR_CONTRACTS struct

Functions

Name	Return Type	Arguments	Description
AvailableContractsList	CcoCampaignWarContract (list)	Void	Returns a list of CcoCampaignWarContract with all available non-active contracts
FactionContext	CcoCampaignFaction	Void	Returns the faction context of this class
ActiveContract	CcoCampaignWarContract	Void	Returns a CcoCampaignWarContract for the current active contract

CcoCampaignFactionWomCompass

Wrapper for wom compass

Functions

Name	Return Type	Arguments	Description
FactionCooldown	Int	Void	Returns an int with the cooldown until the faction can turn the compass again
DirectionForKeyContext	CcoCampaignWomCompassDirection	String	Returns a CcoCampaignWomCompassDirection with the key specified
TurnsUntilUnlockedScriptObjectEventsList	CcoString (list)	Void	Returns a list of CcoString event names that will fire when script updates the turns until each direction is unlocked
PowerLevelCostToSkipCooldown	Int	Void	Returns an int with the cost in power levels that it would take to skip the compass cooldown
CurrentDirectionContext	CcoCampaignWomCompassDirection	Void	Returns a CcoCampaignWomCompassDirection with the currently active direction
IsDirectionLocked	Bool	CcoCampaignWomCompassDirection	Returns true if the passed in direction is currently locked
CanSelectDirection	Bool	CcoCampaignWomCompassDirection	Returns true if can select the passed in direction
DirectionList	CcoCampaignWomCompassDirection (list)	Void	Returns a list of CcoCampaignWomCompassDirection with all the directions of the compass
ActivateUserActionForDirection	Void	CcoCampaignWomCompassDirection, String	Activates the user action with the type passed in for the specified direction
CanChangeDirection	Bool	Void	Returns true if the selection can be changed by the faction
TooltipReasonForDirection	UniString	CcoCampaignWomCompassDirection	Returns extra text for the passed in direction
MaximumCompassCooldown	Int	Void	Returns an int with the maximum cooldown the compass can have (useful for calculating percentage)
ChooseCompassDirection	Void	CcoCampaignWomCompassDirection	Changes the compass direction to the one specified if possible
CompassCooldown	Int	Void	Returns an int with the cooldown until the compass can be moved again by any faction
MaximumFactionCooldown	Int	Void	Returns an int with the maximum cooldown the faction can have (useful for calculating percentage)

CcoCampaignGovernorshipInteraction

Functions

Name	Return Type	Arguments	Description
CurrentTargetContext	Context	Void	Returns the context of the current target
IsContextTargeted	Bool	Context	Returns whether the given context is targeted. (Allows child classes to add unique targeting conditions)
SourceCharacterContext	CcoCampaignCharacter	Void	Returns a CcoCampaignCharacter with the character
GrowthCombinedValue	Int	Void	Returns an int with the combined growth value of all the effects on the character
CorruptionCombinedValue	Int	Void	Returns an int with the combined corruption value of all the effects on the character
IncomeCombinedValue	Int	Void	Returns an int with the combined income value of all the effects on the character
PublicOrderCombinedValue	Int	Void	Returns an int with the combined public order value of all the effects on the character
EnableTargetting	Void	Bool	Enables or disables this targetting interface based on the bool passed in
SetTarget	Void	Context	Sets the target to the passed in one
IsValidTarget	Bool	Context	Returns true if the passed in target is valid
ClearTarget	Void	Void	Clears the current target
ToggleTargetting	Void	Void	Toggles this targetting interface from active to inactive and the other way around
InvalidReasonsForTarget	UniString	Context	Returns the reason why the target is not valid
IsTargettingActive	Bool	Void	Returns true if this targetting interface is active

CcoCampaignInitiative

Wrapper for a campaign initiative

Functions

Name	Return Type	Arguments	Description
PointsCost	Int	Void	Returns how many points this initiative contributes towards the set's limits (can be negative)
TotalCountOfRequiredUnits	Int	Void	Returns the total count of required units
RemainingDuration	Int	Void	Returns the remaining duration of the intiative
MarkAsSeen	Void	Void	Marks the initiative as seen
TurnsUntilPayloadIsActivated	Int	CcoCampaignPayloadRecord	Returns the number of turns until the payload is reactivated
Activate	Void	Int (optional)	Activates the initiative, to an optionally provided slot index
Cooldown	Int	Void	Returns the cooldown for the initiative, or 0 if it does not have a cooldown period
RemainingCooldown	Int	Void	Returns the remaining cooldown for the initiative, or 0 if it is not on cooldown
Deactivate	Void	Void	Deactivates the initiative
ForceMeetsUnitRequirements	Bool	CcoCampaignMilitaryForce	Returns true if this initiative meets the units requirements set in the required_units field
LockReasons	UniString	Void	Returns reasons that this initiative is locked as a string
Duration	Int	Void	Returns the duration for the initiative, or 0 if it has infinite duration, which should be queried seperately
Toggle	Void	Int (optional)	Activates an initiative, to an optionally provided slot index, or deactivates an activated initiative.
IsOnCooldown	Bool	Void	Returns true if the initiative itself is on cooldown
RequiredCostContext	CcoCampaignResourceTransaction	Void	Returns context to required resource cost. Initiative is locked until these transactions have been met
HasSeen	Bool	Void	Returns true if this initiative has been seen before (modified by MarkAsSeen)
LinkedTechnologyList	CcoTechnologyRecord (list)	Void	Returns list of technologies that modify this initiative
IsScriptLocked	Bool	Void	Returns true if this initiative is script locked.
CostContext	CcoCampaignResourceTransaction	Void	Returns context to intitial cost
IsOnlyOnCooldown	Bool	Int (optional)	Returns true if locked only because of being on cooldown. Can provide an optional slot index
UpkeepCostContext	CcoCampaignResourceTransaction	Void	Returns context to per-turn upkeep cost
HasInfiniteDuration	Bool	Void	Returns true if this initiative will not expire
InitiativeSetContext	CcoCampaignInitiativeSet	Void	Returns the initiative set this initiative belongs to
IsLocked	Bool	Int (optional)	Returns true if this initiative is locked. Alternatively given a slot index, return if locked for given slot
InitiativeContext	CcoInitiativeRecord	Void	Returns associated initiative record wrapper
TotalNumberOfRequirementsMetForForce	Int	CcoCampaignMilitaryForce	Returns the total count of required units met in a force
IsActive	Bool	Void	Returns true if this initiative is currently active

CcoCampaignInitiativeManager

Component context manager for campaign initiatives

Functions

Name	Return Type	Arguments	Description
TotalUpkeep	Int	CcoCampaignPooledResource (optional)	Get the value of what the total upkeep will be after the selection has been confirmed
InitiativesMarkedForActivation	CcoCampaignInitiative (list)	CcoCampaignInitiativeSet (optional)	Returns the initiatives which have been marked for activation
InitiativesMarkedForDeactivation	CcoCampaignInitiative (list)	CcoCampaignInitiativeSet (optional)	Returns the initiatives which have been marked for deactivation
InitiativeSetList	CcoCampaignInitiativeSet (list)	String (optional)	Returns all the initiative sets within the manager optionally filtered for a category
ApplyPendingInitiativeChanges	Void	Void	Handler when the confirmation button is clicked
ClearLists	Void	Void	Clears the lists of to-be activated and de-activated initiatives. For when the panel is closing
ToggleInitiative	Void	CcoCampaignInitiative	Handler when the initiative buttons are clicked
ToggleInitiativeAndDependantLevels	Void	CcoCampaignInitiative	Handler when the initiative buttons are clicked
CanPayPendingInitiativesExpenditureCost	Bool	CcoCampaignPooledResource	Returns true if the pending initiatives cost can be paid.
IsInitiativeSelected	Bool	CcoCampaignInitiative	Check if the initiative button should be displayed as selected (active or to-be active)
TotalCostForConfirmation	Int	CcoCampaignPooledResource (optional)	Get the total cost to confirm the selection
PostConfirmActiveInitiativeList	CcoCampaignInitiative (list)	CcoCampaignInitiativeSet (optional)	Returns the initiatives which will be active once the confirm button is clicked. This is used to display the potential active effects

CcoCampaignInitiativeSet

Component context wrapper for a campaign initiatives

Functions

Name	Return Type	Arguments	Description
CostForMultipleInitiatives	CcoCampaignResourceTransaction	ContextList	Return the resource transaction cco for multiple initiatives' cost
GetFirstAvailableSlot	Int	Void	Returns the first ui slot number that a newly activated initiative can be set into. If the initiative limit has been reached it returns -1.
ActiveInitiativeForSlot	CcoCampaignInitiative	Int	Return the active initiative for a specific slot
InitiativeListSorted	CcoCampaignInitiative (list)	Void	Return the list of all initiatives for this set
ActiveInitiatives	CcoCampaignInitiative (list)	Void	Return the list of active initiatives for this set
InitiativeSetContext	CcoInitiativeSetRecord	Void	Return the initiative set record cco
InitiativeList	CcoCampaignInitiative (list)	Void	Return the list of all initiatives for this set
IsOnCooldown	Bool	Void	return whether this set is on cooldown
DevModifyLimit	Void	Int (optional)	Dev function to modify the limit of initiatives for this set
PointsLimit	Int	Void	return the point limit for this set
PointsAllocated	Int	Void	return the points allocated for this set
ActiveInitiativeLimit	Int	Void	Return the int with the active initiative limit for this set
RemainingCooldown	Int	Void	return the remaining cooldown for this set
BaseCostContext	CcoCampaignResourceTransaction	Void	Returns the resource transaction cco for the base cost
CanActivateInitiatives	Bool	ContextList	Return bool with the flag whether this set can activate initiatives
ToggleMultipleInitiatives	Void	ContextList, Bool (optional)	Activates multiple initiatives

CcoCampaignMilitaryForce

Component context wrapper for a campaign military force

Functions

Name	Return Type	Arguments	Description	Tags
EffectBundleUnfilteredList	CcoEffectBundle (list)	Void	Returns current active list of CcoEffectBundle, without any filtering (so includes those that dont show in the UI)	hide_in_uied
TrespassWarningIsIssued	Bool	Void	Returns whether a trespass warning has been issued by the player to this military force
PlagueInfectionContext	CcoCampaignPlagueInfection	Void	Returns a CcoCampaignPlagueInfection with a plague infection if it exists on the military force
Position	Vector4	Void	Returns the map position of the force
FactionLoanedFromContext	CcoCampaignFaction	Void	Returns the CcoCampaignFaction that we were loaned from if any
FactionFlagLarge	String	Void	Returns the filepath for large faction flag.	deprecated
SoldierCount	Int	Void	Returns the number of current entities
CharacterList	CcoCampaignCharacter (list)	Void	Returns list of CcoCampaignCharacter in this force
Name	UniString	Void	Returns the localised name
IsTrespassingAgainstPlayer	Bool	Void	Returns true if this force is trespassing on the players territory
IsNavalTransport	Bool	Void	Returns true if this force is a naval transport
IsGarrisoned	Bool	Void	Returns true if this force is currently inside a settlement
FactionFlagRotated	String	Void	Returns the filepath for rotated faction flag.	deprecated
StanceList	CcoCampaignMilitaryForceStance (list)	Void	Returns the available CcoCampaignStance (that force can ever do, not just available right now)
Upkeep	Int	Void	Returns the cost per to turn to keep this force active
CampRequiredResourceCostContext	CcoCampaignResourceTransaction	String	Returns the CcoCampaignResourceTransaction for spawning a camp for the specified spawnable_force_key
PlagueResistance	Float	Void	Returns the additive resistance the force has against plague infection
SettlementContext	CcoCampaignSettlement	Void	Returns the CcoCampaignSettlement we are in if any
CanSpawnForce	Bool	String	Returns true if this force can spawn the specified spawnable_force_key
FactionFlagSmall	String	Void	Returns the filepath for small faction flag.	deprecated
CanPlayerLoan	Bool	Void	Returns true if this force can currently be loaned to the player by the forces owning faction
HordeContext	CcoCampaignMilitaryForceHorde	Void	Returns the CcoCampaignMilitaryForceHorde for getting horde specific info like settlements etc
UnitCount	Int	Void	Returns the number of units recruited
PendingRecruitmentUnitList	CcoPair (list)	Void	Returns list of CcoPair for each unit being recruited in this force
FactionContext	CcoCampaignFaction	Void	Returns the CcoCampaignFaction this force belongs to
IsSufferingAttrition	Bool	Void	Returns true if this force is suffering attrition and will take damage in the next turn
FactionFlagMedium	String	Void	Returns the filepath for medium faction flag.	deprecated
IsInValidSpawnForcePosition	Bool	String	Returns true if this force's position is valid to spawn the specified spawnable_force_key
ArmyPlagueContext	CcoCampaignArmyPlague	Void	Returns the CcoCampaignArmyPlague for any plague present
CombatComparisonStrengthRelativeToForce	Float	CcoCampaignMilitaryForce	Returns a percentage of relative strength againt specified force (where 1 is will definately beat and 0 is definately will lose)
PlagueEffectBundleList	CcoEffectBundle (list)	Void	Returns the list of CcoEffectBundle provided by the plague on this army
SkulltakerTeleportCostForForce	Int	CcoCampaignRitual	Specific to Skulltaker, takes in a CcoCampaignRitual so we can get the ritual setup from it and returns the cost for Skulltaker to teleport to that force, since it's different depending on each force.
Disband	Void	Void	Disbands the entire force essentially killing it
IsMovingCamp	Bool	Void	Returns true if this force is a moving camp (like ogre camps in wh3)
PooledResourceContext	CcoCampaignPooledResource	String	Returns the specified CcoCampaignPooledResource by record key
AutoresolvePredictionInaccuracyPercent	Float	CcoCampaignMilitaryForce	Returns a percentage of inaccuracy the general calculating correct CombatComparisonStrengthRelativeToForce. Larger battles and lower general rankings make this larger. (0-1)
CommandingCharacterContext	CcoCampaignCharacter	Void	Return the CcoCampaignCharacter for the commanding character who is leading the force
PooledResourceManagerContext	CcoCampaignPooledResourceManager	Void	Returns the CcoCampaignPooledResourceManager for calculating pooled resource costs
HasArmyPlague	Bool	Void	Returns true if this force has an army plague attached
WarCoordTargettingContext	CcoCampaignMilitaryForceWarTargetting	Void	Returns the CcoCampaignMilitaryForceWarTargetting for handling setting war coordination targets
ForceType	String	Void	Returns a string with the type of the military force
UnitList	CcoCampaignUnit (list)	Void	Returns list of CcoCampaignUnit in this force
IsOgreCamp	Bool	Void	Returns true if this force is a ogre camp
ChildForceContext	CcoCampaignMilitaryForce	Void	Returns the CcoCampaignMilitaryForce of any child armies (for waagh children)
ContractPointsValue	Int	Void	Returns the contract points value for the force
AITargetList	ContextList	Void	Returns list of targets the AI is targetting (forces/settlements)
IsNotGarrisonForce	Bool	Void	Returns true if this force is not a garrison army
MoraleContext	CcoCampaignMilitaryForceMorale	Void	Returns the CcoCampaignMilitaryForceMorale
StancePreviewPercentCost	Float	Void	Returns the percentage AP cost to switch to specified stance (0-1)
DevHeal	Void	Void	Replenishes the force, useful for dev purposes	debug, hide_in_uied
ParentForceContext	CcoCampaignMilitaryForce	Void	Returns the CcoCampaignMilitaryForce of the parent army (for waagh parent)
AllowedNumberTactics	Int	Void	Returns the number of allowed tactics for this force
HasPlague	Bool	Void	Returns true if this force has a plague attached
DevManipulateWinStreak	Void	Bool	Manipulates the winning streaks, useful for dev purposes	debug, hide_in_uied
ActiveStanceContext	CcoCampaignMilitaryForceStance	Void	Returns the current selected CcoCampaignStance
IsFixedCamp	Bool	Void	Returns true if this force is a fixed camp (like ogre camps in wh3)
IsSelected	Bool	Void	Returns true if this force is selected
ContainsSpellcaster	Bool	Void	Returns if the force contains a spellcasting character.
HealthPercent	Float	Void	Returns current hp percentage of recruited units against their max health (0-1)
DevSetDebugMoraleEffectValue	Void	Int	Sets morale debug effect value for increasing/decreasing morale	debug, hide_in_uied
IsPreviewingStance	Bool	Void	Returns true if this force is currently previewing an alternative stance (mousing over a stance choice for example)
WarCoordinationTargetterList	ContextList	Void	Returns list of contexts who are targetting us (mix of factions and armies as war coordination can be on both these levels)
AverageHealthPercentage	Float	Void	Returns the average health percentage of units (0-1)
IsInsideSphereOfInfluenceForForce	Bool	CcoCampaignMilitaryForce	Returns if the force is inside the sphere of influence of another given force.
WinStreakList	CcoCampaignWinStreak (list)	Void	Returns list of CcoCampaignWinStreak
DevKill	Void	Void	Kills the force, useful for dev purposes	debug, hide_in_uied
IsRaiding	Bool	Void	Returns true if this force is raiding
SpawnForce	Void	String, CcoCampaignCharacter (optional)	Spawns the specified spawnable_force_key if possible. Optionally a force in limbo can be respawned instead.
IsAgentEmbedded	Bool	Void	Returns true if this force has an agent embedded within
LocationEffectList	CcoEffect (list)	Void	Returns current active list of CcoEffect coming from current location
LoanTurnsRemaining	Int	Void	Returns the number of turns remaining until loan is over and will return to FactionLoanedFromContext if any (0 if not on loan)
IsImmuneToPlagues	Bool	Void	Returns if the force is currently immune to plagues
WillReplenishThisTurn	Bool	Void	Returns true if this force is replenishing and will increase in health in next turn
UnitCountPercent	Float	Void	Returns the percentage unit count of current units against max can have (0-1)
PlagueImmunityTurns	Int	Void	Returns the number of turns the force is immune to plagues for, or 0 if not immune
PooledResourceList	CcoCampaignPooledResource (list)	Void	Returns the list of CcoCampaignPooledResource attached to this force
DevAddDevPoint	Void	Void	Adds development points for hordes	debug, hide_in_uied
TrespassGracePeriod	Int	Void	Returns the number of turns until war can be declared without penalty on an army if it does not vacate your territory
TooltipForCanLoanStatus	UniString	Void	Returns a tooltip displaying information relating to whether an army can be loaned
IsLayingAmbush	Bool	Void	Returns true if this force is currently in ambush stance
SiegeTurnsRemaining	Int	Void	Returns the number of turns remaining before settlement sieging falls without a fight (if sieging)
EnableFixedCampAreaOfInfluencePreview	Void	Bool	If true, enables preview of visualisation for how large fixed camp area of influence would be if deployed in current position (false disables it)
IsTransportedArmy	Bool	Void	Returns whether a this force is a transported army
IsHorde	Bool	Void	Returns true if this force is a horde
CQI	Int	Void	Returns the command queue index (unique id of force)
ForceEffectList	CcoEffect (list)	Void	Returns current active list of CcoEffect coming from force itself
CanSwitchToPreviewStance	Bool	Void	Returns true if this force can switch to the current stance being previewed
IsHiddenToEnemies	Bool	Void	Returns true if this army is currently hidden from enemies
CanShowBalanceOfPowerPreview	Bool	CcoCampaignMilitaryForce	Returns true if can show the balance of power preview for the supplied army against this current army
FactionName	UniString	Void	Returns the factions localised name (use this instead of getting from faction so works correctly with rebels)
RaidingIncome	Int	Void	Returns the amount of income this force is providing in via raiding
ZoomTo	Void	Vector4 (optional)	Zooms to the military force. Can optionally provide an offset for the zoom.
EffectBundleList	CcoEffectBundle (list)	Void	Returns current active list of CcoEffectBundle, pre-filtered to only include those that should show in the UI
TooltipForSpawnForce	UniString	String, Bool (optional)	Returns the tooltip for spawning a force using supplied spawnable_force_key
IsLayingSiege	Bool	Void	Returns true if this force is currently besieging a settlement
ReturnLoanedArmy	Void	Void	If the army is a loaned army, returns them to their lending faction

CcoCampaignMilitaryForceHorde

Functions

Name	Return Type	Arguments	Description
GrowthFactorList	CcoStringValue (list)	Void	Returns a list of CcoStringValue with the name and value of the factors that went towards the current amount of growth
ChainList	CcoBuildingChainRecord (list)	Void	Returns a list of CcoBuildingChainRecord with all the building chains in the horde
GrowthPerTurn	Int	Void	Returns an int with the amount of growth the horde receives each turn
GrowthThresholdForPoint	Int	Void	Returns an int the growth amount needed for the next development point
TurnsUntilNextGrowthPoint	Int	Void	Returns an int with the number of turns needed until the next development point
GrowthPercentage	Float	Void	Returns a float with the percentage of current growth relative to the next development point
PredictedGrowthPercentage	Float	Void	Returns a float with the percentage of growth value the horde will have next turn, relative to the next development point
BuildingSetList	CcoBuildingSetRecord (list)	Void	Returns a list of CcoBuildingSetRecord with all the building sets in the horde
DevelopmentPoints	Int	Void	Returns an int with the current number of development points
BuildingSlotList	CcoCampaignBuildingSlot (list)	Void	Returns a list of CcoCampaignBuildingSlot with all the slots in the horde
PrimarySlotContext	CcoCampaignBuildingSlot	Void	Returns a CcoCampaignBuildingSlot with the primary slot in the horde
AccumulatedGrowth	Int	Void	Returns an int with the current amount of accumulated growth

CcoCampaignMilitaryForceMorale

Component context wrapper for a campaign military force's morale

Functions

Name	Return Type	Arguments	Description
CurrentMorale	Float	Void	Returns current value
PredictedMorale	Float	Void	Returns predicted (next turn) value
PredictedBreakdown	CcoStringValue (list)	Void	Returns the predicted (next turn list of effects as a list of CcoStringValue
CurrentEffect	CcoEffectBundle	Void	Returns the current CcoEffectBundle being applied due to morale if any
CurrentBreakdown	CcoStringValue (list)	Void	Returns the current list of effects as a list of CcoStringValue
IsLow	Bool	Void	Returns true if morale considered low (which gives penalties)
PredictedMoraleChange	Float	Void	Returns the difference between PredictedMorale and CurrentMorale
DebugMoraleEffectValue	Int	Void	Returns the current debug effect value

CcoCampaignMilitaryForceStance

Functions

Name	Return Type	Arguments
EnablePreview	Void	Void
DisablePreview	Void	Void
CanAfford	Void	Void
Activate	Void	Void
CanBeActivated	Void	Void
CanBeActivatedOnTerrain	Void	Void
IconPath	Void	Void
EffectList	Void	Void
IsActive	Void	Void
Name	Void	Void
Description	Void	Void
Key	Void	Void

CcoCampaignMilitaryForceWarTargetting

Functions

Name	Return Type	Arguments
SetTarget	Void	Context
IsValidTarget	Bool	Context
IsAvailable	Bool	Void
InvalidReasonsForTarget	UniString	Context
IssuingFactionContext	Context	Void
MilitaryForceContext	Context	Void
ToggleTargetting	Void	Void
EnableTargetting	Void	Bool
ZoomToTarget	Void	Void
ClearTarget	Void	Void
IsTargettingActive	Bool	Void

CcoCampaignMission

Component context wrapper for a CAMPAIGN_MISSION

Functions

Name	Return Type	Arguments	Description	Tags
CancelMission	Void	Void	Cancels this mission
Completed	Bool	Void	Returns whether the mission is completed
IsQuest	Bool	Void	Returns whether the mission is a quest
DevComplete	Void	Void	Completes the mission, dev only	debug
MissionIssuerContext	CcoMissionIssuerRecord	Void	Returns the mission issuer context for this mission
HasZoomLocation	Bool	Void	Returns whether the mission has a zoom location
ShowObjectivePanel	Void	Void	Shows the mission panel
QuestBattleWinChance	Float	Void	Returns the chance of winning the quest battle associated with this mission
IsCancelled	Bool	Void	Returns whether the mission is cancelled
ShowInSchemesPanel	Void	Void	Shows the schemes panel and selects this scheme (if it is a scheme)
MissionDefinitionContext	CcoCampaignMissionDefinition	Void	Returns the mission definition context for this mission
BattleSetPieceArmyList	CcoBattleSetPieceArmyRecord (list)	Void	Returns a list with the armies in the battle piece setup
TurnsRemaining	Int	Void	Returns the number of turns remaining for this mission
TeleportCharacter	Void	Void	Teleports the selected character or character associated with this mission to the quest battle for this mission
IsObjectivePanelOpen	Bool	Void	Returns whether the objective panel is open
ZoomToLocation	Void	Void	Zooms the camera to the location of this mission
BecameInactiveThisTurn	Bool	Void	Returns true if the mission went from active to expired/succeded/cancelled this turn
TeleportReasonTooltip	UniString	Void	Returns the teleport reason tooltip for the mission. Why you can or cannot teleport
SettlementContextAtObjectiveDisplayPosition	CcoCampaignSettlement	Void	Returns the settlement located at the display position of this mission objective.
PinMission	Void	Void	Pins this mission
MainOpponentArmy	CcoBattleSetPieceArmyRecord	Void	Returns the main (non-reinforcement) opponent army in the battle piece setup
CompletionStatus	Int	Void	Returns the completion status. 0 Active, 1 Succeeded, 2 Cancelled, 3 Expired
ShowMissionPanel	Void	Void	Shows the mission panel with this mission selected
IsObjectiveOverSettlementWithGarrisonedArmy	Bool	Void	Returns true if the display position for the mission objective is over a settlement that has an army stationed in it.
Position	Vector4	Void	Returns the position of this mission on the campaign map
ImagePath	String	Void	Returns the file path to the image for this mission
CharacterContextAtSettlementObjectiveDisplayPosition	CcoCampaignCharacter	Void	Returns the character located at the display position of the settlement at this mission objective.
MoviePath	String	Void	Returns the file path to the movie for this mission
CanBeCancelled	Bool	Void	Returns true if the mission can be cancelled
TargetSettlementContext	CcoCampaignSettlement	Void	Returns the target settlement if applicable. You could first use HasZoomLocation to check if this mission has a valid target.
IsPrologueStoryMission	Bool	Void	Returns true if this is a story line mission for prologue, we show some special fx on events related to these
CharacterContextAtObjectiveDisplayPosition	CcoCampaignCharacter	Float (optional)	Returns the character located at the display position of this mission objective. You can optionally specify a floating point argument as the additional search radius.
IsTeleportEnabled	Bool	Void	Returns whether teleport is enabled for this mission
QuestCharacterContext	CcoCampaignCharacter	Void	Returns the quest character context if this mission is a quest battle
IsVictoryCondition	Bool	Void	Returns whether this mission is a campaign victory condition
TargetCharacterContext	CcoCampaignCharacter	Void	Returns the target character if any. You could first use HasZoomLocation to check if this mission has a valid target.
IsPinned	Bool	Void	Returns whether the mission is pinned
MissionRecordContext	CcoMissionRecord	Void	Returns the mission record context for this mission
FactionContext	CcoCampaignFaction	Void	Returns the faction context for this mission
ShouldShowTeleportButton	Bool	Void	Returns whether to show the teleport button for this mission
BattleSetupInfoContext	CcoBattleSetupInfo	Void	Returns the battle setup info context for this mission

CcoCampaignMissionDefinition

Component context wrapper for a CAMPAIGN_MISSION_DEFINITION

Functions

Name	Return Type	Arguments	Description
SecondaryObjectivesList	CcoCampaignMissionObjective (list)	Void	Returns the list of secondary objective contexts
PrimaryTimedPayloadInfoList	CcoPair (list)	Void	Returns a list of CcoPair, each containing a timed payload and the remaining time of the payload
SecondaryPayloadInfoList	CcoCampaignPayloadInfo (list)	Void	Returns the list of the secondary payload info contexts
PrimaryObjectivesList	CcoCampaignMissionObjective (list)	Void	Returns the list of primary objective contexts
FactionIssuerContext	CcoCampaignFaction	Void	Returns the faction context of the issuer
PrimaryPayloadInfoContext	CcoCampaignPayloadInfo	Void	Returns the primary payload info context
Identifier	String	Void	Returns the mission identifier
TurnLimit	Int	Void	Returns the mission turn limit
IssuerName	UniString	Void	Returns the name of the mission issuer, if there is one
IssuerIcon	String	Void	Returns the mission issuer icon file path
Header	UniString	Void	Returns the header for the mission definition
Description	UniString	Void	Returns the description for the mission

CcoCampaignMissionObjective

Component context wrapper for a CAMPAIGN_MISSION_OBJECTIVE

Functions

Name	Return Type	Arguments	Description
MaxProgressValue	Int	Void	Returns the max progress value
ObjectiveRequirementsList	CcoCampaignMissionObjectiveRequirements (list)	Bool (optional)	Returns the mission objective requirements list
CanTrackProgress	Bool	Void	Returns whether progress can be tracked on this mission
ObjectiveCompleted	Bool	Void	Returns whether the objective has been completed
ObjectiveCancelled	Bool	Void	Returns whether the objective has been cancelled
CurrentProgressValue	Int	Void	Returns the current progress value

CcoCampaignMissionObjectiveRequirements

Component context wrapper for a CAMPAIGN_MISSION_COMPLETION_STATUS_LINE

Functions

Name	Return Type	Arguments	Description
BuildingLevelRecordContext	CcoBuildingLevelRecord	Void	Returns the optional building level record context of this objective
UnitRecordContext	CcoMainUnitRecord	Void	Returns the optional unit record context of this objective
ZoomTo	Void	Void	Zooms the campaign camera to the objective's zoom to location
TechnologyRecordContext	CcoTechnologyRecord	Void	Returns the optional technology record context of this objective
IsCompleted	Bool	Void	Returns whether the objective has been completed
HasZoomToLocation	Bool	Void	Returns whether the objective has a zoom to location
Description	UniString	Void	Returns the description of the objective
Tooltip	UniString	Void	Returns the tooltip of the objective

CcoCampaignNegotiation

Component context wrapper for a campaign negotiation

Functions

Name	Return Type	Arguments	Description	Tags	Events
TargetFactionContext	CcoCampaignFaction	Void	Returns the target faction (the non player faction in the negotiation)

CcoCampaignPayloadInfo

Wrapper for a payload, a payload is basically a reward from say a mission. Contains multiple CcoCampaignPayloadInfoEntry

Functions

Name	Return Type	Arguments	Description	Tags	Events
Entries	CcoCampaignPayloadInfoEntry (list)	Void	Returns the list of CcoCampaignPayloadInfoEntry entries for this payload

CcoCampaignPayloadInfoEntry

Wrapper for a payload entry, a payload is basically a reward from say a mission, this is one entry from the list accessed by CcoCampaignPayloadInfo

Functions

Name	Return Type	Arguments	Description
Icon	String	Void	Returns icon filepath to use
State	String	Void	Returns the state to use in layout, this is either thte rarity state of the ancillary, if no ancillary just returns 'effect'
Title	UniString	Void	Returns localised name of payload entry reward
SortOrder	Int	Void	Returns sort order of the payload
NumericValue	Int	Void	Returns the numeric value of a treasury reward, pooled resource transaction etc. without the rest of the text description, if not applicable, just returns 0
IsAccessible	Bool	Void	Returns true if payload is accessible (with DLC permissions)
UnitRank	Int	Void	Returns the unit rank, will return 0 if the payload doesn't provide a unit
UnitRecordContext	CcoMainUnitRecord	Void	Returns the CcoMainUnitRecord provided by the payload if there is any
IsUnitPayload	Bool	Void	Returns true if there is a UnitRecordContext
Ancillary	CcoAncillaryRecord	Void	Returns the CcoAncillaryRecord provided by the payload if there is any
TraitLevelRecordContext	CcoCharacterTraitLevelRecord	Void	Returns the CcoCharacterTraitLevelRecord provided by the payload if there is any
TurnsRemaining	Int	Void	Returns how many turns the payload lasts
EffectBundle	CcoEffectBundle	Void	Returns the CcoEffectBundle provided by the payload if there is any

CcoCampaignPendingAction

Cco wrapper for getting information on the current pending action in campaign. There can only ever be one hence this being a singleton that basically wraps the pending action manager instead of the pending actions themselves, as would be quite involved to wrap those lifetimes

Functions

Name	Return Type	Arguments	Description
IsActive	Bool	Void	Returns true if there is currently a pending action active (which blocks other players in simultaneous turns mpc)
IsBlockingLocalPlayer	Bool	Void	Returns true if the current pending action is blocking the local player (as in there is an action and we arent involved)
ActionType	String	Void	Returns UNlocalised name of current pending action
Description	UniString	Void	Returns localised description of current pending action
OwningFactionContext	CcoCampaignFaction	Void	Returns owning faction who has main responsibility of resolving this action
InvolvedFactionList	CcoCampaignFaction (list)	Void	Returns list of factions involved in this action
HasTimer	Bool	Void	Returns true if the pending action has a timer
HasZoomLocation	Bool	Void	Returns true if has a location can zoom to
ZoomTo	Void	Void	Zooms to location if HasZoomLocation is true
ShouldBlockAllInteractions	Bool	Void	Returns true if IsBlockingLocalPlayer and certain action types (like fullscreen media) which require to disable all interaction with campaign to avoid desyncs
TimeRemaining	Float	Void	Returns timer value of the pending action as a float

CcoCampaignPendingActionNotification

Component context wrapper for an individual notification/warning for CcoCampaignPendingActionNotificationQueue

Functions

Name	Return Type	Arguments	Description
Activate	Void	Void	Activates the notification, taking context sensitive action (like opening tech panel for tech available for example)
IconPath	String	Void	Returns icon path from end_turn_notification record
NotificationType	String	Void	Returns the notification type from end_turn_notification record
DisplayText	UniString	Void	Returns localised display text from end_turn_notification record
Description	UniString	Void	Returns localised detailed description from end_turn_notification record
PooledResourceContext	CcoCampaignPooledResource	Void	Returns the CcoCampaignPooledResource related to notification if exists
Title	UniString	Void	Returns localised title from end_turn_notification record
ProvinceContext	CcoCampaignProvince	Void	Returns the CcoCamapignProvince related to notification if exists
MilitaryForceContext	CcoCampaignMilitaryForce	Void	Returns the CcoCampaignMilitaryForce related to notification if exists
FactionContext	CcoCampaignFaction	Void	Returns the CcoCampaignFaction related to notification if exists
CharacterContext	CcoCampaignCharacter	Void	Returns the CcoCampaignCharacter related to notification if exists
SettlementContext	CcoCampaignSettlement	Void	Returns the CcoCampaignSettlement related to notification if exists
IsSkippable	Bool	Void	Returns true if this notification can be skipped
CanBeSupressed	Bool	Void	Returns true if this notification can be suppressed

CcoCampaignPendingActionNotificationQueue

Component context wrapper for end turn notification system (showing notifications/warnings to take care of before end turn)

Functions

Name	Return Type	Arguments	Description
IsNotificationTypeSupressed	Bool	String	Returns true if specified type has been suppressed
AreNotificationsVisible	Bool	Void	Returns true if notification system currently activated
IsNotificationListEmpty	Bool	Void	Returns true if there are currently no notifications so can just end turn
NotificationsList	ContextList	Void	Returns list of CcoCampaignPendingActionNotification that are currently active (showing on WH3 UI on end turn area)
CurrentContext	CcoCampaignPendingActionNotification	Void	Returns the current CcoCampaignPendingActionNotification to show in UI (we have cycle functionality in wh3)
PendingActionsOfItemList	ContextList	Context	Returns list of CcoCampaignPendingActionNotification that involve specified context (CcoCampaignMilitaryForce/CcoCampaignCharacter/CcoCampaignSettlement/CcoCampaignFaction)
PendingActionsOfTypeList	ContextList	String	Returns list of CcoCampaignPendingActionNotification matching specified type string (matching key in notifications table in db)
PendingActionsOfCategoryList	ContextList	String	Returns list of CcoCampaignPendingActionNotification matching specified category (army/character/region/faction)
CycleNotification	Void	Bool	Cycles through the current CurrentContext through NotificationsList (pass true for forwards, false for backwards)
SkipCurrentContext	Void	Void	Skips current notification, essentially suppressing it for this turn
PendingActionList	ContextList	Void	Returns full list of current CcoCampaignPendingActionNotification to be aware of before ending turn
ToggleSupressNotificationType	Void	String, Bool (optional)	Toggles suppression of a specific type of notification for specified notification key from db. If pass true as a second parameter, will ignore if db specifies if this can be suppressed (used for script)
SetAllNotificationsSuppressed	Void	Bool	Sets the suppression of all types of notification.
ToggleNotifications	Void	Void	Toggles the notification system to be on/off
SetActive	Void	Void	Turns the notification system on

CcoCampaignPlagueComposition

Wrapper for a plague composition (base plague plus ingredients)

Functions

Name	Return Type	Arguments	Description
SpreadChanceToForcesPercentage	Float	CcoCampaignFaction	Returns an float between with the percentage the spread change for force targets
SpreadChanceToRegion	Float	CcoCampaignSettlement, CcoCampaignFaction	Returns the chance for this plague to spread to a specific region for the creator
ReductionPostSpreadPercentage	Float	CcoCampaignFaction	Returns an float between with the percentage spread change reduction after spreading
SpreadChanceToRegionsPercentage	Float	CcoCampaignFaction	Returns an float between with the percentage the spread change for region targets
InfectionDurationForTarget	Int	CcoCampaignFaction, Context	Returns an int with the duration of this compositio for the passed in target
ImmunityDuration	Int	CcoCampaignFaction	Returns an int with the immunity duration of a target after being infected
InfectionDuration	Int	CcoCampaignFaction	Returns an int with the duration of this composition
PlagueIngredientList	CcoCampaignPlagueIngredient (list)	Void	Returns a list of plague ingredients in the infection data
CombinedEffectsAndTypeList	CcoPlagueEffectList (list)	ExpressionState, Bool, CcoCampaignFaction (optional)	Returns a list of combined effects from base and ingredients, grouped by type as a CcoPair. First in CcoPair is either list of CcoEffect if bool parameter is false or list of CcoCampaignPlagueCompositionEffectList is bool is true. Second returns the type
BasePlagueContext	CcoCampaignBasePlague	Void	Returns the plague record context in the infection data
SpecialCompositionForFactionContext	CcoPlagueSpecialCompositionRecord	CcoCampaignFaction	Returns the special composition for this combination of plague and ingredients for the passed in faction, if any
Name	UniString	Void	Returns the name of the composition. Will be either the name of the reciepe if exists, if not the combination of base and ingredients
SpreadChanceToForce	Float	CcoCampaignMilitaryForce, CcoCampaignFaction	Returns the chance for this plague to spread to a specific military force for the creator

CcoCampaignPlagueCompositionEffectList

A small class to wrap an effect list with a plague or ingredient where it came from (to avoid nesting CcoPairs)

Functions

Name	Return Type	Arguments	Description	Tags	Events
PlagueOrIngredientContext	Context	Void	Returns the plague or ingredient that the effect bundle belongs to
EffectList	CcoEffect (list)	Void	Returns the list of effects

CcoCampaignPlagueInfection

Wrapper for a campaign REGION_INFECTION or MILITARY_FORCE_INFECTION

Functions

Name	Return Type	Arguments	Description
SpreadChanceToRegionsPercentage	Float	Void	Returns an float between with the percentage the spread change for region targets
SpreadChanceToForcesPercentage	Float	Void	Returns an float between with the percentage the spread change for force targets
ImmunityDuration	Int	Void	Returns an int with the immunity duration of a target after being infected
ReductionPostSpreadPercentage	Float	Void	Returns an float between with the percentage spread change reduction after spreading
InfectionDuration	Int	Void	Returns an int with the base duration of this infection
RemainingDuration	Int	Void	Returns an int with the remaining duration of this infection
Name	UniString	Void	Returns the name of the composition. Will be either the name of the reciepe if exists, if not the combination of base and ingredients
PlagueCompositionContext	CcoCampaignPlagueComposition	Void	Returns a CcoCampaignPlagueComposition with the plague composition context
EffectBundleList	CcoEffectBundle (list)	Void	Returns a list of CcoEffectBundle with the effect bundles provided by the infection

CcoCampaignPlagueIngredient

Wrapper for a campaign plague component

Functions

Name	Return Type	Arguments	Description
Name	UniString	Void	Returns the name of the plague component record
Description	UniString	Void	Returns the description of the plague component record
PlagueEffectContext	CcoPlagueEffectRecord	Void	Returns a CcoPlagueEffectRecord which contains all effect bundles for this ingredient
Key	String	Void	Returns the key of the plague component record
ImagePath	String	Void	Returns the image path of the plague component record
CooldownDuration	Int	CcoCampaignFaction (optional)	Returns the number of turns left for cooldown, or 0 if none
PlagueParametersRecordContext	CcoPlagueParameterRecord	Void	Returns the plague parameters for this component
UIOffset	Vector4	Void	Returns the offset used by the UI, or {0, 0} if none
ResourceTransactionContext	CcoCampaignResourceTransaction	Void	Returns the resource transaction context with the cost of this ingredient
RequiredTechnologyContext	CcoCampaignTechnology	Void	Returns the required technology needed to unlock this ingredient
IsMutation	Bool	Void	Returns true if the component is a mutation
UnlockTooltip	UniString	CcoCampaignFaction (optional)	Returns the reason with how to unlock the ingredient for the faction passed in (or for players faction if no faction is passed)
IsOnCooldown	Bool	CcoCampaignFaction (optional)	Returns true if the component is on cooldown for the faction passed in (or for players faction if no faction is passed)
IsBlessed	Bool	CcoCampaignFaction (optional)	Returns true if the component is blessed for the faction passed in (or for players faction if no faction is passed)
IsAvailable	Bool	CcoCampaignFaction (optional)	Returns true if the component is available for the faction passed in (or for players faction if no faction is passed)
IsUnlocked	Bool	CcoCampaignFaction (optional)	Returns true if the component is unlocked for the faction passed in (or for players faction if no faction is passed)

CcoCampaignPlaguesCompositionSystem

Wrapper for a campaign plagues composition system

Functions

Name	Return Type	Arguments	Description	Tags
CompositionAndTargetPair	CcoPair	Context, Context	Returns a CcoPair created from the infection and target passed in, to be used for rituals
PlagueSpecialCompositionList	CcoPlagueSpecialCompositionRecord (list)	Void	Returns a the list of special compositions that the faction has access to
PlagueCompositionContext	CcoCampaignPlagueComposition	CcoCampaignBasePlague, ContextList	Returns the a plague composition cco that will be created from the plague record and plague ingredients passed in
PlagueIngredientsList	CcoCampaignPlagueIngredient (list)	Void	Returns a the list of plague ingredients that the faction has access to
HasAvailablePlagueComponents	Bool	Void	Checks if the human player has access to any usable plague components
DevUnlockPlagues	Void	Void	Unlock all base plagues and components	debug, hide_in_uied
BasePlagueList	CcoCampaignBasePlague (list)	Void	Returns a list will the faction plagues, if any
InfectTarget	Void	CcoCampaignPlagueComposition, Context	Infects the passed in target with the passed in plague composition

CcoCampaignPooledResource

Wrapper for a campaign pooled resource

Functions

Name	Return Type	Arguments	Description	Tags
PendingFactorList	CcoStringValue (list)	Void	Returns the list of pending factors that will be added to the value in the next turn
Min	Int	Void	Returns the minimum value
IsPersistentResource	Bool	Void	Returns true if this pooled resource has persistant factors (as in they arent evaluated per turn and instead stockpile)
FactorList	CcoStringValue (list)	Void	Returns list of factors that are contributing to current value
PredictedGroupPooledResourceEffectContext	CcoGroupPooledResourceEffectRecord	ExpressionState, Int, String (optional)	Returns the CcoGroupPooledResourceEffectRecord taking into account a delta amount to apply to the total. Optionally can specify an effect type, defaults to percentage of capacity effect type
TotalLessThanZeroAndNotCertainResources	Bool	ExpressionState	Returns true if this pooled resource has a negative total and isnt specific hardcoded resources (sigh, added in wh2)
PositiveFactorList	CcoStringValue (list)	Void	Returns a list of the factors that can be positive (but aren't necessarily currently)
IconPath	String	Void	Returns the icon filepath
EffectBarPercentage	Float	ExpressionState, Bool, String (optional), Int (optional)	Returns the bar percentage based on effect bounds. The last effect can be ignored and will be always full as soon at the total becomes more than the lower bound. Optionally can specify an effect type, defaults to percentage of capacity effect type
Total	Int	ExpressionState	Returns the current total value (not factor total, this is the current amount)
TooltipAudio	String	Void	Returns the associated tooltip VO event
EffectBundleForPercentList	CcoEffectBundle (list)	Float, CcoCampaignFaction (optional)	Returns a list of effect bundles that would be active at the specified percent value. Can optionally specify faction to get effects for. Prefiltered to not include those that shouldnt appear in UI
CurrentGroupPooledResourceEffectContext	CcoGroupPooledResourceEffectRecord	ExpressionState, String (optional)	Returns the current CcoGroupPooledResourceEffectRecord. Optionally can specify an effect type, defaults to percentage of capacity effect type
EffectBundleList	CcoEffectBundle (list)	CcoCampaignFaction (optional)	Returns a list of effect bundles active due to pooled resource. Can optionally specify faction to get effects for. If none specified, will get effects of owning faction of this resource. Prefiltered to not include those that shouldnt appear in UI
EffectList	CcoGroupPooledResourceEffectRecord (list)	ExpressionState, String (optional)	Returns the current effects active due to this pooled resource. Optionally can specify an effect type, defaults to percentage of capacity effect type
DevAddAmount	Void	Int	adds a specified amount to this pooled resource by going through factors and adding values until value change by amount we specify). Can use negatives.	debug, hide_in_uied
Key	String	Void	Returns the record key
EffectBundleUnfilteredList	CcoEffectBundle (list)	CcoCampaignFaction (optional)	Returns a list of effect bundles active due to pooled resource. Can optionally specify faction to get effects for. If none specified, will get effects of owning faction of this resource. Includes those that wont shown in UI	hide_in_uied
OwningFactionContext	CcoCampaignFaction	Void	Returns the faction that owns this context if any
NegativeFactorsName	UniString	Void	Returns the localised name given for the negative factors
FactorTotal	Int	Void	Returns the total of all the current factors (not same as total, as factors could be leading to Total changing per turn)
Description	UniString	Void	Returns the localised description
PercentageToNextEffect	Float	ExpressionState, String (optional)	Returns the percentage of the way to the next effect
PredictedPercentageOfCapacity	Float	Void	Returns the prediced percentage value of max on the next turn
TotalAndChangeString	UniString	ExpressionState	Returns a localised text display of total with change (like: 10 (+20)), as a convenient function to display this in most places we show resources (as usually useful to know total/change at a glance like with treasury)
PendingFactorTotal	Int	Void	Returns the total of the pending factor list
SettlementBreakdownContext	CcoCampaignPooledResourceSettlementBreakdown	CcoCampaignSettlement	Returns the breakdown context for this pooled resource on the specified settlement
PositiveFactorTotal	Int	Void	Returns the total of all the current positive factors
PredictedTurnsToReachAmount	Int	Int, Int (optional)	Returns the predicted number of turns needed to reach a certain amount. Optionally you can specify an extra delta for the current amount.
PendingFactorsName	UniString	Void	Returns the localised name given for the pending factors
PercentageOfCapacity	Float	ExpressionState	Returns the current percentage the value is of the max
MilitaryForceBreakdownContext	CcoCampaignPooledResourceMilitaryForceBreakdown	CcoCampaignMilitaryForce	Returns the breakdown context for this pooled resource on the specified military force
NegativePendingFactorList	CcoStringValue (list)	Void	Returns a list of the pending factors that can be negative (but aren't necessarily currently)
SortOrder	Int	Void	Returns the sort order for this pooled resource (for when have multiple linked pooled resources like corruption)
AchievementThresholdSetList	CcoPooledResourceThresholdOperationSetRecord (list)	Void	Returns a list of thresholds that can be unlocked with achievements
Name	UniString	Void	Returns the localised name
ProvinceBreakdownContext	CcoCampaignPooledResourceProvinceBreakdown	CcoCampaignProvince	Returns the breakdown context for this pooled resource on the specified province
PositiveFactorsName	UniString	Void	Returns the localised name given for the positive factors
NegativeFactorTotal	Int	Void	Returns the total of all the current negative factors
Max	Int	Void	Returns the maximum value
AvailableThresholdSetList	CcoPooledResourceThresholdOperationSetRecord (list)	Void	Returns a list of available threshold sets, which have a range that confers effects and armory items
InitialMax	Int	Void	Returns the maximum value specified in the record, so that we can display the original value even after getting changed by effects
ActiveThresholdSetList	CcoPooledResourceThresholdOperationSetRecord (list)	Void	Returns a list of active threshold sets, which have a range that confers effects and armory items
PositivePendingFactorList	CcoStringValue (list)	Void	Returns a list of the pending factors that can be positive (but aren't necessarily currently)
NextGroupPooledResourceEffectContext	CcoGroupPooledResourceEffectRecord	ExpressionState, String (optional)	Returns the next CcoGroupPooledResourceEffectRecord. Optionally can specify an effect type, defaults to percentage of capacity effect type
ShouldDisplayZeroFactors	Bool	Void	Returns true if the resource should always display zero factors
NegativeFactorList	CcoStringValue (list)	Void	Returns a list of the factors that can be negative (but aren't necessarily currently)
RangedTierList	CcoRangeWithContext (list)	Void	Returns a list of effects with tiers so can see effects at each tier of values

CcoCampaignPooledResourceDistributor

Wrapper for a pooled resource distributor. Can exist on anything that has an ENTITY_ID

Functions

Name	Return Type	Arguments	Description	Tags	Events
IsDistributionEnabled	Bool	CcoCampaignPooledResource	Returns whether distribution of the specified pooled resource is allowed to this entity
SetDistributionEnabled	Void	CcoCampaignPooledResource, Bool	Sets whether this entity allows pooled resource distribution for the provided pooled resource

CcoCampaignPooledResourceManager

Context wrapper for pooled resource manager.

Functions

Name	Return Type	Arguments	Description
CanAffordTreasuryCost	Bool	CcoCampaignResourceTransaction	Returns true if can afford the treasury cost of the specified resource transaction
HasRequiredTradeResources	Bool	CcoCampaignResourceTransaction	Returns true if this transaction has the required trade resources
CanAffordSpecificPooledResourceCost	Bool	CcoCampaignPooledResourceTransaction	Returns true if can afford the specific pooled resource cost specified by provided CcoCampaignPooledResourceTransaction
CanAffordPooledResourceCost	Bool	CcoCampaignResourceTransaction	Returns true if can afford the pooled resource cost of the specified resource transaction
CanAfford	Bool	CcoCampaignResourceTransaction	Returns true if can afford the resource cost of the specified resource transaction

CcoCampaignPooledResourceMilitaryForceBreakdown

Wrapper for a military force breakdown of a pooled resource

Functions

Name	Return Type	Arguments	Description
FactorTotal	Int	Void	Returns the total value from the factor list
FactorValue	Int	String	Returns value of a specific factor given the specified factor key
NegativeFactorList	CcoStringValue (list)	Void	Returns a list of only the factors that can be negative (but arent necessarily right now)
PooledResourceContext	CcoCampaignPooledResource	Void	Returns the pooled resource this breakdown is for
Total	Int	Void	Returns the total amount of pooled resource in this force
FactorList	CcoStringValue (list)	Void	Returns a list of factors for this pooled resource in this force
PositiveFactorList	CcoStringValue (list)	Void	Returns a list of only the factors that can be positive (but arent necessarily right now)

CcoCampaignPooledResourceProvinceBreakdown

Wrapper for a province breakdown of a pooled resource

Functions

Name	Return Type	Arguments	Description
PooledResourceContext	CcoCampaignPooledResource	Void	Returns the pooled resource this breakdown is for
Total	Int	Void	Returns the total amount of pooled resource in this province
PositiveFactorList	CcoStringValue (list)	Void	Returns a list of only the factors that can be positive (but arent necessarily right now)
NegativeFactorList	CcoStringValue (list)	Void	Returns a list of only the factors that can be negative (but arent necessarily right now)
FactorList	CcoStringValue (list)	Void	Returns a list of factors for this pooled resource in this province
FactorTotal	Int	Void	Returns the total value from the factor list
FactorValue	Int	String	Returns value of a specific factor given the specified factor key

CcoCampaignPooledResourceSettlementBreakdown

Wrapper for a region/settlement breakdown of a pooled resource

Functions

Name	Return Type	Arguments	Description
FactorList	CcoStringValue (list)	Void	Returns a list of factors for this pooled resource in this settlement
FactorTotal	Int	Void	Returns the total value from the factor list
FactorValue	Int	String	Returns value of a specific factor given the specified factor key
PooledResourceContext	CcoCampaignPooledResource	Void	Returns the pooled resource this breakdown is for
Total	Int	Void	Returns the total amount of pooled resource in this settlement
PositiveFactorList	CcoStringValue (list)	Void	Returns a list of only the factors that can be positive (but arent necessarily right now)
NegativeFactorList	CcoStringValue (list)	Void	Returns a list of only the factors that can be negative (but arent necessarily right now)

CcoCampaignPooledResourceTransaction

Context wrapper for pooled resource transactions.

Functions

Name	Return Type	Arguments	Description
Icon	String	Void	Returns the icon path for the transaction
ValuePercentage	Int	Void	Returns the value as a percentage of max could be
SupplementColour	Colour	Void	Returns the colour for the transaction
AbsoluteValue	Int	Void	Returns the absolute value (always positive)
Order	Int	Void	Returns the sort order
Description	UniString	Void	Returns the localised description
Value	Int	Void	Returns the value
NamePositive	UniString	Void	Returns the localised name to show when positive
NameNegative	UniString	Void	Returns the localised name to show when negative
Name	UniString	Void	Returns the localised name
LocalisedText	UniString	Void	Returns the localised text which is value and name combination
ResourceKey	String	Void	Returns the resource record key

CcoCampaignProvince

Wrapper for a campaign province.

Functions

Name	Return Type	Arguments	Description	Tags
IsContested	Bool	Void	Returns true if it's being contested by another faction.
NumRegions	Int	Void	Returns an int with the number of regions in the province.
WindsOfMagicAreaContext	CcoCampaignWindsOfMagicArea	Void	Returns the context of the winds of magic area in this province.
IsSelected	Bool	Void	Returns true if any settlement in this province is selected.
ModelProvinceContext	CcoCampaignModelProvince	Void	Returns the CcoCampaignModelContext for this province
Name	UniString	Void	Returns the localised name of the province.
PooledResourceManagerContext	CcoCampaignPooledResourceManager	Void	Returns the context of the pooled resource manager of this province, which can calculate if the province can afford transactions.
SettlementList	ContextList	Void	Returns the settlement list in the province.
DevAddDevPoint	Void	Void	Dev command that adds development points to this province.	debug, hide_in_uied
LocalPlayerProvinceManagerContext	CcoCampaignFactionProvinceManager	Void	Returns the context of the local player province manager, if this exists in this province.
ProvinceManagerForFaction	CcoCampaignFactionProvinceManager	CcoCampaignFaction	Returns the context of the province manager of the faction that is passed in, if it exists in this province.
PooledResourceContext	CcoCampaignPooledResource	String	Returns the context of the pooled resource with the key specified, if this resource exists in the province.
PooledResourceList	ContextList	Void	Returns a list with all the pooled resources from this province.
CapitalSettlementContext	CcoCampaignSettlement	Void	Returns the context of the capital settlement of this province
CQI	Int	Void	Returns an int with the cqi of this object.
IsPlayerInvolved	Bool	Void	Returns true if the player faction own any regions in this province.
IsPlayerCompleteOwner	Bool	Void	Returns true if player owns all the settlements in the province
FactionContext	CcoCampaignFaction	Void	Returns the faction that owns all settlements in the province. If there is no such faction, returns nullptr
PlayerFactionForeignSlotIncome	Int	Void	Returns the province income that the player makes from foreign slots
Income	Int	Void	Returns the income that this province generates
MercenaryPoolContext	CcoCampaignProvinceMercenaryPool	Void	Returns the context of mercenary pool of this province
SelectAndZoom	Void	Void	Selects and zooms to a settlement in this order: player capital, player owned settlement, province capital.
ZoomTo	Void	Void	Zooms to capital of province

CcoCampaignProvinceAutoManagement

Wrapper for province auto-management logic

Functions

Name	Return Type	Arguments	Description
ToggleHighPriority	Void	Void	Sets this province as high priority, or sets it as normal priority if already high priority
ChooseFocus	Void	CcoProvinceAutomanagementFocusRecord	Chooses a focus for this province
FocusList	CcoProvinceAutomanagementFocusRecord (list)	Void	Returns a list of focus records that can be set for this province
CurrentFocusContext	CcoProvinceAutomanagementFocusRecord	Void	Returns the current focus records that is selected in this province
IsHighPriority	Bool	Void	Returns true if the province is currently considered as high priority
ToggleAutoManaging	Void	Void	Activates the auto management for this province or deactivates it if already active
IsAutoManaging	Bool	Void	Returns true if the province is currently being auto managed by the AI

CcoCampaignProvinceGovernorship

Wrapper for a province governorship

Functions

Name	Return Type	Arguments	Description
CharacterDetailsContext	CcoCampaignCharacter	Void	Returns the detail of the character that governs this province
IsOnCooldown	Bool	Void	Returns true if the effects of the governor are on cooldown
ProvinceContext	CcoCampaignProvince	Void	Returns the context of the province for this governorship
PendingDecisionContext	CcoCampaignDecisionRecord	Void	Returns the pending decision for this governorship if it exists

CcoCampaignPublicOrder

Functions

Name	Return Type	Arguments
HappinessRangeEffectBundleList	Void	Void
ProvidedEffectBundle	Void	Void
BalancePercentage	Void	Void
Details	Void	Void
ChangePerTurn	Void	Void
ChangePerTurnState	Void	Void
BreakdownList	Void	Void
Balance	Void	Void
State	Void	Void

CcoCampaignResourceTransaction

Context wrapper for resource transactions.

Functions

Name	Return Type	Arguments	Description
PooledResourceTransactionList	CcoCampaignPooledResourceTransaction (list)	Void	Returns the list of pooled resource transactions
AbsoluteTreasuryChange	Int	Void	Returns the absolute treasury change (always positive)
TotalResourceChange	Int	CcoCampaignPooledResource	Returns the absolute resource change (always positive)
Add	CcoCampaignResourceTransaction	CcoCampaignResourceTransaction	Returns the result of adding 2 transactions together
TreasuryTransactionList	CcoCampaignTreasuryTransaction (list)	Void	Returns the list of pooled resource treasure transactions
TradeResourceList	CcoResourceRecord (list)	Void	Returns the list of required trade resources
CanAffordResourceTransaction	Bool	CcoCampaignPooledResource	Checks if the passed pooled resource can afford this resource transaction

CcoCampaignRitual

Wrapper for a campaign ritual

Functions

Name	Return Type	Arguments	Description
RitualInteractionContext	CcoCampaignRitualInteraction	Void	Returns the context of the ritual targeting interface, used for selecting targets in 3d space.
DefaultFactionTargetContext	CcoCampaignFaction	Void	Returns the default faction target (if any) this ritual is setup to point at
RemainingScriptLockTime	Int	Void	Returns the remaining time that the ritual is locked by script
LastCompletedRitualTargetContext	Context	Void	Returns the context of the target that was used when last performing the ritual
FactionContext	CcoCampaignFaction	Void	Returns the faction context of the ritual
IsOnCooldown	Bool	Void	Returns true if the ritual is on cooldown
IsRitualEffectBundleActiveOnTarget	Bool	Context	Returns true if the ritual effect is active on target. Context parameter can be a CcoCampaignMilitaryForce, CcoCampaignSettlement or CcoCampaignFaction
RitualCompletionPayloadDuration	Int	ExpressionState	Returns an int with the completion payload duration
TargetType	String	Void	Returns a string with the type of target this ritual requires. Returns empty string if no target is required.
InvalidTargetReason	UniString	Context	Returns a localised string with text explaining why the supplied target isnt valid to perform the ritual on. If valid to perform on, or no target supplied will return empty string
RemainingCooldown	Int	Void	Returns the remaining cooldown for the ritual
IsActive	Bool	Void	Returns true if the ritual is active
RemainingCastTime	Int	Void	Returns the remaining cast time of the ritual
InvalidRitualReason	UniString	ExpressionState, Context (optional), CcoCampaignCharacter (optional)	Returns a localised string with text explaining why the ritual cannot be performed
RemainingRitualCooldownForTarget	Int	Context	Returns the remaining cooldown for a target. Context parameter can be a CcoCampaignMilitaryForce, CcoCampaignSettlement or CcoCampaignFaction
Perform	Void	Context (optional), CcoCampaignCharacter (optional)	Performs the ritual. Optional context parameter can be a CcoCampaignMilitaryForce, CcoCampaignSettlement or CcoCampaignFaction
CompletedRitualTargetAndDurationList	CcoPair (list)	ExpressionState	Goes through all completed rituals of this type and returns a list of all targets and their remaining payload duration
TargetResourceTransactionContext	CcoCampaignResourceTransaction	Context	Returns a context to the target resource. Parameter can be a CcoCampaignMilitaryForce, CcoCampaignSettlement or CcoCampaignFaction
TargetCriteriaText	UniString	Void	Returns a localised string with text explaining the necessary target criteria requirements
RitualContext	CcoRitualRecord	Void	Returns a context to the ritual
InvalidReasonForRitualWithAnyValidTarget	UniString	ExpressionState, CcoCampaignCharacter (optional)	Returns a localised string with text explaining why the ritual cannot be performed with any of the valid targets it has, or that it has no valid targets if there are none
RemainingCategoryCooldownForTarget	Int	Context	Returns the remaining cooldown for a target category. Context parameter can be a CcoCampaignMilitaryForce, CcoCampaignSettlement or CcoCampaignFaction
CanAfford	Bool	Context (optional)	Returns true if we can afford the cost of this ritual
IsTargetValid	Bool	Context	Returns true if the provided target is valid. Context parameter can be a CcoCampaignMilitaryForce, CcoCampaignSettlement or CcoCampaignFaction
LockedByPreviousInChain	Bool	Void	Returns true if the ritual is locked by having to complete a previous ritual in the same chain
CanPerformRitualWithAnyValidTarget	Bool	CcoCampaignCharacter (optional)	Checks if there are any valid targets for a ritual that doesn't target self, and if there are returns true if we can perform the ritual with any of those valid targets. Optional param for a performer.
CanPerformRitual	Bool	Context (optional), CcoCampaignCharacter (optional)	Returns true if the ritual can be performed. Optional context param for the target, in case the ritual requires one
ResourceTransactionContext	CcoCampaignResourceTransaction	Context (optional)	Returns a context to the resource transaction
ScriptLockedReason	UniString	Void	Returns the reason for why a ritual is locked by script
IsRepeatableRitual	Bool	Void	Returns true if the rituals cooldown_time is not set to -1
IsComplete	Bool	Void	Returns true if the ritual is completed
IsRitualCategoryActive	Bool	Void	Returns true if a ritual category is active
RequiresTarget	Bool	Void	Returns true if the ritual requires a target
CooldownUponActivation	Int	Void	Returns the cooldown for the ritual. Faction bonus values are checked.
LastCompletedRitualRemainingPayloadDuration	Int	ExpressionState	Returns an int with the remaining duration of the payload of the last ritual completed
IsAvailable	Bool	Void	Returns true if the ritual is available
SlaveCost	Int	Void	Returns the amount of slaves the ritual costs, taking bonus values into account
IsScriptLocked	Bool	Context (optional)	Returns true if the ritual is locked by script
MortuaryCategoryContext	CcoMortuaryCultCategoryRecord	Void	Returns the mortuary cult category if it exists

CcoCampaignRitualChain

Wrapper for a live campaign ritual chain, can be used to query position in chain

Functions

Name	Return Type	Arguments	Description
NextInChainContext	CcoCampaignRitual	Void	Get context of next ritual in the chain, if any
LastCompletedOrFirstRitualContext	CcoCampaignRitual	Void	Get context of last completed ritual in chain, or first if none
RitualChainContext	CcoRitualChainRecord	Void	Get record context for the chain
LastCompletedContext	CcoCampaignRitual	Void	Get context of last completed ritual in chain if any completed
RitualsList	CcoCampaignRitual (list)	Void	Get list of CcoCampaignRituals in the chain

CcoCampaignRitualInteraction

Class that manages targetting interface interaction for a ritual

Functions

Name	Return Type	Arguments	Description
InvalidReasonsForTarget	UniString	Context	Returns the reasons why the passed in target is invalid. Returns empty string if valid
IsTargettingActive	Bool	Void	Returns true if this is the currently active targetting interface
IsContextTargeted	Bool	Context	Returns whether the given context is targeted. (Allows child classes to add unique targeting conditions)
WasActionPerformed	Bool	Void	Returns true if the ritual is completed
RitualContext	CcoCampaignRitual	Void	Returns the context of the ritual associated with this class.
IsRepeatable	Bool	Void	Returns true if the ritual is repeatable
CurrentTargetContext	Context	Void	Returns the context of the current target, if any has been set
SetupInitialTargetFaction	Void	CcoCampaignFaction, Bool (optional)	Does the initial setup of the factions without notifying. If passed in faction is not valid, sets target to first known faction instead
ActionPerformTooltip	UniString	Void	Returns a tooltip specifying whether can perform the ritual or not, exmplaining the reason if cannot be performed
TargetFactionContext	CcoCampaignFaction	Void	Returns the target faction context if any
ActionCost	CcoCampaignResourceTransaction	Void	Returns the cost of the ritual.
CanPerformAction	Bool	CcoCampaignCharacter (optional)	Returns true if can perform ritual with the current target setup
SetTarget	Void	Context	Sets the target to the object passed in
PerformAction	Void	CcoCampaignCharacter (optional)	Performs a ritual with the current target stored
UpdateTargetFaction	Void	Bool (optional)	Updates the faction with the current targetting interface faction. This is so all targetting interfaces are in sync
ToggleTargetting	Void	Void	Toggles the targetting system through the CampaignTargettingInterface.
ClearTarget	Void	Void	Clears the currently stored target
IsValidTarget	Bool	Context	Returns true if the passed in object is a valid target
ZoomToTarget	Void	Void	Zooms to the stored target
EnableTargetting	Void	Bool	Is passed true, enables this as the targetting interface, else disables it.

CcoCampaignRitualManager

Wrapper for a faction's ritual manager

Functions

Name	Return Type	Arguments	Description
HasAccessToRitualCategory	Bool	CcoRitualCategoryRecord	Returns whether faction has access to provided ritual category
AvailableRitualList	CcoCampaignRitual (list)	Void	Get list of available rituals
UnlockableRitualList	CcoCampaignRitual (list)	Void	Get list of unlockable rituals
RitualChainContextFromKey	CcoCampaignRitualChain (list)	String	Returns list of ritual chains matching given key
RitualChainContextFromCategory	CcoCampaignRitualChain (list)	String	Returns list of ritual chains for given ritual category string
RitualContext	CcoCampaignRitual	CcoRitualRecord	Get a CcoCampaignRitual if one exists from a provided ritual record

CcoCampaignRoot

Functions

Name	Return Type	Arguments	Description	Tags
IsHUDVisible	Bool	Void	Returns true if the campaign HUD is currently visible
EndTurn	Void	Void	Ends the current campaign turn
CampaignMapPlayableAreaRecordContext	CcoCampaignMapPlayableAreaRecord	Void	Returns the CcoCampaignMapPlayableAreaRecord for the current campaign
IsCinematicModeEnabled	Bool	Void	Returns true if cinematic mode is currently enabled
CursorContext	CcoCampaignCursorContext	Void	Returns the current cursor context based on current mouseover (to get information on what is moused over)
DevEndTurnJustForMe	Void	Void	Ends the current campaign turn just for local player, skips all other factions turn. Only for dev usage.	debug, hide_in_uied
OpenTeleportationNodeList	CcoTeleportationNetworkNodeRecord (list)	Void	Returns list of the teleportation nodes that are currently open
SelectNext	Void	Void	Cycles selection forward
IsPlayersTurn	Bool	Void	Returns true if currently the players turn
SelectPrevious	Void	Void	Cycles selection backwards
CampaignFactionCheatSheetList	CcoCampaignFactionCheatSheetEntryRecord (list)	Void	Returns list of CcoCampaignFactionCheatSheetEntryRecords for the player faction's cheat sheet
ToggleCinematicMode	Void	Void	Toggles cinematic mode
AreaOfInterestList	CcoCampaignAreaOfInterest (list)	Void	Returns list of all the areas of interest in the campaign
ToggleHUD	Void	Void	Toggles the campaign HUD visibility
IsPrologue	Bool	Void	Returns true if the current campaign is the prologue
NetworkPlayerList	CcoNetworkPlayer (list)	Void	Returns list of all the human players in the current mp game
ClearSelection	Void	Void	Clears any selection in campaign
IsMultiplayer	Bool	Void	Returns true if campaign is multiplayer
ChangeOverlayMode	Void	String	Changes mode of the map overlay
SettlementList	CcoCampaignSettlement (list)	Void	Returns list of all settlements in the campaign
TurnNumber	Int	Void	Returns the current turn number
SetOverlayLocked	Void	Bool	Sets whether the map overlay is locked or not
ProvinceList	CcoCampaignProvince (list)	Void	Returns list of all provinces in the campaign
Year	Int	Void	Returns the current year as a number
CharacterList	CcoCampaignCharacter (list)	Void	Returns list of all characters in the campaign
DevTriggerDilemma	Void	String	Triggers dilemma for player faction, only for dev usage	debug, hide_in_uied
DateString	UniString	Void	Returns the current data as a localised string
SetOverlayVisible	Void	Bool	Sets whether map colouring overlay is visible
MilitaryForceList	CcoCampaignMilitaryForce (list)	Void	Returns list of all military forces in the campaign
CampaignKey	String	Void	Returns the campaign record key
RebelFactionContext	CcoCampaignFaction	Void	Returns the CcoCampaignFaction for rebels
DevTriggerIncident	Void	String	Triggers incident for player faction, only for dev usage	debug, hide_in_uied
IsTacticalViewActive	Bool	Void	Returns true if tactical view is active
FactionList	CcoCampaignFaction (list)	Void	Returns list of all factions in the campaign
CanAdvanceSelection	Bool	Void	Returns true if can select next or previous item
RoundName	UniString	Void	Returns the current round name (such as season for example)
DiplomacyManagerContext	CcoCampaignDiplomacyManager	Void	Returns the diplomacy manager context for getting pending negotiations, etc
CanQuickSave	Bool	Void	Returns true if can currently save the campaign
TriggerModelScriptNotificationEvent	Void	CcoCampaignFaction, String	Sends a UITriggerScriptEvent to script with specified faction id and key so can have delayed script events to handle (like perform a command and then tell to script to react once command processed for example
PendingActionContext	CcoCampaignPendingAction	Void	Returns the pending action context to get information on current pending action (if any)
IsLocomotionComplete	Bool	Void	Returns true if all character locomotion is complete (no characters moving)
DevTriggerMission	Void	String	Triggers mission for player faction, only for dev usage	debug, hide_in_uied
WindsOfMagicSystem	CcoCampaignWindsOfMagicSystem	Void	Returns the winds of magic system
QuickSave	Void	Void	Creates a quick save for campaign
NotificationQueueContext	CcoCampaignPendingActionNotificationQueue	Void	Returns the notification queue context
CanCycleSelection	Bool	Void	Returns true if can currently cycle selection
ShowEscapeMenu	Void	Void	Shows the campaign escape menu

CcoCampaignRouteNode

Wrapper for campaign route node

Functions

Name	Return Type	Arguments	Description
IsDestinationAvailable	Bool	CcoCampaignCaravan	Returns true if this node is available as a destination for the specified caravan
SegmentTowardsNodeContext	CcoCampaignRouteSegment	CcoCampaignRouteNode	Returns the segment connecting this node with the one passed in, if any
IsStartNode	Bool	Void	Returns true if this node is a starting node for its network
IsEndNode	Bool	Void	Returns true if this node is an ending node for its network
OwningFactionContext	CcoCampaignFaction	Void	Returns a CcoCampaignFaction with the faction that own the region where this node is, if any
SettlementContext	CcoCampaignSettlement	Void	Returns a CcoCampaignSettlement with the region where this node is
NodeSegmentLinkList	CcoCampaignRouteSegment (list)	Void	Returns a list with all the nodes segments connected to this one
ActiveContractList	CcoCaravanContractRecord (list)	Void	Returns a list of available resource contracts at this node
RoundsToRefresh	Int	Void	Returns an int with the rounds left until the contracts refresh for this node
Position	Vector4	Void	Returns the display position of the node
ResourceRewardForContractAndCargoContext	CcoCampaignResourceTransaction	CcoCampaignCharacter, CcoCaravanContractRecord, Int	Returns a CcoCampaignResourceTransaction with the resource that the passed in cargo and contract would generate in this node
IsActive	Bool	CcoCampaignCaravan	Returns true if the node can be clicked to change the path
ResourceRewardForCaravanContext	CcoCampaignResourceTransaction	CcoCampaignCaravan	Returns a CcoCampaignResourceTransaction with the resources that the caravan will generate when it reaches this node
IsVisible	Bool	Void	Returns true if the node is currently visible
IsSelected	Bool	CcoCampaignCaravan	Returns true if the node is on the path of the passed in caravan, or the selected start node

CcoCampaignRouteSegment

Wrapper for campaign route segment

Functions

Name	Return Type	Arguments	Description
MediumBanditryLevelThreshold	Int	Void	Returns an int with the minimum amount for banditry to be considered a medium threat
HighBanditryLevelThreshold	Int	Void	Returns an int with the minimum amount for banditry to be considered a high threat
BanditryLevel	Int	Void	Returns an int with the average amount of banditry in the regions contained in the segment
ShouldShowThreatIcon	Bool	Void	Returns true if the threat icon should be shown
EndNodeContext	CcoCampaignRouteNode	Void	Returns a CcoCampaignRouteNode with the ending node of the segment
SettlementList	CcoCampaignSettlement (list)	Void	Returns a list of CcoCampaignSettlements that are present along the segment
StartNodeContext	CcoCampaignRouteNode	Void	Returns a CcoCampaignRouteNode with the starting node of the segment

CcoCampaignSettlement

Wrapper for a campaign settlement.

Functions

Name	Return Type	Arguments	Description	Tags
BuildingSetList	CcoBuildingSetRecord (list)	Void	Returns a list with all the building sets in the settlement, sorted by their sort order
ChainList	CcoBuildingChainRecord (list)	Void	Returns an ordered list with all the buildable chains in this settlement.
GarrisonSize	Int	Void	Returns the size of the garrison in this settlement.
FactionFlagDir	String	Void	Returns the directory of the faction flags
NumWallBreaches	Int	Void	Returns an int with the number of times the wall has been breached.
VassalFactionContext	CcoCampaignFaction	String	Returns the context of the vassal faction that owns it.
DevTakeControl	Void	Void	Dev command that makes the local player take control of this settlement	debug, hide_in_uied
IsUpgradeable	Bool	Void	Returns true if the settlement can be upgraded.
ResetSettlementType	Void	String, Int	Command that resets a settlement to a different type.
IsPlayerOwned	Bool	Void	Returns true if the local player owns this settlement.
RegionRecordKey	String	Void	Returns the key of the region record.
PlayersFactionChainList	CcoBuildingChainRecord (list)	Void	Returns an ordered list with all the buildable chains in this settlement for the players faction, even if the player doesn't currently own the settlement (for previewing buildings that player can have in a settlement)
PlayerFactionForeignSlotIncome	Int	Void	Returns the income of the player faction foreign slots in this region
UnmarkForTypeConversion	Void	Void	Command that cancels the mark for type comversion command.
AllianceColour	Colour	Void	Returns the alliance colour which for most part is owning factions, but a special case for abandoned/disguised settlements
AlliedSlotsGroupList	CcoGroupList (list)	Void	Returns a list with all the allied foreign slots in the region, grouped based on the faction that owns each manager
IsUnderSiege	Bool	Void	Returns true if under siege.
SettlementKey	String	Void	Returns a string with the key of the settlement.
TowerLevel	Int	Void	Returns an int with the tower level in this settlement.
IsAbandoning	Bool	Void	Returns true if this settlement is in the process of being abandoned.
PlagueEffectBundleList	CcoEffectBundle (list)	Void	Returns a list of the plague effect bundles present in this settlement
PlagueInfectionContext	CcoCampaignPlagueInfection	Void	Returns a CcoPlagueInfection context if this settlement currently has a plague infection active
MarkForTypeConversion	Void	String, Int	Command that marks the settlement for type conversion, which means this will be converted next turn.
IsConvertingType	Bool	Void	Returns true if this settlement is converting type.
AlliedForeignSlotList	CcoCampaignBuildingSlot (list)	CcoCampaignFaction	Returns a list with all the allied slots in the region if any.
CQI	Int	Void	Returns the CQI of the region.
RegionRecordContext	CcoRegionRecord	Void	Returns a CcoRegionRecord context of the region record
HostileSlotsGroupList	CcoGroupList (list)	Void	Returns a list with all the hostile foreign slots in the region, grouped based on the faction that owns each manager
IsMouseOver	Bool	Void	Returns true if mousing over this settlement.
Income	Int	Void	Returns the tax income from the region.
FactionProvinceManagerContext	CcoCampaignFactionProvinceManager	Void	Returns the faction province manager of this settlement.
Position	Vector4	Void	Returns the position of the settlement on the map.
MarkForAbandon	Void	Void	Command that marks the settlement for abandon, which means this will be abandoned next turn.
PlagueImmunityTurns	Int	Void	Returns the number of turns the settlement is immune to plagues for, or 0 if none
ContainedCharacterList	CcoCampaignCharacter (list)	Void	Returns a list with all the characters garrisoned in the settlement.
IsSelected	Bool	Void	Returns true if this settlement is currently selected
ModelRegionContext	CcoCampaignModelRegion	Void	Returns the CcoCampaignModelRegion context for this settlement
WallsHealthPercent	Float	Void	Returns a float with the health percentage of the wall.
UnmarkForAbandon	Void	Void	Command that cancels the mark for abandon command.
PlagueResistance	Float	Void	Returns additive modifier to the chance of receiving plagues
IsOccupationImmune	Bool	Void	Returns whether the settlement is immune to occupation
IsAbandoned	Bool	Void	Returns true if this settlement is abandoned.
WarCoordinationTargetterList	ContextList	Void	Returns a list with all the objects targetting this settlement, if any.
FactionName	UniString	Void	Returns the name of the faction, taking rebel factions into account.
OriginalSubcultureContext	CcoSubcultureRecord	Void	Returns the context of the original subculture record
ZoomTo	Void	Vector4 (optional)	Command that zooms to this settlement. Can optionally provide an offset for the zoom.
BuildingSlotList	CcoCampaignBuildingSlot (list)	Void	Returns a list with the all the slots in the settlement.
CanConvertToSettlementType	Bool	String	Returns true if settlement can convert to the given settlement type
IsShrouded	Bool	Void	Returns true if it's covered by shroud.
AbandonTooltip	UniString	Void	Returns tooltip with resources/treasury returned when this settlement gets abandoned.
Select	Void	Void	Command that selects this settlement.
BesiegeingCharacterContext	CcoCampaignCharacter	Void	Returns the context of the character that is besiegeing this settlement.
IsImmuneToPlagues	Bool	Void	Returns whether the settlement is currently immune to plagues
SelectAndZoom	Void	Void	Selects and zooms to this settlement
PooledResourceList	CcoCampaignPooledResource (list)	Void	Returns a list with all pooled resources present in the region.
IsOnScreen	Bool	Void	Returns true if this settlement is currently on screen
StationedForceContext	CcoCampaignMilitaryForce	Void	Returns the military force context of the army stationed in this settlement, if any.
IsAssociatedWithVassal	Bool	String	Returns if a vassal is associated with the settlement
SettlementType	String	Void	Returns the type of the settlement, if it has one.
HasCharacterGarrisoned	Bool	Void	Returns true if a character is garrisoned in this settlement.
OccupationImmunityDuration	Int	Void	Returns the duration of the occupation immunity for this settlement
EffectBundleList	CcoEffectBundle (list)	Void	Returns a list with the effect bundles in the region, pre-filtered to only include those that should show in the UI
Rename	Void	Void	Command that renames the settlement.
PooledResourceContext	CcoCampaignPooledResource	String	Returns the context of the pooled resource with the key specified, if it exists.
BelongsToRegionGroup	Bool	String	Returns if this settlement belongs to region group with passed key
Name	UniString	Void	Returns the localized name for this settlement.
EffectBundleUnfilteredList	CcoEffectBundle (list)	Void	Returns a list with the effect bundles in the region, without any filtering (so includes those that dont show in the UI)	hide_in_uied
HasPlague	Bool	Void	Returns true if settlement has a plague
IsProvinceCapital	Bool	Void	Returns true if this settlement is the capital of its province.
MaxBuildingSlotCount	Int	Void	Returns the maximum amount of building slots that the settlement can have for the current faction occupying it
FactionFlagMedium	String	Void	Returns the medium faction flag of this settlement.
PrimarySlotContext	CcoCampaignBuildingSlot	Void	Returns the context of the primary building slot.
HasWalls	Bool	Void	Returns true if this settlement has any walls.
FactionFlagRotated	String	Void	Returns the rotated faction flag of this settlement.
CanRename	Bool	Void	Returns true if this settlement can be renamed
HostileBuildingSetList	CcoBuildingSetRecord (list)	CcoCampaignFaction	Returns a list of CcoBuildingSetRecord with all the building sets in the hostile slots owned by the passed in faction, sorted by their sort order
GarrisonForceContext	CcoCampaignMilitaryForce	Void	Returns the military force context of the garrison in this settlement.
CapitalIcon	String	Void	Returns the capital icon of this settlement.
HostileForeignSlotList	CcoCampaignBuildingSlot (list)	CcoCampaignFaction	Returns a list with the foreign slots in this settlement, for the passed in faction.
IsVisible	Bool	Void	Returns true if information about this settlement is visible to the player. (so if garrison and slot info is known to the player, not to do with being shrouded)
IsRebellionImminent	Bool	Void	Returns true if there will be a rebellion next turn.
SettlementTreasuryValue	Int	Void	Returns the treasury value of this settlement based on building levels
IndexIntoProvince	Int	Void	Returns the index of this settlement in the province's settlement list.
FactionContext	CcoCampaignFaction	Void	Returns the context of the faction that owns it.
DevSpawnRebellion	Void	Void	Dev command that forces a rebellion to spawn in settlement	debug, hide_in_uied
BreakForDebugging	Void	Void	Command that triggers a breakpoint, useful for debugging.	debug, hide_in_uied
ResourceList	CcoResourceRecord (list)	Void	Returns a list with the resources present in this region.
FactionFlagLarge	String	Void	Returns the large faction flag of this settlement.
ProvinceContext	CcoCampaignProvince	Void	Returns the context of the province that this settlement is part of.
TurnsUntilSiegeSurrender	Int	Void	Returns an int with how many turns the siege will last, Returns -1 if the settlement is not under siege.
FactionFlagSmall	String	Void	Returns the small faction flag of this settlement.
IsFactionCapital	Bool	Void	Returns true if it's the capital of the faction that owns it.

CcoCampaignSkavenCorruptionOverlay

Record wrapper for a Skaven corruption overlay

Functions

Name	Return Type	Arguments	Description
MenaceCharges	Int	Void	Returns the menace charges provided by Skaven corruption
PublicOrderFactorName	UniString	Void	Returns the name of the public order skaven corruption factor
PublicOrderChange	Int	Void	Returns the public order contribution by Skaven corruption

CcoCampaignSlaves

Functions

Name	Return Type	Arguments	Description
FactionProvinceManagerContext	CcoCampaignFactionProvinceManager	Void	Returns the context of the faction province manager that owns the slaves.
PercentageReducedPerTurn	Float	Void	Returns a float with the percent of slaves that will be lost next turn
SlavesNumber	Int	Void	Returns an int with the current number of slaves in the province.
SlavesCapPercentage	Float	Void	Returns the percentage of used the slave cap
IsSlaveEffectTypeActive	Bool	String	Returns if the passed in effect(public_order, growth, income_modifier) is active or not.
PercentageDiscardedOnTransfer	Float	Int	Returns a float with the percent of slaves that will be discarded in a transfer, from the amount passed as a parameter
SlaveDistributionControl	String	Void	Returns a string with the slave distribution control type.
ToggleSlavesEffectType	Void	String	Command that toggles the passed in effect type.(public_order, growth, income_modifier)
TransferSlavesToProvince	Void	CcoCampaignProvince	Command that transfers slaves to the passed province (Takes CcoCampaignProvince as arg)
ChangeSlaveDistributionControl	Void	String	Command that changes the distribution control to the specified distribution type(none/normal/high)
CanReceiveTransfer	Bool	Void	Returns a bool specifying whether the province can receive a slave transfer.
GrowthContribution	Int	Void	Returns an int with the growth contribution that the slaves provide.
SlaveSpaceAvailable	Int	Void	Returns an int with the amount of space still available in the province (max - current)
PublicOrderContribution	Int	Void	Returns an int with the public order contribution that the slaves provide.
MaximumSlaves	Int	Void	Returns an int the maximum number of slaves that the province can have.
IncomeIncreaseModifier	Float	Void	Returns a float with the income increase modifier that the slaves provide.

CcoCampaignTechnology

Component context wrapper for a campaign technology

Functions

Name	Return Type	Arguments	Description	Tags
UiTabContext	CcoTechnologyUiTabRecord	Void	returns the context of the ui tab if any
NodeSetName	UniString	Void	Returns the unlocalised name of the technology node set this technology belongs to
ScriptLockedReason	UniString	Void	Returns script locked reasons for tech with challenge numbers formatted in, if any
ResearchPointsCost	Int	Void	Returns required research points minus completed research points for this tech
AffectedInitiativeList	CcoInitiativeRecord (list)	Bool (optional)	Returns list of initiatives affected by unlocking this tech, can pass to EffectsGrantedToInitiative to get specific effects
CanAfford	Bool	Void	Returns true if can afford the Cost of researching this tech
Position	Vector4	Void	Returns a VECTOR_4 that can be used with things like ContextRadarIcon for positioning free form using tier and indent from db
CanResearch	Bool	Void	Returns true if available and can currently research meeting any additional requirements like cost, etc
DisablingTechContext	CcoCampaignTechnology	Void	Returns the CcoCampaignTechnology that disabled us when it was researched (some techs mutually exclusive)
UnresearchedParentRecords	CcoTechnologyRecord (list)	Void	Returns the records of the unresearched parents of this technology
BreakForDebugging	Void	Void	Breaks into attached IDE for debugging and getting full information from internal objects	debug, hide_in_uied
TrainingGroupContext	CcoCampaignCharacterTrainingGroup	Void	If one of the effects unlocks a training slot, returns the group of that
Cost	Int	Void	Returns financial cost to research this tech
MatchesQuery	Bool	UniString	Returns true if this technology matches given query text
IsAtLeastResearching	Bool	Void	Returns true if researching or researched
RequiredTechnologiesList	CcoTechnologyRecord (list)	Void	Returns the list of CcoCampaignTechnology required before player can research this tech
IsAtLeastAvailable	Bool	Void	Returns true if available, researching or researched
RecordContext	CcoTechnologyRecord	Void	Returns the CcoTechnologyRecord context
ResearchedParents	Int	Void	Returns the number of parents that have already been researched
HasBuildingRequirement	Bool	Void	Returns true if this tech has building requirements before can start researtching
IsAvailable	Bool	Void	Returns true if available to be researched
RequiredParentsNumber	Int	Void	Returns required number of parents to unlock this technology
IsQueued	Bool	Void	Returns true if this technology is part of the research map
RequiredBuildingList	CcoBuildingLevelRecord (list)	Void	Returns the list of CcoBuildingLevelRecord required to be built by player before can research this tech
IsResearched	Bool	Void	Returns true if already been researched
CharacterTraitList	CcoCharacterTraitLevelRecord (list)	Void	Returns the list of CcoCharacterTraitLevelRecord provided by this tech
FactionContext	CcoCampaignFaction	Void	Returns the context of the faction that this technology belongs to
StartResearching	Void	Void	Starts researching this tech
NodeKey	String	Void	Returns the key of technology node record
IsResearching	Bool	Void	Returns true if currently researching
Colour	Colour	Void	Colour defined by tech node set
BuildingList	CcoBuildingLevelRecord (list)	Void	Returns the list of CcoBuildingLevelRecord provided by this tech
ResourceTransactionContext	CcoCampaignResourceTransaction	Void	Returns the context of the required resource transaction
CurrentState	String	Void	Current state as a string (available/researched, etc
AncillaryList	CcoAncillaryRecord (list)	Void	Returns the list of CcoCampaignAncillary provided by this tech
UiGroupContext	CcoTechnologyUiGroupRecord	Void	Returns the context of the ui group that this technology is part of, if it exists
LongDescription	UniString	Void	Localised long description
DevEnableTech	Void	Bool (optional)	Instantly enables tech for dev purposes. Can pass in true if want to report in event feed the new tech researched, otherwise will suppress this by default so as not to take out of tech panel to see event (better for testing tech tree)	debug, hide_in_uied
EffectUnfilteredList	CcoEffect (list)	Void	Returns the list of CcoEffect that this tech enables when researched, includes those not shown in ui	hide_in_uied
UnitList	CcoMainUnitRecord (list)	Void	Returns the list of CcoMainUnitRecord provided by this tech
DevDisableTech	Void	Void	Instantly disables tech for dev purposes	debug, hide_in_uied
IconPath	String	Void	Full icon filepath for tech icons
Duration	Int	Void	Returns the number of turns it takes to finish researching this tech
Name	UniString	Void	Localised name
EffectsGrantedToInitiative	CcoEffect (list)	CcoInitiativeRecord	Returns list of effects (flagged as visible in UI) that this tech grants to given initiative
Tier	Int	Void	Returns tier value from db (y position)
Indent	Int	Void	Returns the indent value from db (x position)
ShortDescription	UniString	Void	Localised short description
EffectList	CcoEffect (list)	Void	Returns the list of CcoEffect that this tech enables when researched, prefiltered to not show those that shouldnt appear in ui
OverrideSoundCategory	String	Void	Returns the override sound category for this technology if it exists

CcoCampaignTechnologyManager

Wrapper for a faction's technology manager

Functions

Name	Return Type	Arguments	Description
IsResearchingTech	Bool	Void	Return if this manager is currently researching a technology or not
GoalTechnologyContext	CcoCampaignTechnology	Void	Return a context to the goal research technology if valid
ResearchPoints	Int	Void	Return research points for this manager
CurrentResearchingTechnologyContext	CcoCampaignTechnology	Void	Return a context to the current technology this manager is researching, if valid
ResearchedTechnologyList	CcoCampaignTechnology (list)	Void	Return a list of researched technology from this manager
EffectsGranted	CcoEffect (list)	Void	Return a list of effects granted by technology in this manager
TechnologyList	CcoCampaignTechnology (list)	Void	Return a list of technology available to this manager

CcoCampaignTreasuryTransaction

Context wrapper for treasury transactions.

Functions

Name	Return Type	Arguments	Description	Tags	Events
LocalisedTextKey	String	Void	Returns the localised text key for what text to use (NOT sure why done this way instead of returning text, see Mikaela)
Value	Int	Void	Returns the value

CcoCampaignUnit

Component context wrapper for a campaign unit

Functions

Name	Return Type	Arguments	Description	Tags
MilitaryForceContext	CcoCampaignMilitaryForce	Void	Returns the owning CcoCampaignMilitaryForce
DevLevelUp	Void	Int	Levels up or down a unit by given number of levels	debug, hide_in_uied
Cost	Int	Void	Returns the recruitment cost of this unit (one off payment when first recruit)
PurchasableEffectsCostList	CcoCampaignUnitPurchasableEffectCost (list)	Void	Returns a list of CcoCampaignUnitPurchasableEffectCost that this unit can use
UpkeepCost	Int	Void	Returns the upkeep cost of this unit (how much pay each turn)
CharacterContext	CcoCampaignCharacter	Void	Returns the CcoCampaignCharacter if any (for agents/generals)
PurchasableEffectCostContext	CcoCampaignUnitPurchasableEffectCost	CcoUnitPurchasableEffectRecord	Returns the CcoCampaignUnitPurchasableEffectCost for a supplied CcoUnitPurchasableEffectRecord
UpgradeUnit	Void	CcoMainUnitRecord	Upgrades the unit to the supplied CcoMainUnitRecord
UpgradeUnavailableText	UniString	CcoUnitPurchasableEffectRecord	Returns the reason why the unit cannot upgrade using the supplied CcoUnitPurchasableEffectRecord
NumEntities	Int	Void	Returns the current number of entities
UnitRecordContext	CcoMainUnitRecord	Void	Returns the CcoMainUnitRecord
PurchasableEffectsList	CcoUnitPurchasableEffectRecord (list)	Void	Returns a list of CcoUnitPurchasableEffectRecord that this unit can use
DevHeal	Void	Void	Fully heals the unit, useful for dev purposes	debug, hide_in_uied
NumEntitiesInitial	Int	Void	Returns the max number of entities this unit can have
UnitDetailsContext	CcoUnitDetails	ExpressionState	Returns the CcoUnitDetails for this unit (used on unit info panel which shows unit info from various sources)
IsNumMenKnown	Bool	Void	Returns true if player knows enough about army to know how many men they have left (might not be close enough to army, etc)
PurchasableEffectsIncrementalScrapCost	Int	Void	Returns the incremental cost per each subsequent scrap upgrade for this unit. It can be 0.
IsExperienceKnown	Bool	Void	Returns true if player knows enough about army to know how experience (might not be close enough to army, etc)
UnitDetailsIfEffectPurchased	CcoUnitDetails	CcoUnitPurchasableEffectRecord	Returns a CcoUnitDetails object describing the unit with a given purchasable effect applied.
HealthMax	Int	Void	Returns the max raw health value this unit can have
AbilityList	ContextList	Void	Returns the list of CcoUnitAbility that this unit can use in battle
GetPurchasableEffectLockedStatus	Int	CcoUnitPurchasableEffectRecord	Determines whether the provided CcoUnitPurchasableEffectRecord is locked behind an unresearched technology.
IsUnknown	Bool	Void	Returns true if player doesn't know details about this unit due to spying level (might not be close enough to army, etc)
HealthPercentNextTurn	Float	Void	Returns the health percent that will be next turn (0-1)
GetPurchasableEffectLockingTechnologyRecord	CcoTechnologyRecord	CcoUnitPurchasableEffectRecord	Returns the CcoTechnologyRecord that locks the provided CcoUnitPurchasableEffectRecord.
AttritionPercent	Float	Void	Returns how much attrition will take in the next turn (how much health will lose) (0-1)
ExperiencePercent	Float	Void	Returns the current experience progression to next level as a percent (0-1)
Disband	Void	Void	Removes the unit from the army, essentially deleting the unit
HasPurchasedEffect	Bool	CcoUnitPurchasableEffectRecord	Returns true if unit have purchased the supplied CcoUnitPurchasableEffectRecord
Upgrade	Void	CcoUnitPurchasableEffectRecord	Upgrades the unit with the supplied CcoUnitPurchasableEffectRecord
HealthReplenishPercent	Float	Void	Returns the amount of health that will be replenished on the next turn as a percentage (0-1)
CanUpgrade	Bool	CcoUnitPurchasableEffectRecord	Returns true if this unit can upgrade using the supplied CcoUnitPurchasableEffectRecord
WillSufferAttrition	Bool	Void	Returns true if this unit will suffer attrition on the next turn (take damage)
HasPurchasedAllAvailableEffects	Bool	Void	Returns true if unit has purchased all available purchasable effects.
IconPath	String	Void	Returns the icon filepath used for things like unit card images
HealthPercent	Float	Void	Returns the current health as a percentage (0-1)
Rename	Void	Void	Brings up a prompt to rename the unit to give it a custom name
HaveAccessToPurchasableEffect	Bool	CcoUnitPurchasableEffectRecord	Returns true if unit have access to the supplied CcoUnitPurchasableEffectRecord
HealthValue	Int	Void	Returns the raw health value (hitpoints)
ActorVO	Int	Void	Returns the actor voice-over id
Name	UniString	Void	Returns the localised name
PurchasedEffectsList	CcoUnitPurchasableEffectRecord (list)	Void	Returns a list of CcoUnitPurchasableEffectRecord that this unit have purchased
IsCharacter	Bool	Void	Returns true if this unit is for a character (general or agent)
CanPurchaseAvailableEffects	Bool	Void	Returns true if the unit has effects available for purchase. If it has no purchasable effects available, or has purchasable effects available that cannot currently be purchased it returns false.
UniqueUiId	String	Void	Returns unique string identifier for this unit
ExperienceLevel	Int	Void	Returns the current experience level of the unit (0-9)
AlliedOriginFactionContext	CcoCampaignFaction	Void	Returns the allied origin faction of this unit (if this unit has been recruited through allied recruitment)
PurchasableEffectsTotalPurchaseCost	CcoCampaignResourceTransaction	ContextList	Returns a CcoCampaignResourceTransaction for the total purchase cost of a supplied list of CcoUnitPurchasableEffectRecord as a whole, including the cost increases caused by earlier upgrades to the later ones.
TurnsUntilReplenished	Int	Void	Returns how many turns it will take for this unit to be back to full strength
FactionContext	CcoCampaignFaction	Void	Returns the faction of this unit
AllianceColour	Colour	Void	Returns the alliance colour of this unit (usually same as factions colour, but if we have an origin faction it will use that colour)
PurchasableEffectIncreasedPurchaseCost	CcoCampaignResourceTransaction	CcoUnitPurchasableEffectRecord, Int	Returns a CcoCampaignResourceTransaction for the purchase cost of a supplied CcoUnitPurchasableEffectRecord, including any cost increase from all previously purchased upgrades and a given number of ones selected to be purchased.

CcoCampaignUnitGroupUpgrade

Component context wrapper for a UNIT_GROUP_UPGRADE

Functions

Name	Return Type	Arguments	Description
RankRequirementMet	Bool	Void	Returns if the requirement of the unit rank is met
UnitRankAfterUpgrade	Int	CcoCampaignUnit	Returns the provided units rank after upgrade have been applied
BuildingRequirementsList	CcoCampaignUnitUpgradesBuildingRequirement (list)	Void	Returns a list of CcoCampaignUnitUpgradesBuildingRequirement for the unit group
RankRequired	Int	Void	Returns rank required on the unit for the upgrade
Category	String	Void	Returns the category that the unit group upgrade belong to for filtering purposes
TechRequirementsList	CcoCampaignUnitUpgradesTechRequirement (list)	Void	Returns a list of CcoCampaignUnitUpgradesRequirement for the unit group
ResourceTransactionContext	CcoCampaignResourceTransaction	CcoCampaignUnit	Returns the CcoCampaignResourceTransaction belonging to the unit upgrade
CanUpgrade	Bool	Void	Returns true if unit can apply this upgrade
UnitsList	CcoMainUnitRecord (list)	Void	Returns a list of CcoMainUnitRecords that belongs to this unit group

CcoCampaignUnitPurchasableEffectCost

Context wrapper for pairing purchasable effect record and resource transaction.

Functions

Name	Return Type	Arguments	Description	Tags	Events
EffectRecord	CcoUnitPurchasableEffectRecord	Void	Returns purchasable effect record cco
ResourceTransaction	CcoCampaignResourceTransaction	Void	Returns resource transaction cco

CcoCampaignUnitUpgradeManager

Component context wrapper for a UNIT_UPGRADE_MANAGER

Functions

Name	Return Type	Arguments	Description
FirstValidUpgradeCategoryForUnit	String	CcoCampaignUnit, String (optional)	Returns the first valid unit upgrade category that the given unit have access to
UnitHasUpgrades	Bool	CcoCampaignUnit	Returns if unit has any unit group upgrades
ForceUnitGroupUpgradesList	CcoCampaignUnitGroupUpgrade (list)	CcoCampaignMilitaryForce, CcoCampaignUnit (optional)	Returns a list of CcoCampaignUnitGroupUpgrades for a given CcoCampaignMilitaryForce
UnitGroupUpgradesTree	TreeData	ContextList	Returns a list of CcoCampaignUnitGroupUpgrades for a list of CcoCampaignUnitGroupUpgrades
UnitsUpgradeGroupList	CcoCampaignUnitGroupUpgrade (list)	CcoCampaignUnit	Returns a list of CcoCampaignUnitGroupUpgrades for the given CcoCampaignUnit
UnitUpgradeMainUnitRecordList	CcoMainUnitRecord (list)	CcoCampaignUnit	Returns a list of CcoMainUnitRecord which the unit can upgrade to for a given CcoCampaignUnit
FirstAvailableUnitUpgradeGroupContext	CcoCampaignUnitGroupUpgrade	CcoCampaignUnit	Returns the first valid upgrade group for the given CcoCampaignUnit

CcoCampaignUnitUpgradesBuildingRequirement

Component context wrapper for a UNIT_GROUP_TECH_REQUIREMENT

Functions

Name	Return Type	Arguments	Description	Tags	Events
BuildingRequiredRecordContext	CcoBuildingLevelRecord	Void	Returns the CcoBuildingLevelRecord required to unlock the unit group
IsRequirementMet	Bool	Void	Returns true if unit have met the requirement

CcoCampaignUnitUpgradesTechRequirement

Component context wrapper for a UNIT_GROUP_TECH_REQUIREMENT

Functions

Name	Return Type	Arguments	Description
TechRequiredRecordContext	CcoTechnologyRecord	Void	Returns the CcoTechnologyRecord required to unlock the unit group
IsRequirementMet	Bool	Void	Returns true if unit have met the requirement
RequirementText	UniString	Void	Returns the requirement display text

CcoCampaignWarContract

Wrapper for a campaign war contract

Functions

Name	Return Type	Arguments	Description
ContractDuration	Int	Void	Returns the duration of the contract
RemainingDuration	Int	Void	Returns the remaining duration of the contract. If it's not an active contract this is equal to the contract duration
CustomDescription	UniString	Void	Returns the localised description text for this contract if it has one
TargetFactionsList	CcoCampaignFaction (list)	Void	Returns the list of targets for the contract
IsActive	Bool	Void	Returns if this is contract is currently active or not
RewardPayloadInfoContext	CcoCampaignPayloadInfo	Void	Returns the reward payload info context for the contract
HiredFaction	CcoCampaignFaction	Void	Returns the hired faction for the contract
ClientFaction	CcoCampaignFaction	Void	Returns the client faction for the contract
HasFactionExceededTargetPointsForActiveContract	Bool	Void	Returns true if the faction has more that the target contract points for their active contract
CompleteContract	Void	Void	Completes the current active contract
ContractPointsResourceContext	CcoCampaignPooledResource	Void	Returns CcoCampaignPooledResource that the hired faction for this contract uses for contract points
ActivateContract	Void	Void	Tries to activate this contract if available
BreakContract	Void	Void	Tries to break this contract if active
TargetPoints	Int	Void	Returns the required contract points to complete the contract
CurrentPoints	Int	Void	Returns the current contract points accumulated for the contract

CcoCampaignWarCoordinationRequest

Component context wrapper for a war coordination request from the AI with details of the mission

Functions

Name	Return Type	Arguments	Description
CanCurrentlyRequest	Bool	Void	Returns if can currently perform this request (if can afford, etc)
TargetType	String	Void	Returns the type of target used for state names (attack_army/defend_army/attack_settlement/defend_settlement)
FavourPointsReward	Int	Void	Returns the favour points reward for completing the request
TurnsRemaining	Int	Void	Returns the turns remaining until this request becomes invalid
TargetFactionContext	CcoCampaignFaction	Void	Returns the target faction who we are requesting to attack/defend (the settlement or forces owning faction)
TargetContext	Context	Void	Returns the context of the target to defend/attack, either a CcoCampaignMilitaryForce or CcoCampaignSettlement
IssuingFactionContext	CcoCampaignFaction	Void	Returns the faction issuing this request
RecipientFactionContext	CcoCampaignFaction	Void	Returns the faction receiving this request
FactionInteractionContext	CcoCampaignFactionInteraction	Void	Returns the CcoCampaignFactionInteraction this request belongs to
IsPending	Bool	Void	Returns true if this request is still pending and hasnt been accepted yet, if not pending then it is an accepted request currently active
AcceptRequest	Void	Void	Accepts the request for pending target

CcoCampaignWinStreak

Functions

Name	Return Type	Arguments
TurnsUntilDecay	Void	Void
CurrentStreakEffectContext	Void	Void
EffectUnfilteredList	Void	Void
WinStreakPercent	Void	Void
InvalidationRound	Void	Void
EffectList	Void	Void
CampaignStreakContext	Void	Void
CurrentWinStreak	Void	Void

CcoCampaignWindsOfMagicArea

Wrapper for a winds of magic area.

Functions

Name	Return Type	Arguments	Description
DoesFactionHaveAreaOwnership	Bool	CcoCampaignFaction	Returns true if the passed in faction has ownership of this area
ManipulateWindsOfMagicTooltip	UniString	ExpressionState, Bool	Returns a tooltip with the reason winds of magic can't be activated, or with the cost if it can. If passed true, will return tooltip for increasing strength, otherwise for decreasing.
WindsOfMagicManipulationCost	CcoCampaignResourceTransaction	Bool	Returns the cost of performing a wind manipulation in this area. If passed true, will return cost for increasing strength, otherwise for decreasing
CanManipulateWindsOfMagic	Bool	Bool	Returns true if the wind can be changed. If passed true, will return if the wind strength can be increased, otherwise if it can be decreased.
ChangeAreaStrength	Void	Bool	Changes the current area strength. If the bool passed in is true, then it increases the strength, else it decreases it.
TransitionRound	Int	Void	Returns an int with the round number when the duration of the current strength finishes.
RoundsUntilTransition	Int	Void	Returns the number of rounds until the next transition.
CurrentStrengthContext	CcoCampaignMapWindsOfMagicStrengthRecord	Void	Returns the context of the current wind strength record in the area.
RecordContext	CcoCampaignMapWindsOfMagicAreaRecord	Void	Returns the context of the winds of magic area record.
RegionList	CcoRegionRecord (list)	Void	Returns a list with all the regions in the area.

CcoCampaignWindsOfMagicSystem

Functions

Name	Return Type	Arguments
AreaContextForRegion	CcoCampaignWindsOfMagicArea	CcoRegionRecord
ChangeAreaStrength	Void	CcoCampaignWindsOfMagicArea, CcoCampaignMapWindsOfMagicStrengthRecord
AreaContextForProvince	CcoCampaignWindsOfMagicArea	CcoCampaignProvince
AllAreaContexts	ContextList	Void

CcoCampaignWomCompassDirection

Wrapper for wom compass direction

Functions

Name	Return Type	Arguments	Description
CanFactionSetDirection	Bool	CcoCampaignFaction	Returns true if the passed in faction can set this compass direction
HasAccessToAction	Bool	String	Returns true if this direction has access to the passed in action
SelectionEffectList	CcoEffect (list)	Void	Returns a list with the effects that this direction gets while it's selected
MinPowerLevel	Int	Void	Returns an int with the minimum power level this direction can have
TurnsUntilUnlockScriptKey	String	Void	Returns the script key for the turns until unlocked script object
Key	String	Void	Returns the key of the direction record
FactorList	CcoStringValue (list)	Void	Returns a list of factors that have affected the power level of this direction
PowerLevelEffectList	CcoEffect (list)	Void	Returns a list with the current effects of this direction based on the power level
ActionTooltip	UniString	String	Returns the tooltip for the action of the type specified
PowerLevelRangeList	CcoCampaignWomCompassPowerLevelRange (list)	Void	Returns a list of power level ranges grouped based on effects
CanActivateAction	Bool	String	Returns true if the action with the type specified can be activated
IsCurrentDirection	Bool	Void	Returns true if this direction is the currently selected one
TurnsUntilUnlock	Int	Void	Returns the number of turns until this direction will be unlocked
Title	UniString	Void	Returns the localised title of the direction
Description	UniString	Void	Returns the localised description of the direction
DisplayOrder	Int	Void	Returns an int with the sort order of the direction
IsInitiallyLocked	Bool	Void	Returns true if this direction was initially locked
MaxPowerLevel	Int	Void	Returns an int with the maximum power level this direction can have
CurrentPowerLevel	Int	Void	Returns an int with the current power level that this direction has

CcoCampaignWomCompassPowerLevelRange

Wrapper for a direction power level to make it easier to have a list of them with their own effect list

Functions

Name	Return Type	Arguments	Description
MinLevel	Int	Void	Returns the minimum level of this range
MaxLevel	Int	Void	Returns the maximum level of this range
EffectList	CcoEffect (list)	Void	Returns a list of effects for this level
SegmentPercentage	Float	Void	Returns the percentage that this segment has based on the range's min and max
DirectionContext	CcoCampaignWomCompassDirection	Void	Returns the compass direction context

CcoCookingDish

Wrapper for a COOKING_DISH struct

Functions

Name	Return Type	Arguments	Description
AlliedUnitEffectsList	CcoEffect (list)	Void	Returns a list of CcoEffect with the allied unit effects provided by this dish
FactionEffectList	CcoEffect (list)	Void	Returns a list of CcoEffect with the faction effects provided by this dish
EnemyUnitEffectsList	CcoEffect (list)	Void	Returns a list of CcoEffect with the enemy unit effects provided by this dish
IngredientList	CcoCookingIngredientRecord (list)	Void	Returns a list of CcoCookingIngredientRecord with the ingredients of this dish
FactionLeaderEffectList	CcoEffect (list)	Void	Returns a list of CcoEffect with the faction leader effects provided by this dish
RoundsLeft	Int	Void	Returns the number of rounds left on the active dish effect
CookingDishRecordContext	CcoCookingRecipeRecord	Void	Returns a CcoCookingRecipeRecord with the recipe record of this dish

CcoCookingSystem

Wrapper for the cooking system for a given faction

Functions

Name	Return Type	Arguments	Description	Tags
GetPossibleRecipeRecords	CcoCookingRecipeRecord (list)	Void	Returns a list of CcoCookingRecipeRecord with all recipes
UnlockAllRecipes	Void	Void	Dev command to unlock all recipes	debug, hide_in_uied
GetUnlockedIngredientRecords	CcoCookingIngredientRecord (list)	Void	Returns a list of CcoCookingIngredientRecord with all the unlocked ingredients
SecondaryIngredientsForRecipe	CcoCookingIngredientRecord (list)	CcoCookingRecipeRecord, Bool	Returns a list of CcoCookingIngredientRecord with secondary ingredients needed for the CcoCookingRecipeRecord passed in
DevUnlockIngredient	Void	CcoCookingIngredientRecord	Dev command to unlock the passed in ingredient	debug, hide_in_uied
GetUnlockedRecipeRecords	CcoCookingRecipeRecord (list)	Void	Returns a list of CcoCookingRecipeRecord with all the unlocked recipes
RecipeForIngredients	CcoCookingRecipeRecord	ContextList, ContextList	Returns a CcoCookingRecipeRecord that would result from the primary and secondary CONTEXT_LIST ingredients passed in
HasValidIngredientsForRecipe	Bool	CcoCookingRecipeRecord	Returns true if the passed in recipe has all the ingredients unlocked and not on cooldown
UnlockAllIngredients	Void	Void	Dev command to unlock all ingredients	debug, hide_in_uied
PrimaryIngredientsForRecipe	CcoCookingIngredientRecord (list)	CcoCookingRecipeRecord, Bool	Returns a list of CcoCookingIngredientRecord with primary ingredients needed for the CcoCookingRecipeRecord passed in
DishesAppliedToUnitList	CcoCookingDish (list)	CcoCampaignUnit	Returns a list of CcoCookingDish with the dishes applied to the passed in unit
RevertDishAppliedToUnit	Void	CcoCampaignUnit, CcoCookingDish	Reverts the passed in cooking dish on the passed in unit
DishesAppliedToAllUnitsList	CcoCookingDish (list)	Void	Returns a list of CcoCookingDish with the dishes applied to all units
PossibleIngredientCategories	CcoCookingIngredientGroupRecord (list)	Void	Returns a list of CcoCookingIngredientGroupRecord with all ingredient categories
StoredAmountForDish	Int	CcoCookingDish	Returns an int with the number of dishes stored of the dish passed in
StoredCookingDishList	CcoCookingDish (list)	Void	Returns a list of CcoCookingDish with all stored cooking dishes
IngredientCooldown	Int	CcoCookingIngredientRecord	Returns an int with the cooldown of the passed in ingredient (returns 0 if not on cooldown)
CanCookIngredients	Bool	ContextList, ContextList	Returns true if the passed in ingredients can be cooked into a valid dish
PossibleIngredientsForCategory	CcoCookingIngredientRecord (list)	CcoCookingIngredientGroupRecord	Returns a list of CcoCookingIngredientRecord for the CcoCookingIngredientGroupRecord passed in
StoredAmountForRecipe	Int	CcoCookingRecipeRecord	Returns an int with the number of dishes stored for the passed in recipe
MaximumNumberOfSecondaryIngredients	Int	Void	Returns an int with the maximum number of allowed secondary ingredients
IngredientIsUnlocked	Bool	CcoCookingIngredientRecord	Returns true if the passed in CcoCookingIngredientRecord is unlocked
IngredientSlotIsUnlocked	Bool	Int, Bool	Returns true if the slot with the passed in number is unlocked. Needs to also pass true for whether should check primary slots, or false for secondary slots
AnyIngredientOfCategoryIsUnlocked	Bool	CcoCookingIngredientGroupRecord	Returns true if any ingredient from the passed in CcoCookingIngredientGroupRecord is unlocked
CurrentActiveDishContext	CcoCookingDish	Void	Returns a CcoCookingDish with the current dish context
RecipeIsUnlocked	Bool	CcoCookingRecipeRecord	Returns true if the passed in CcoCookingRecipeRecord is unlocked
MaximumNumberOfPrimaryIngredients	Int	Void	Returns an int with the maximum number of allowed primary ingredients
AllIngredientsUnlockedForRecipe	Bool	CcoCookingRecipeRecord	Returns a list of CcoCookingIngredientRecord for the CcoCookingRecipeRecord passed in
CookIngredients	Void	ContextList, ContextList, Bool	Calls a CCQ command to cook the primary and secondary CONTEXT_LIST ingredients passed in
GetPossibleIngredientRecords	CcoCookingIngredientRecord (list)	Void	Returns a list of CcoCookingIngredientRecord with all ingredients
IsDishActive	Bool	Void	Returns true if a dish is currently active

CcoDiplomacyThreatLevel

Wrapper for FACTION_STRATEGIC_THREAT_LEVEL_RECORD and flag stating whether for the player or not

Functions

Name	Return Type	Arguments	Description
Description	UniString	Void	Localised description for threat level based on if for player or AI
Title	UniString	Void	Localised title for threat level based on if for player or AI
FactionContext	CcoCampaignFaction	Void	Record CcoCampaignFaction for faction this threat is for
RecordKey	String	Void	Record key for FACTION_STRATEGIC_THREAT_LEVEL_RECORD wrapping

CcoEpisodicOverride

Functions

Name	Return Type	Arguments	Description	Tags	Events
IsOverriden	Void	Void

CcoFloatingTextAgentActionEvent

Functions

Name	Return Type	Arguments
TargetFlagPath	Void	Void
TextType	Void	Void
IsSuccess	Void	Void
AgentFlagPath	Void	Void
ActionName	Void	Void
TargetName	Void	Void
AgentName	Void	Void

CcoFloatingTextBattleEvent

Functions

Name	Return Type	Arguments
AttackerFlagPath	Void	Void
DefenderFlagPath	Void	Void
Attacker	Void	Void
Defender	Void	Void
TextType	Void	Void

CcoFloatingTextStanceEvent

Functions

Name	Return Type	Arguments
GeneralName	Void	Void
NewStanceName	Void	Void
GeneralFlagPath	Void	Void
TextType	Void	Void
OldStanceName	Void	Void

CcoJadeMissionElement

Wrapper for a quest chain mission

Functions

Name	Return Type	Arguments	Description
MarkAsSeen	Void	Void	Mark the mission notification as seen
HasMissionBeenIssued	Bool	Void	Return if the mission is available in the current campaign
HasSeen	Bool	Void	Return true if the mission notification has been seen
ImagePath	String	Void	Returns a string with the image path for the mission
IsMissionAvailableInCurrentCampaign	Bool	Void	Return if the mission is available in the current campaign
MissionContext	CcoCampaignMission	Void	Return the CcoCampaignMission
SortOrder	Int	Void	Return the sort order for the mission in the quest chain
MissionRecordContext	CcoMissionRecord	Void	Return the CcoMissionRecord

CcoMalakaiOathsQuestChain

Wrapper for a battles of legend quest chain

Functions

Name	Return Type	Arguments	Description
HighlightedUnitList	CcoMainUnitRecord (list)	Void	Return a list of CcoMainUnitRecord
HighlightedEffectBundleList	CcoEffectBundle (list)	Void	Return a list of CcoEffectBundle
BulletPointText	UniString	Void	Returns the localised bullet point text of the chain
OathsMissionList	CcoJadeMissionElement (list)	Void	Return a list of CcoMalakaiOathsMission
IsUnlocked	Bool	Void	Returns whether this quest chain is unlocked
IsPinned	Bool	Void	Returns whether this quest chain is pinned
Description	UniString	Void	Returns the localised description of the chain
ActivatingRitualContext	CcoRitualRecord	Void	Return a CcoRitualRecord with the ritual required to activate this quest
SwitchingRitualContext	CcoRitualRecord	Void	Return a CcoRitualRecord with the ritual required to switch to this quest
NumMissionsRequired	Int	Void	Return the number of required missions to unlock the final quest
CompletedQuestsRequiredToUnlock	Int	Void	Return the number of other quest chains that need to be completed for this quest to be unlocked
IconPath	String	Void	Return the icon path of the quest chain
SortOrder	Int	Void	Return the sort order of the quest chain
AncillaryRecordContext	CcoAncillaryRecord	Void	Return associated CcoAncillaryRecord
QuestChainName	String	Void	Return the name of the quest chain
MainUnitRecordContext	CcoMainUnitRecord	Void	Return a CcoMainUnitRecord associated with the battles of legend quest chain
EffectBundle	CcoEffectBundle	Void	Return associated CcoEffectBundle

CcoPooledResourceTransfer

Component context manager for pooled resource transfer

Functions

Name	Return Type	Arguments	Description
CanBeSource	Bool	CcoCampaignMilitaryForce	Returns true if the provided force can transfer the pooled resource to another.
IsSelectedSource	Bool	CcoCampaignMilitaryForce	Returns true if the force is the currently selected source
ValidSinks	CcoCampaignMilitaryForce (list)	CcoCampaignMilitaryForce (optional)	Returns the list of military forces that can receive meat from the selected source or from the provided source override.
ValidSources	CcoCampaignMilitaryForce (list)	Void	Returns the list of military forces that can transfer meat.
Clear	Void	Void	Clears source selection and sets selected value to 0. Normally used on panel close.
SetSelectedValue	Void	Int	Set the value to transfer
Apply	Void	CcoCampaignMilitaryForce	Applies the transfer to the provided forces
CanApply	Bool	CcoCampaignMilitaryForce	Returns true if the selected source has the selected amount of resource and can pay the cost to transfer it to the provided sink
SetSource	Void	CcoCampaignMilitaryForce	Set the military force used as the source of the transfer
SelectedValue	Int	Void	Returns the current value set to transfer
Cost	Int	CcoCampaignMilitaryForce	Returns the cost to transfer the selected value from the selected source to the provided sink

CcoPreBattleAIAvailableGenerals

Functions

Name	Return Type	Arguments	Description	Tags	Events
GetGeneralsList	ContextList	Void

CcoPreBattleFactionVote

Functions

Name	Return Type	Arguments	Description
IsComponentOnAttackingUISideOfPrebattle	Bool	ExpressionState	Returns true if component this is called on is a child of the panel side in prebattle showing attackers (used for determining which faction would be supporting)
SelectedPlayAsAIFaction	CcoCampaignFaction	Void	Returns CcoCampaignFaction context for the selected to play as ai faction, can return nullptr
SupportAttackerFactionContext	CcoCampaignFaction	Void	Returns the primary attacking faction, which if choose to support attacker you would be supporting
Faction	CcoCampaignFaction	Void	Returns CcoCampaignFaction context this vote belongs to
IsVoteDisabled	Bool	String, Bool (optional)	Returns true if this vote is currently disabled (used to set button inactive). Takes the vote option id as string, and if any factions available to select for if play as ai option
HasSelectedPlayAsAiFaction	Bool	Void	Returns whether a Play as AI faction has been selected
HasVoted	Bool	Void	Returns whether a vote has been cast
PlayAsAIFactionSelectedContext	Context	Void	Returns Play as AI faction selected, can return nullptr
CastVote	Void	String, Bool, CcoCampaignFaction (optional)	Submits a vote for a faction, takes in String representing the vote, a bool for if want to toggle off if already active, and optional CcoCampaignFaction for play as ai vote
IsFactionAvailableAsPlayAsAI	Bool	CcoCampaignFaction	Returns whether the vote's faction and play as passed in AI faction
SelectedVote	UniString	Void	Returns localised stringrepresenting the vote cast, can return empty string
IsVoteAvailable	Bool	String	Returns whether passed in String representing the vote is available for the this faction of this vote
SelectedVoteKey	String	Void	Returns UNlocalised stringrepresenting the vote cast, can return empty string
SupportDefenderFactionContext	CcoCampaignFaction	Void	Returns the primary defending faction, which if choose to support defender you would be supporting
IsPermittedToChangeVote	Bool	Void	Returns bool whetehr the faction is permitted to change its vote

CcoPreBattleVotingSystem

Functions

Name	Return Type	Arguments	Description
CanCancelReady	Bool	Void	Returns true if can call CancelReady
ReadyCountdownTime	UniString	Void	Returns formatted localised time until battle will commence
CancelReady	Void	Void	Cancels ready status of local player which will reset their vote and cancel the current countdown timer for battle to commence
IsReadyTimerActive	Bool	Void	Returns true if all players selected a vote and battle is counting down to start
AllVotes	CcoPreBattleFactionVote (list)	Void	Returns context list of all CcoPreBattleFactionVote contexts in the voting system
FactionsAvailableToPlayAsAI	CcoCampaignFaction (list)	CcoCampaignFaction	Return context list of CcoCampaignFaction representing the factions of armies that are available to be played as AI
FactionPlayingAsAiFaction	CcoCampaignFaction	CcoCampaignFaction	Returns the faction context for who is playing as AI for the specified faction (null if no one and will be controlled by AI)
VoteForFaction	CcoPreBattleFactionVote	CcoCampaignFaction	Returns CcoPreBattleFactionVote context for the CcoCampaignFaction passed in, can return nullptr

CcoPrisonSystem

Functions

Name	Return Type	Arguments
IsPrisonFull	Void	Void
CurrentNumberOfPrisoners	Void	Void
MaxNumberOfPrisoners	Void	Void

CcoSaveGameHeader

Wrapper for a save game header

Functions

Name	Return Type	Arguments	Description
IsCloudSave	Bool	Void	Returns true if save is in the cloud
IsDifferentBuildVersion	Bool	Void	Returns true if save made with different build to current game, to warn of potential issues/changes
TurnNumber	Int	Void	Current turn number in the save game
Year	Int	Void	Current year in the save game
TimeText	UniString	Void	Returns the formatted time the save was made
Filename	String	Void	Returns the filename
DifficultyText	UniString	Void	Returns the difficulty of the campaign
DateText	UniString	Void	Returns the formatted date the save was made
SeasonText	UniString	Void	Current season in the save game
FactionName	UniString	Void	Returns name of faction playing as (use this instead of record as supports renaming of faction)
FactionRecordContext	CcoFactionRecord	Void	Returns the CcoFactionRecord for faction playing as
CampaignRecordContext	CcoCampaignMapPlayableAreaRecord	Void	Returns the CcoCampaignMapPlayableAreaRecord for campaign

CcoTempleOfTheOldOnes

Functions

Name	Return Type	Arguments
CurrentLevel	Void	Void
NumberOfBuildings	Void	Void
Name	Void	Void
Description	Void	Void
CurrentEffectBundle	Void	Void
Colour	Void	Void

Record

CcoAbilityCollectionRecord

Wrapper for an AbilityCollection for nested abilities

Functions

Name	Return Type	Arguments	Description
ShouldHideAbilityDescription	Bool	CcoUnitAbility	Hides a component based on record is_hidden entry
PrimaryAbilityForUnit	CcoUnitAbilityDetails	CcoUnitDetails	Returns the primary ability of this collection for the given unit
AbilitySortOrder	Int	CcoUnitAbilityDetails	Returns the sort order for a given ability
AttributesForUnit	CcoStringValue (list)	CcoUnitDetails	Returns the attributes associated with this collection and given unit (CcoUnitDetails)
IconPathForUnit	String	CcoUnitDetails	Returns the collection's icon file path for the given unit
AbilitiesForUnit	CcoUnitAbility (list)	CcoUnitDetails	Returns the unit abilities associated with this collection and given unit (CcoUnitDetails)
RecordList	CcoAbilityCollectionRecord (list)	Void	Returns a list of all CcoAbilityCollection records

CcoAbilityRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
ViewInDb	Void	Void
OnScreenName	Void	Void
OnScreenDescription	Void	Void
Key	Void	Void
Ability	Void	Void

CcoActionResultRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
ActorEffectBundleTurns	Void	Void
TargetEffectBundleTurns	Void	Void
ActorEffectBundle	Void	Void
TargetEffectBundle	Void	Void
Key	Void	Void

CcoAdviceLevelRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
InfoText	Void	Void
AdvisorName	Void	Void
Title	Void	Void
Text	Void	Void
AdviceThread	Void	Void
Category	Void	Void
SubCategory	Void	Void
Key	Void	Void

CcoAgentActionRecord

Functions

Name	Return Type	Arguments
LocalisedActionName	Void	Void
LocalisedActionDescriptionKey	Void	Void
AgentContext	Void	Void
LocalisedActionNameKey	Void	Void
UniqueId	Void	Void
AbilityContext	Void	Void
ChanceOfSuccess	Void	Void
IconPath	Void	Void
RecordList	Void	Void
OpportuneFailureProportionModifier	Void	Void
CriticalFailureProportionModifier	Void	Void
LocalisedActionDescription	Void	Void
CriticalSuccessProportionModifier	Void	Void

CcoAgentCultureDetailRecord

Functions

Name	Return Type	Arguments
Key	Void	Void
Season	Void	Void
Description	Void	Void
AssociatedUnitContext	Void	Void
OnscreenName	Void	Void
DescriptionKey	Void	Void
Agent	Void	Void
CultureContext	Void	Void
OnscreenNameKey	Void	Void
RecruitableInUi	Void	Void
RecordList	Void	Void
Icon	Void	Void
SmallIcon	Void	Void
Level	Void	Void
AgentRecruitedMovie	Void	Void
Gender	Void	Void

CcoAgentRecord

Record wrapper for an AGENT_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoAgentRecord (list)	Void	Returns a list of all agent records in the table
InEncyclopedia	Bool	Void	Returns true if the agent has an encyclopedia entry
EncyclopediaUrl	String	Void	Returns the encyclopedia url of the agent
PortraitOverride	String	Void	Returns the portait override path
FactionCap	Int	Void	Returns how many agents of this type a faction can have
LineOfSight	Int	Void	Returns how much line of sight the agent has
Playable	Bool	Void	Returns true if the agent is playable
IsGeneral	Bool	Void	Returns true if the agent is a general
CultureDetailsContext	CcoAgentCultureDetailRecord	String (optional)	Returns the culture details context for the agent record, using optionally provided culture key
MovePoints	Int	Void	Returns the amount of move points the agent has
Key	String	Void	Returns the key of the agent record
UnlockedByPooledResourceSetList	CcoPooledResourceThresholdOperationSetRecord (list)	CcoCampaignFaction	Returns a list of UnlockedByPooledResourceSetList that will unlock this agent, if any
SortOrder	Int	Void	Returns the sort order for the agent record

CcoAgentSubtypeRecord

Record wrapper for agent_subtypr_record

Functions

Name	Return Type	Arguments	Description
Cap	Int	Void	Returns the max number of characters that can have this agent subtype
AssociatedUnitOverride	CcoMainUnitRecord	Void	Returns the associated unit override if any
DescriptionTextOverride	UniString	Void	Returns the description override if any
CanBeLoadedInCampaign	Bool	Void	Returns true if this subtype can be loaded in campaign
SmallIcon	String	Void	Returns the small image path of this agent subtype
OnscreenNameOverrideKey	String	Void	Returns a string with the name override key
IsCaster	Bool	Void	Returns true if this agent subtype can cast spells
IsSaveable	Bool	Void	Returns true if this subtype can be saved/loaded
OnscreenNameOverride	UniString	Void	Returns the name override for this agent subtype if any
Key	String	Void	Returns the key of the record
UniqueAgentContext	CcoAgentRecord	Void	If this subtype is an unique agent, returns the agent record of it
AutoGenerate	Bool	Void	Returns true if this agent subtype can be auto generated
RecordList	CcoAgentSubtypeRecord (list)	Void	Returns a list with all agent subtypes in the table
AgentSubtypeAgentPairContext	CcoAgentSubtypeAgentPair	CcoAgentRecord	Returns the pair of this agent subtype and the agent record passed in
HasFemaleName	Bool	Void	Returns true if it has a female name
CharacterAncillaryQuestList	CcoCharacterAncillaryQuestUiDetailRecord (list)	Void	Returns a list with all ancillary quests associated with this agent subtype, if any
ShowInUi	Bool	Void	Returns true if this agent subtype should show in UI

CcoAncillariesCategoryRecord

Record wrapper for an ancillaries_category_record

Functions

Name	Return Type	Arguments	Description
IsFusable	Bool	Void	Returns true if items from this category can be fused
RecordList	CcoAncillariesCategoryRecord (list)	Void	Returns a list with all entries from the ancillaries_category_table
DefaultEntryName	UniString	Void	Returns a localised default name, for when no ancillary of this category is equipped
DefaultEntryTooltip	UniString	Void	Returns a localised default tooltip, for when no ancillary of this category is equipped
IconName	String	Void	Returns the name of the icon that is used for this category
SortOrder	Int	Void	Returns an int with the category sort order
Category	String	Void	Returns a string from the category enum
OnscreenName	UniString	Void	Returns the localised name of the category
Key	String	Void	Returns the key of the record
NumAllowedPerCharacterForFaction	Int	CcoCampaignCharacter, CcoFactionRecord (optional)	Returns the number of ancillaries that can be equipped into this category per category for a (optionally provided) faction, e.g. 3 for runes
IsHidden	Bool	Void	Returns true if this ancillary catgeory should be hidden in ui

CcoAncillariesSubcategoryRecord

Context wrapper for a ANCILLARIES_SUBCATEGORY_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoAncillariesSubcategoryRecord (list)	Void	Returns a list of all subcategories in the database
IsRune	Bool	Void	Returns true if this subcategory is a rune
OnscreenName	UniString	Void	Returns the localised name of the subcategory
Subcategory	String	Void	Returns the subcategory string/key

CcoAncillaryRecord

Record wrapper for a ancillary_record

Functions

Name	Return Type	Arguments	Description	Tags
ProvidedBannerContext	CcoBannerRecord	Void	Returns the context of the banner assiciated with this ancillary, used for ancillaries with banner subcategory
FirstLinkedUnitRecord	CcoMainUnitRecord	Void	Returns the first linked unit record
RandomlyDropped	Bool	Void	Returns true if this ancillary is randomly dropped
Transferrable	Bool	Void	Returns true if this ancillary can be transferred between characters
IsWifeAncillary	Bool	Void	Returns true if this is a wife ancillary
CanFactionUseAncillary	Bool	CcoFactionRecord	Returns true if the passed in faction record can use this ancillary
Immortal	Bool	Void	Returns true if this ancillary is immortal
UniqueToWorld	Bool	Void	Returns true if this ancillary is unique to the world
GrantedText	UniString	Void	Returns a string showing the message to use when an ancillary is granted by tech etc.
IconState	String	Void	Returns a string with the state name that should be set on the icon based on the ancillary category
IncludedAgentSubtypesList	CcoAgentSubtypeRecord (list)	Void	Returns a list with agent subtypes that can equip this ancillary
CanBeDestroyed	Bool	Void	Returns true if this ancillary can be destroyed
TypeContext	CcoAncillaryTypeRecord	Void	Returns the context of the type record associated with this ancillary
IncludedSubculturesList	CcoSubcultureRecord (list)	Void	Returns a list of subcultures that can use this ancillary
RarityState	String	Void	Returns a string with the rarity state of the ancillary category
MaxExpiryAge	Int	Void	Returns the maximum expiry age
AncillarySetContext	CcoAncillarySetRecord	Void	Returns the context of the ancillary set that this belongs to
FrameState	String	Void	Returns a string with the state name that should be set on the frame based on the ancillary category
IncludedAgentsList	CcoAgentRecord (list)	Void	Returns a list with the agents that can equip this ancillary
ExplanationText	UniString	Void	Returns a string explaining the reason why this ancillary was dropped
MaxStartingAge	Int	Void	Returns the maximum starting age for this ancillary
EffectList	CcoEffect (list)	Void	Returns a list of effects from this ancillary record, prefiltered to not show those that shouldnt appear in ui
OnscreenName	UniString	Void	Returns the localised name of the ancillary
IconPath	String	Void	Returns the icon path of the ancillary
EffectUnfilteredList	CcoEffect (list)	Void	Returns a list of effects from this ancillary record, includes those not shown in ui	hide_in_uied
MinExpiryAge	Int	Void	Returns the minimum expiry age
CategoryContext	CcoAncillariesCategoryRecord	Void	Returns the context of the ancillary category
RarityName	UniString	Void	Returns the localised name of the rarity name of the ancillary, based on the uniqueness score
UniquenessRecordContext	CcoAncillaryUniquenessGroupingRecord	Void	Returns the context of the uniqueness group where this fits, based on its uniqueness score.
MinStartingAge	Int	Void	Returns the minimum starting age for this ancillary
Key	String	Void	Returns the key of the record
SubcategoryContext	CcoAncillariesSubcategoryRecord	Void	Returns the context of the ancillary sub category
ColourText	UniString	Void	Returns localised description for the ancillary
RecordList	CcoAncillaryRecord (list)	Void	Returns a list with all ancillaries in the table
LegendaryItem	Bool	Void	Returns true if this item is legendary
StartDate	Int	Void	Returns an int with the start date of the ancillary
EndDate	Int	Void	Returns an int with the end date of the ancillary
UniquenessScore	Int	Void	Returns the uniqueness score of this ancillary
EffectText	UniString	Void	Returns localised text for the ancillary effects
TurnsBeforeSwapAllowed	Int	Void	Returns an int with the number of turns until this ancillary can be swapped with another of the same category
UniqueToFaction	Bool	Void	Returns true if this ancillary is unique factionwide
ProvidedBodyguardUnitContext	CcoMainUnitRecord	Void	Returns the context of the provided bodyguard context, usually used for mounts
OwningCharacterContext	CcoCampaignCharacter	CcoCampaignFaction (optional)	Returns the CcoCampaignCharacter that owns this ancillary. Searches in the players faction, or the optionally provided CcoCampaignFaction
Precedence	Int	Void	Returns an int with the precedence of the ancillary

CcoAncillarySetRecord

Record wrapper for an ancillary set record

Functions

Name	Return Type	Arguments	Description	Tags
RecordList	CcoAncillarySetRecord (list)	Void	Returns a list of all ancillary sets in the table
EffectUnfilteredList	CcoEffect (list)	Void	Returns a list of effects that will be provided by this ancillary set when it completes, includes those not shown in ui	hide_in_uied
RequiredAncillariesList	CcoAncillaryRecord (list)	Void	Returns a list of ancillaries that are required for this set to be complete.
IconPath	String	Void	Returns the icon path of the set
EffectList	CcoEffect (list)	Void	Returns a list of effects that will be provided by this ancillary set when it completes, prefiltered to not show those that shouldnt appear in ui
Name	UniString	Void	Returns the localised name of the set
Description	UniString	Void	Returns the description of the set

CcoAncillaryTypeRecord

Functions

Name	Return Type	Arguments
Icon	Void	Void
RecordList	Void	Void
Key	Void	Void

CcoAncillaryUniquenessGroupingRecord

Record wrapper for a ancillary_uniqueness_grouping_record

Functions

Name	Return Type	Arguments	Description
UiState	String	Void	Returns the ui state for this group
Min	Int	Void	Returns an int with the lower bound of this group
Key	String	Void	Returns the key of the record
Colour	Colour	Void	Returns the colour of this uniqueness group
RecordList	CcoAncillaryUniquenessGroupingRecord (list)	Void	Returns a list with all uniqueness groups in the table
Max	Int	Void	Returns an int with the upper bound of this group
IsFusable	Bool	Void	Returns true if this items in this group can be fused

CcoArmoryItemRecord

Record wrapper for armory item record

Functions

Name	Return Type	Arguments	Description
IsEquippedForCharacter	Bool	CcoCampaignCharacter	Returns true if the item is equipped for the character (campaign only)
EffectList	CcoEffect (list)	Void	Returns a list with the effects provided by this item
ItemSetList	CcoArmoryItemSetRecord (list)	Void	Returns a list of all the sets this item is part of
VariantRecordList	CcoArmoryItemVariantRecord (list)	Void	Returns a list with all the variants of this item
DefaultOrFirstVariantContextForCharacter	CcoCampaignArmoryItemVariant	CcoCampaignCharacter	Returns either the default variant if exists, or the first in the list of variants, for the character passed in
VariantContext	CcoArmoryItemVariantRecord	String	Returns the context of the variant with the key passed in
DefaultVariantContext	CcoArmoryItemVariantRecord	Void	Returns the context of the default variant for this item
AchievementUnlockScore	Int	Void	Returns the score needed to unlock this item through achievements
Description	UniString	Void	Returns the localised description of the record.
IsLockedByAchievement	Bool	Void	Returns true if this item is currently locked by an achievement
ItemTypeContext	CcoArmoryItemUiTypeRecord	Void	Returns the type context of the armory item
SlotTypeContext	CcoArmorySlotTypeRecord	Void	Returns the context of the slot type record
ImagePath	String	Void	Returns the image path of either the default or the first variant
MatchesQuery	Bool	UniString	Returns true if the item or its effects match (possibly partially) the query text given
RoundUnlockedForCharacter	Int	CcoCampaignCharacter	Returns the round when the item was made available to the passed in character
Name	UniString	Void	Returns the localised name of the armory item record.
MarkAsSeen	Void	Void	Marks the equipment as seen so that HasSeen will return false
Key	String	Void	Returns the key of the record.
DefaultItemSet	CcoArmoryItemSetRecord	Void	Returns the first set that has effects (each item should only have max 1 set with effects, rest are used for custom battle)
RecordList	CcoArmoryItemRecord (list)	Void	Returns a list with all the armory item records in the table
HasSeen	Bool	Void	Returns true if the user has already 'seen' this ancillary (MarkAsSeen has been called on it). This is to highlight new equipment

CcoArmoryItemSetRecord

Wrapper for a ARMORY_ITEM_SET_RECORD

Functions

Name	Return Type	Arguments	Description	Tags
RecordList	CcoArmoryItemSetRecord (list)	Void	Returns a list with all item sets in the table
EffectList	CcoEffect (list)	Void	Returns the effect list provided when all items in the set are equipped
EffectUnfilteredList	CcoEffect (list)	Void	Returns the effect list provided when all items in the set are equipped, includes those not shown in ui	hide_in_uied
ItemList	CcoArmoryItemRecord (list)	Void	Returns all the armory items that are part of this set
Description	UniString	Void	Returns the localised description of the item set
Icon	String	Void	Returns the icon path of the item set
Key	String	Void	Returns a string with the key of the record
Name	UniString	Void	Returns the localised name of the item set

CcoArmoryItemUiTypeRecord

Wrapper for a ARMORY_ITEM_UI_TYPE_RECORD

Functions

Name	Return Type	Arguments	Description	Tags	Events
Key	String	Void	Returns the type of the armory items linked to this (generic/khorne/nurgle/tzeentch/slaanesh).
RecordList	CcoArmoryItemUiTypeRecord (list)	Void	Returns a list with all records in this table

CcoArmoryItemVariantRecord

Wrapper for an armory item variant record

Functions

Name	Return Type	Arguments	Description
RecordList	CcoArmoryItemVariantRecord (list)	Void	Returns a list with all armory item variants in the database table.
ArmoryItemContext	CcoArmoryItemRecord	Void	Returns the context of the armory item associated with this item variant
UseAsDefault	Bool	Void	Returns a bool that specifies whether this variant is used as the default
Name	UniString	Void	Returns the localised name of the item variant
Description	UniString	Void	Returns the description of this variant
Key	String	Void	Returns a string with the key of this record
ImagePath	String	Void	Returns the image path of this variant

CcoArmorySlotTypeRecord

Wrapper for an armory slot type record.

Functions

Name	Return Type	Arguments	Description
EquippedItemVariantForCharacterContext	CcoCampaignArmoryItemVariant	CcoCampaignCharacter	Returns a CcoCampaignArmoryItemVariant with the equipped variant in the slot for the character passed in (campaign only)
Name	UniString	Void	Returns a the localised name of the slot type
SortOrder	Int	Void	Returns an int with the sort order
RecordList	CcoArmorySlotTypeRecord (list)	Void	Returns a list with all armory slot type records from the database table
Key	String	Void	Returns a string with the key of the record

CcoArmySpecialAbilityRecord

Functions

Name	Return Type	Arguments
ArmySpecialAbilityKey	Void	Void
UniqueID	Void	Void
EnablesSiegeAssault	Void	Void
UnitSpecialAbilityContext	Void	Void

CcoBannerRecord

Functions

Name	Return Type	Arguments
PermittedUnitSets	Void	Void
RecordList	Void	Void
Banner	Void	Void
CombatPotentialAdjustments	Void	Void
EffectBundleRecord	Void	Void

CcoBattleClimateWeatherDescriptionRecord

Functions

Name	Return Type	Arguments
Probability	Void	Void
SpottingScalar	Void	Void
RecordList	Void	Void
HeatFatigue	Void	Void
ColdFatigue	Void	Void
WeatherRecordContext	Void	Void
SeasonRecordContext	Void	Void
ClimateRecordContext	Void	Void

CcoBattleCurrencyArmySpecialAbilitiesCostValueRecord

Functions

Name	Return Type	Arguments
CostValue	Void	Void
ArmySpecialAbilityContext	Void	Void
BattleSecondaryCurrencyTypeContext	Void	Void

CcoBattleCurrencyUnitAbilitiesCostValueRecord

Functions

Name	Return Type	Arguments
CostValue	Void	Void
RecordList	Void	Void
CurrencyTypeContext	Void	Void
ItemTypeContext	Void	Void

CcoBattleEntityRecord

Functions

Name	Return Type	Arguments
ChargeSpeed	Void	Void
FireArcClose	Void	Void
ProjectileIntersectionRadiusRatio	Void	Void
FlySpeed	Void	Void
RadiiRatio	Void	Void
ProjectilePenetrationSpeedChange	Void	Void
Acceleration	Void	Void
Mass	Void	Void
SoftCollisionOffsetZ	Void	Void
GradientStrategy	Void	Void
Radius	Void	Void
WalkSpeed	Void	Void
CanClimbLadderAndStairPipes	Void	Void
RunSpeedContext	Void	Void
Shape	Void	Void
Key	Void	Void
KnockInterruptsIgnoreChance	Void	Void
SoftCollisionSize	Void	Void
Type	Void	Void
DismemberArmsAliveHpRatio	Void	Void
RecordList	Void	Void
ChargeDistanceAdoptChargePoseSq	Void	Void
CombatReactionRadius	Void	Void
ChargeDistancePickTargetSq	Void	Void
HitReactionsIgnoreChance	Void	Void
HasBlood	Void	Void
ChargeDistancePickTarget	Void	Void
AllowStaticTurnAnim	Void	Void
DismemberHeadAliveHpRatio	Void	Void
ChargeDistanceCommenceRunSq	Void	Void
MinTurningSpeed	Void	Void
VfxFilterId	Void	Void
ChargeDistanceCommenceRun	Void	Void
TurnSpeed	Void	Void
CanCastProjectile	Void	Void
ChargeDistanceAdoptChargePose	Void	Void
AllowTurnToMoveAnim	Void	Void
MinTrackingRatio	Void	Void
FlyingChargeSpeed	Void	Void
HalfFireArcCloseCosine	Void	Void
MaxTrackingRatio	Void	Void
StrafeSpeed	Void	Void
QuarterFireArcCloseCosine	Void	Void
ProjectilePenetrationResistance	Void	Void
Deceleration	Void	Void
Height	Void	Void
AuraVfx	Void	Void

CcoBattlePurchasableGroupRecord

Wrapper for a battle purchasable group record

Functions

Name	Return Type	Arguments	Description	Tags	Events
PurchasableUnitAbilitiesList	CcoBattlePurchasableUnitAbility (list)	Void	Return the list of purchasable abilities in the group
PurchasableArmyAbilitiesList	CcoBattlePurchasableArmyAbility (list)	Void	Return the list of purchasable army usesabilities in the group

CcoBattlePurchasableItemsJunctionRecord

Wrapper for a Battle Purchasable Items Junction record

Functions

Name	Return Type	Arguments	Description
RecordListForCategoryFiltered	CcoBattlePurchasableUnitAbility (list)	String, ContextList	(CategoryKey, UnitList) Get a list of CcoBattlePurchasableUnitAbility's, in the specified category, filtered by which abilities can be applied to any of a list of units
RecordList	CcoBattlePurchasableItemsJunctionRecord (list)	Void	Get the full list of available CcoBattlePurchasableItemsJunctionRecord's
GroupsForCategory	CcoBattlePurchasableGroupRecord (list)	String	(CategoryKey) Get the list of CcoBattlePurchasableGroupRecord's in the specified category
RecordListForCategory	CcoBattlePurchasableUnitAbility (list)	String	(CategoryKey) Get the list of CcoBattlePurchasableUnitAbility's in the specified category

CcoBattlePurchasableItemsUiCategoryRecord

Wrapper for a UI Battle Purchasable Items Junction record

Functions

Name	Return Type	Arguments	Description	Tags	Events
RecordList	CcoBattlePurchasableItemsUiCategoryRecord (list)	Void
CategoryKey	String	Void

CcoBattleRecord

Record wrapper for a BATTLE_RECORD

Functions

Name	Return Type	Arguments
RecordList	CcoBattleRecord (list)	Void
Description	UniString	Void
StartBattle	Void	ExpressionState
ReleaseMap	Bool	Void
Map	String	Void
EnvironmentPath	String	Void
Name	UniString	Void
EnvironmentAudioType	String	Void
Specification	String	Void
IsLargeSettlement	Bool	Void
Screenshot	String	Void
Has15mWalls	Bool	Void
PlayableAreaWidth	Float	Void
BattleTypeString	UniString	Void
PlayableAreaHeight	Float	Void
IsNaval	Bool	Void
Author	String	Void
CatchmentName	String	Void
BattleType	String	Void
UserCreated	Bool	Void
HasKeyBuildings	Bool	Void
Key	String	Void
Matchmaking	Bool	Void
Year	Int	Void
DefenderFundsRatio	Float	Void
IsCommunity	Bool	Void
Multiplayer	Bool	Void
Singleplayer	Bool	Void
IsOfficial	Bool	Void
IntroMovie	String	Void

CcoBattleResultTypeRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
ResultDescription	Void	Void
UnitXpGain	Void	Void
ResultScreenName	Void	Void
BattleResultType	Void	Void

CcoBattleSecondaryCurrencySourceTypeRecord

Functions

Name	Return Type	Arguments
SourceType	Void	Void
IsAllianceBased	Void	Void
Description	Void	Void
UiLocalisedName	Void	Void
RecordList	Void	Void

CcoBattleSecondaryCurrencyTypeRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
UiLocalisedName	Void	Void
UiIconPath	Void	Void
CurrencyType	Void	Void

CcoBattleSetPieceArmiesCharacterRecord

Functions

Name	Return Type	Arguments
AgentSubtypeContext	Void	Void
ItemsList	Void	Void
NumMen	Void	Void
AgentTypeContext	Void	Void
UnitRecordContext	Void	Void
CharacterLevel	Void	Void
Name	Void	Void
MagicLoreContext	Void	Void
RecordList	Void	Void
PortraitForCard	Void	Void
Male	Void	Void
SkillsList	Void	Void
Portrait	Void	Void

CcoBattleSetPieceArmiesCharactersItemRecord

Functions

Name	Return Type	Arguments
CharacterItemContext	Void	Void
RecordList	Void	Void
Name	Void	Void

CcoBattleSetPieceArmiesCharactersSkillRecord

Functions

Name	Return Type	Arguments
CharacterName	Void	Void
RecordList	Void	Void
SkillContext	Void	Void
Level	Void	Void

CcoBattleSetPieceArmiesUnitRecord

Functions

Name	Return Type	Arguments
Key	Void	Void
PercentageNumMen	Void	Void
RecordList	Void	Void
UnitRecordContext	Void	Void
UnitLevel	Void	Void

CcoBattleSetPieceArmyRecord

Wrapper for a BATTLE_SET_PIECE_ARMY_RECORD

Functions

Name	Return Type	Arguments
IsAlliedToPlayer	Bool	Void
IsReinforcementArmy	Bool	Void
ApproachAngle	Int	Void
FlagPathLarge	String	Void
DeploymentZoneId	Int	Void
FlagPathRotated	String	Void
FlagPathSmall	String	Void
Name	UniString	Void
FlagPathMedium	String	Void
AiArmyTactic	String	Void
Key	String	Void
RecordList	CcoBattleSetPieceArmyRecord (list)	Void
FlagDir	String	Void
FactionContext	CcoFactionRecord	Void
IsHiddenArmy	Bool	Void
ShouldMergeArmy	Bool	Void
EffectBundlesList	CcoEffectBundle (list)	Void
DefaultArmyAbilityList	CcoUnitSpecialAbilityRecord (list)	Void
UseDefaultDeploymentZones	Bool	Void
CharactersList	CcoBattleSetPieceArmiesCharacterRecord (list)	Void
UnitsList	CcoBattleSetPieceArmiesUnitRecord (list)	Void
IsFrontendPlayerArmy	Bool	Void

CcoBattleSetPieceFrontendGroupRecord

Functions

Name	Return Type	Arguments
CampaignMapContext	Void	Void
Key	Void	Void
RecordList	Void	Void
CharacterList	Void	Void
BattleList	Void	Void
SortOrder	Void	Void

CcoBattleSetPieceFrontendGroupsToCharacterRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
CharacterContext	Void	Void
FrontendGroupContext	Void	Void

CcoBattleSetPieceRecord

Wrapper for a BATTLE_SET_PIECE_RECORD

Functions

Name	Return Type	Arguments
ArmiesList	CcoBattleSetPieceArmyRecord (list)	Void
IsPlayerAttacker	Bool	Void
StartBattle	Void	ExpressionState, CcoCampaignMapPlayableAreaRecord
UseLargeArmies	Bool	Void
RecordList	CcoBattleSetPieceRecord (list)	Void
BattleSetupContext	CcoBattleSetup	Void
BattleEnvironment	String	Void
ScreenshotPath	String	Void
BattleScript	String	Void
CampaignPreBattleIntroMovieContext	CcoVideoRecord	Void
BattleDuration	Int	Void
HasBeenCompleted	Bool	Void
BattleTypeContext	CcoBattleTypeRecord	Void
Key	String	Void
OutroMovieLoseContext	CcoVideoRecord	Void
IntroMovieContext	CcoVideoRecord	Void
OutroMovieWinContext	CcoVideoRecord	Void
TeleportCost	Int	Void
CatchmentArea	String	Void
PlayerFrontendArmiesList	CcoBattleSetPieceArmyRecord (list)	Void
BattlefieldFolder	String	Void
Name	UniString	Void
ArmoryItemAchievementUnlockList	CcoArmoryItemRecord (list)	Void
Description	UniString	Void

CcoBattleTypeCheatSheetEntryRecord

Wrapper for a Battle UI Cheatsheet Item Record. Used for individual entries used in creating cheat sheet layouts

Functions

Name	Return Type	Arguments	Description
ColumnIndex	Int	Void	Specifies which column group the entry should be in. This index is filtered when the cheat sheet list is collated
VisualKeyString	String	Void	Gets the string which is used to key the item into the cheat sheet screenshot or similar
DescriptionText	UniString	Void
PriorityIndex	Int	Void	Specifies the priority which this item will be listed in the current column. Lower = Higher up the list
IconPath	String	Void
HeaderText	UniString	Void
Key	String	Void

CcoBattleTypeRecord

Functions

Name	Return Type	Arguments
DefenderVictoryConditionsList	Void	Void
DefenderFundsRatio	Void	Void
ListOrder	Void	Void
AttackerVictoryConditionsList	Void	Void
Key	Void	Void
Name	Void	Void
RecordList	Void	Void
MaxTeamsize	Void	Void
Description	Void	Void

CcoBattleVortexRecord

Wrapper for a BATTLE_VORTEX_RECORD

Functions

Name	Return Type	Arguments	Description
Delay	Float	Void	Returns the delay before the vortex starts dealing damage / applying contact effects
GoalHeight	Float	Void	Returns the height that the vortex will expand to at the end of its duration
MovementSpeed	Float	Void	Returns the speed that the vortex moves at (m/s)
IgnitionAmount	Float	Void	Returns the ignition amount of the vortex
ExpansionSpeed	Float	Void	Returns the speed that the vortex expands at
GoalRadius	Float	Void	Returns the radius that the vortex will expand to at the end of its duration
ArmourPiercingPercentage	Int	Void	Returns the calculated armour piercing value based on the damage AP to damage ratio, as a percentage
Duration	Float	Void	Returns the duration in seconds of the vortex
DamageAP	Int	Void	Returns the armour-piercing damage per second per entity hit of the vortex
NumVortexes	Int	Void	Returns the number of vortexes that this spell creates
ChangeMaxAngle	Int	Void	Return the max angle change of the vortex
IsCircle	Bool	Void	Returns whether this vortex shape is Circle
Damage	Int	Void	Returns the damage per second per entity hit of the vortex
RecordList	CcoBattleVortexRecord (list)	Void	Returns a list of all battle vortex records
IsMagical	Bool	Void	Returns true if the vortex deals magical damage
ContactEffectPhaseContext	CcoSpecialAbilityPhaseRecord	Void	Returns the contact effect context for this battle vortex record (nullptr if not set)
AffectsAllies	Bool	Void	Returns true if the vortex also affects allied units
Key	String	Void	Returns the db key for this record
DelayBetweenVortexes	Float	Void	Returns the delay between creating additional vortexes
DetonationForce	Float	Void	Returns the force that the vortex detonates with

CcoBattleWeatherTypeRecord

Functions

Name	Return Type	Arguments
GunReloadBonus	Void	Void
IconPath	Void	Void
RecordList	Void	Void
AccuracyMultiplier	Void	Void
BowReloadBonus	Void	Void
ListOrder	Void	Void
NavalAppropriate	Void	Void
Level	Void	Void
OnscreenName	Void	Void
Key	Void	Void

CcoBattlefieldEngineRecord

Wrapper for a BATTLEFIELD_ENGINE_RECORD

Functions

Name	Return Type	Arguments
RecordList	CcoBattlefieldEngineRecord (list)	Void
BattleEntityContext	CcoBattleEntityRecord	Void
CanBeDismantled	Bool	Void
Key	String	Void
MissileWeaponContext	CcoMissileWeaponRecord	Void

CcoBattlefieldSiegeVehicleRecord

Wrapper for BATTLEFIELD_SIEGE_VEHICLE_RECORD

Functions

Name	Return Type	Arguments	Description
VehicleCategory	String	Void	Returns vehicle category (battering ram, siege tower, etc)
AvailableToFactionsList	CcoFactionRecord (list)	Void	Returns list of CcoFactionRecord that can use this record
HitPoints	Int	Void	Returns the hit points (health) of equipment
Name	UniString	Void	Returns the localised name
IgnitionThreshold	Int	Void	Returns the threshold of fire damage will take before catching fire
Key	String	Void	Returns unique key for db record
Uses15mWall	Bool	Void	Returns true if valid for 15m walls
Cost	Int	Void	Returns the cost to purchase
SiegeVehicleEntityContext	CcoBattleEntityRecord	Void	Returns the entity record context
CategoryImagePath	String	Void	Returns the category image path
RecordList	CcoBattlefieldSiegeVehicleRecord (list)	Void	Returns list of all CcoBattlefieldSiegeVehicleRecord in table
Uses8mWall	Bool	Void	Returns true if valid for 8m walls
Description	UniString	Void	Returns the localised description
ImagePath	String	Void	Returns the image path
RecruitmentCap	Int	Void	Returns max number can recruit
AttackDamage	Float	Void	Returns damage causes (for attacking gates, etc)
SortOrder	Int	Void	Returns sort order used by UI

CcoBattlefieldSiegeVehiclesCustomBattleRecord

Functions

Name	Return Type	Arguments
Probability	Void	Void
RecordList	Void	Void
VehicleContext	Void	Void
Cap	Void	Void

CcoBuildingChainRecord

Wrapper for a building chain record

Functions

Name	Return Type	Arguments	Description
MaximumLevel	Int	Void	Returns the maximum level in this chain.
PercentageUntilNextCyclicLevel	Float	CcoCampaignBuildingSlot	Helper function to calculate the percentage of fill, taking the amount of time left until next cyclic building level.
MaximumChainColumn	Int	Void	Returns the maximum number of building levels that share the same level (for branching trees)
BuildingSetContext	CcoBuildingSetRecord	Void	Returns the context of this chain's set.
BuildingBrowserSlotContext	CcoCampaignBuildingSlot	Context, CcoCampaignFaction (optional)	Returns the slot where this chain is built if that exists. If not, returns the next empty slot available. Returns null if there is no active empty slot.
CyclicBuildingTree	TreeData	Context	Returns a cyclical tree structure for buildings that have a lifecycle.
RecordList	CcoBuildingChainRecord (list)	Void	Returns a list with all the records in building_chains table.
Name	UniString	Void	Returns the localised name of this chain.
BuildingSuperchainContext	CcoBuildingSuperchainRecord	Void	Returns the context of the superchain that this chain is part of.
CurrentSlotUpgradeList	CcoBuildingLevelRecord (list)	CcoCampaignBuildingSlot	Returns a list with the upgrades of the slot passed in that are part of this chain.
BuildingTree	TreeData	CcoCampaignBuildingSlot	Returns a tree structure with all the levels in the chain.
OptionalTierIcon	String	Void	Returns the optional tier icon defined in the table, or an empty string if this doesn't exist
LevelsList	CcoBuildingLevelRecord (list)	Void	Returns a list with all the levels in this chain.
OptionalSortOrder	Int	Void	Returns an int with the sort order of this chain (compared to other chains)
MinUniqueLevel	Int	Void	Returns an int with the minimum level that is faction unique. Returns -1 if no such level exists.
TechnologyCategory	String	Void	Returns a string with the building chain category type.
InEncyclopedia	Bool	Void	Returns true if the record can be found in the encyclopedia.
LevelZeroBuildingLevelContext	CcoBuildingLevelRecord	Void	Returns the context of the first building level in the chain.
Key	String	Void	Returns the key of the record.

CcoBuildingCultureVariantRecord

Functions

Name	Return Type	Arguments
Disables	Void	Void
RecordList	Void	Void
Icon	Void	Void
NameKey	Void	Void
Name	Void	Void
ShortDescription	Void	Void
LongDescription	Void	Void
SubcultureRecordContext	Void	Void
FactionRecordContext	Void	Void
BuildingLevel	Void	Void
CultureRecordContext	Void	Void
Key	Void	Void

CcoBuildingLevelRecord

Record wrapper for a BUILDING_LEVEL_RECORD

Functions

Name	Return Type	Arguments	Description
UpgradesList	CcoBuildingLevelRecord (list)	Void	Returns a list with this building level's upgrades
FactionUnique	Bool	Void	Returns true if this building is unique in the faction/can only be built once in the faction
AgentList	CcoAgentSubtypeAgentPair (list)	Void	Returns a list with the agents provided by this building level
TooltipForCurrentSlot	UniString	CcoCampaignBuildingSlot	Returns the tooltip for this building, depending if it can build/is in construction etc. Need to pass building slot where this is built.
CanAfford	Bool	Context, CcoCampaignFaction (optional)	Returns true if the settlement/character passed in can afford to build this
IsBuiltInProvince	Bool	CcoCampaignProvince	Returns true if this building level, or a building level above this, is built in the passed in province
HealthOverride	Float	Void	Returns the health override of this building level
HasEnoughDevelopmentPoints	Bool	Context	Returns true if the settlement/character passed in has enough development points to build this
ShouldShowMouseOverComponent	Bool	CcoCampaignBuildingSlot	Returns true if the mouseover that shows cost/turns should show
EffectList	CcoEffect (list)	CcoCampaignBuildingSlot (optional)	Returns a list with the effects provided by this building
VisibleInUi	Bool	CcoCampaignBuildingSlot	Returns true if visible in ui. If passed true, will take into account that this is a primary level slot(and therefore return false if it't ruin level for that)
Key	String	Void	Returns the key of the building level record
HasLifecycleState	Bool	Void	Returns true if this building is part of a lifecycle chain
UnitList	CcoMainUnitRecord (list)	Context, CcoCampaignFaction (optional)	Returns a list with the units provided by this building. Needs passing a settlement or character context in order to check for permissions
EncyclopediaRedirectBuilding	String	Void	Returns a string with the encyclopedia redirect link for this building
TechList	CcoTechnologyRecord (list)	Void	Returns a list with technologies unlocked by this building
IsCurrentConstructionItemForSlot	Bool	CcoCampaignBuildingSlot	Returns true if this level is the one currently in construction in the slot passed in
ResourceRequirementContext	CcoResourceRecord	Void	Returns the context of the required resource for this building, if any
IsRedundantDuplicate	Bool	CcoCampaignSettlement	Returns true if there is already a building of this type in the province, which might not provide any other benefits
ShouldShowBuildingLevelInUiForTechnology	Bool	Void	Returns true if this building should be shown in ui as a requirement for a technology
ConstructionItemForCurrentSlotContext	CcoCampaignConstructionItem	CcoCampaignBuildingSlot	Returns the CcoConstructionItem context for this building level, if any. Need to pass in the building slot where this is built.
CanBeDamaged	Bool	Void	Returns true if this building can be damaged
DoesBuildingExceedCap	Bool	CcoCampaignBuildingSlot	Returns true if this building exceeds the cap of this type of building in the province
IsResourceBuilding	Bool	Void	Returns true if this building is a resource building(provides resource when built)
PlayerVariantRecordContext	CcoBuildingCultureVariantRecord	Void	Returns the culture variant of this building for the player faction
LifecycleTransitionTime	Int	Context	Returns the time it will take the previous building to transition to this one. Returns 0 if this level is not part of a cyclic chain
IsBuiltInSlot	Bool	CcoCampaignBuildingSlot	Returns true if this building level is built in the passed in slot, or if any building level above it is built
BuildingChainRecordContext	CcoBuildingChainRecord	Void	Returns the context of the building chain record that this level is part of
CanConvert	Bool	Void	Returns true if this building level can be converted
HasResourceRequirements	Bool	Void	Returns true if this building level needs resources to build
PrimarySlotBuildingLevelRequirement	Int	Void	Returns the level of the primary slot that needs to be built for this level to be available
ResourceRecordContext	CcoResourceRecord	Void	Returns the context of the resource for this building, if any
CanPlayerBuildThis	Bool	Void	Returns true if this building is available to the players faction
DowngradesToLevelContext	CcoBuildingLevelRecord	Void	Returns the context of the level it downgrades to
FoodCost	Int	Void	Returns the amount of food this building will require to be constructed
IssueCommandForBuildingBrowser	Void	CcoCampaignBuildingSlot	Issues the appropriate command when clicking on a building (cancel construction if building, build if it can etc)
IsActiveForBuildingBrowser	Bool	CcoCampaignBuildingSlot	Returns true if this building can be shows as the active state in the building browser
SlaveCapContribution	Int	Void	Returns the slave constribution for this building
MercenaryUnitAndAmountPairList	CcoPair (list)	Void	Returns a list of pairs with mercenary units and amount provided by this building level, if any
IsLockedByLevel	Bool	Context	Returns true if this level is not available due to primary building requirements
DevelopmentPointCost	Int	Context	Returns the development point cost of this building level. If passed a settlement or character, it will return the cost depending on any bonus values they might have
ResourceCostContext	CcoCampaignResourceTransaction	CcoCampaignBuildingSlot	Returns the context of the (pooled) resource transaction cost of this building
RequiredTechnologiesList	CcoTechnologyRecord (list)	Void	Returns a list with the required technologies for this building to become available
IsBuildingForCurrentSlot	Bool	CcoCampaignBuildingSlot	Returns true if this is the building level that is currently built in the passed in slot
OpenBuildingInfoPanel	Void	ExpressionState, Context, CcoCampaignBuildingSlot, Bool (optional), CcoCampaignFaction (optional)	If the component has a BuildingInfoPanelMouseOver callback, it will initialise this with building info. Otherwise, it opens info panel with building info. If second argument is true, it will only show technology info
CreateCost	Int	Context, CcoCampaignFaction (optional)	Returns the cost to create this building. If passed either a settlement or a character, it will return the cost based on any bonus values those might have
SetupTooltipForHordeBuilding	Void	ExpressionState, CcoCampaignCharacter	If the component has a BuildingInfoPanelMouseOver callback, it will initialise this with building info.
AdditionalDependentUnitsList	CcoMainUnitRecord (list)	Void	Returns a list with this building's additional dependent units
OnlyInCapital	Bool	Void	Returns true if this can only be built in the capital
UpkeepCost	Int	Void	Returns the upkeep cost for this building level
Level	Int	Void	Returns the level of this building level
RecordList	CcoBuildingLevelRecord (list)	Void	Returns a list with all the building level records in the table
IsEpisodicRestricted	Bool	Void	Returns true if the building is restricted by mission etc
CanBuildInCurrentSlot	Bool	CcoCampaignBuildingSlot	Returns true if this building can be built in the slot passed in
CreateTime	Int	CcoCampaignBuildingSlot	Returns the number of turns it would take to construct this

CcoBuildingSetRecord

Record wrapper for a BUILDING_SET_RECORD

Functions

Name	Return Type	Arguments	Description
BuildingSuperChainsForSettlement	CcoBuildingSuperchainRecord (list)	CcoCampaignSettlement	Returns a list with all the building superchains for the settlement passed in
MaximumChainBuildings	Int	Context, CcoCampaignFaction (optional)	Returns the maximum number of buildings in this set. Used for calculating the radius of the list. Can pass a settlement or character (horde) to only use chains available there.
BuildingChains	CcoBuildingChainRecord (list)	Context, CcoCampaignFaction (optional)	Returns a list with all the building chains in the set. Can pass a settlement or character (horde) to get the chains that are only available there
SortOrder	Int	Void	Returns an int with the sort order
Colour	Colour	Void	Returns a Pixel8888 with the colour of the set
RecordList	CcoBuildingSetRecord (list)	Void	Returns a list with all building set records from the database
AudioSwitch	String	Void	Returns the audio switch for the building set
OnscreenDescription	UniString	Void	Returns the localised description of the building set
Icon	String	Void	Returns the icon path of the building set
Name	UniString	Void	Returns the localised name of the set
Key	String	Void	Returns the key of the record

CcoBuildingSuperchainRecord

Functions

Name	Return Type	Arguments
ChainList	Void	Void
ChainsForProvinceList	Void	Void
Key	Void	Void
RecordList	Void	Void

CcoBulletPoint

Context wrapper for a bullet point

Functions

Name	Return Type	Arguments	Description	Tags	Events
BulletPointImagePath	String	Void	Returns the image path of the bullet point
BulletPointText	UniString	Void	Returns the text of the bullet point

CcoCampaignBattlePresetRecord

Functions

Name	Return Type	Arguments
ScreenshotPath	Void	Void
RecordList	Void	Void
IsUniqueSettlement	Void	Void
CampaignMapContext	Void	Void
OnscreenName	Void	Void
TileUpgrade	Void	Void
Description	Void	Void
Key	Void	Void
CoordX	Void	Void
CoordY	Void	Void
BattleType	Void	Void

CcoCampaignDecisionChoiceRecord

Functions

Name	Return Type	Arguments
Index	Void	Void
RecordList	Void	Void
PayloadCharacterTraitList	Void	Void
DecisionRecordContext	Void	Void
Title	Void	Void
Label	Void	Void

CcoCampaignDecisionRecord

Functions

Name	Return Type	Arguments
Description	Void	Void
RecordList	Void	Void
Image	Void	Void
Key	Void	Void
Title	Void	Void
ChoiceList	Void	Void

CcoCampaignEffectListRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
Key	Void	Void
Effects	Void	Void

CcoCampaignEffectScopeRecord

Functions

Name	Return Type	Arguments
LocalisedText	Void	Void
RecordList	Void	Void
Key	Void	Void

CcoCampaignFactionCheatSheetEntryRecord

Wrapper for a Campaign UI Cheatsheet Item Record. Used for individual entries used in creating cheat sheet layouts

Functions

Name	Return Type	Arguments	Description
PriorityIndex	Int	Void	Specifies the priority which this item will be listed in the current column. Lower = Higher up the list
HeaderText	UniString	Void
DescriptionText	UniString	Void
Key	String	Void
ImagePath	String	Void

CcoCampaignGroupRecord

Wrapper for a campaign group record

Functions

Name	Return Type	Arguments	Description
MinRange	Int	Void	Returns the min range specified in a linked numeric range criteria table
MaxRange	Int	Void	Returns the max range specified in a linked numeric range criteria table
EffectBundleContext	CcoEffectBundle	Void	Returns the CcoEffectBundle linked to the campaign group if one exists
Key	String	Void	Returns unique key for campaign group
RecordList	CcoCampaignGroupRecord (list)	Void	Returns list of all CcoCampaignGroupRecord in db

CcoCampaignMapPlayableAreaRecord

Wrapper for CAMPAIGN_MAP_PLAYABLE_AREA_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoCampaignMapPlayableAreaRecord (list)	Void	Returns list of all CcoCampaignMapPlayableAreaRecord in table
SortOrder	Int	Void	Returns the sort order of the campaign
ShowsInCampaignSelection	Bool	Void	Returns true if this campaign can be played via new campaign screen (owns dlc, not defined out for a special build, etc
Name	UniString	Void	Returns localised name of campaign
DescriptionText	UniString	Void	Returns localised description of campaign
MoviePath	String	Void	Returns movie to use for frontend campaign select screen
RadarImagePath	String	Void	Returns the radar image for map preview
CampaignKey	String	Void	Returns key for campaign map
FrontendImagePath	String	Void	Returns image to use in frontend campaign select screen
OwnershipProductRecordList	CcoOwnershipProductRecord (list)	Void	Returns the list of CcoOwnershipProductRecord required to be owned for this campaign
Key	String	Void	Returns unique key of record
CampaignStartInfoContext	CcoCampaignStartInfo	Void	Returns CcoCampaignStartInfo used for campaign select screen in frontend (sp, for mp use CcoMpCampaignMap::CampaignStartInfoContext as that includes time of legend info)

CcoCampaignMapWindsOfMagicAreaRecord

Functions

Name	Return Type	Arguments
InitialStrengthContext	CcoCampaignMapWindsOfMagicStrengthRecord	Void
PercentageChanceToChangePerRound	Float	Void
Campaign	String	Void
LocalisedName	UniString	Void
Key	String	Void
RecordList	CcoCampaignMapWindsOfMagicAreaRecord (list)	Void

CcoCampaignMapWindsOfMagicStrengthRecord

Wrapper for a CAMPAIGN_MAP_WINDS_OF_MAGIC_STRENGTH_RECORD record

Functions

Name	Return Type	Arguments	Description
Key	String	Void	Returns a string with the database key of this strength level
RecordList	CcoCampaignMapWindsOfMagicStrengthRecord (list)	Void	Returns a list of CcoEffect with all wom strength records from the database table
PreviewChangedEffectList	CcoEffect (list)	CcoCampaignFactionProvinceManager, Int (optional)	Returns a list of CcoEffect that would change if this strength was set as current. Optionally can pass a level to compare with instead of comparing with current
Duration	Int	Void	Returns and int the duration of this wom strength level
EnableStormOfMagic	Bool	Void	Returns true if this strength enables storm of magic
Frequency	Int	Void	Returns an int with the frequency of this level
Level	Int	Void	Returns an int with the level of this strengh
LocalisedName	UniString	Void	Returns a localised string with the name of the strength
EffectList	CcoEffect (list)	Void	Returns a list of effects applied when this level is active

CcoCampaignOperationSetRecord

Wrapper for a CAMPAIGN_OPERATION_SET_RECORD

Functions

Name	Return Type	Arguments	Description
AgentList	CcoAgentRecord (list)	Void	Returns a list of agents that will get unlocked by the effects in this set
RecordList	CcoCampaignOperationSetRecord (list)	Void	Returns a list of all operation sets in the table
ArmoryItemList	CcoArmoryItemRecord (list)	Void	Returns a list of armory items for this set
UnitList	CcoMainUnitRecord (list)	Void	Returns a list of units that will get unlocked by the effects in this set
EffectBundleList	CcoEffectBundle (list)	Void	Returns a list of effect bundles for this set

CcoCampaignPayloadRecord

Wrapper for a CAMPAIGN_PAYLOAD_RECORD

Functions

Name	Return Type	Arguments
Key	String	Void
WindsOfMagicStrengthChangeContext	Void	Void
RecordList	CcoCampaignPayloadRecord (list)	Void
PooledResourceComponents	Void	Void
ResourceTransactions	CcoCampaignPayloadResourceTransactionRecord (list)	Void
UnitComponents	CcoCampaignPayloadUnitComponentRecord (list)	Void
WarCoordinationTargetComponents	Void	Void
BasicValueComponents	Void	Void
CharacterTraitChangeComponents	Void	Void
SetSubPayloads	Void	Void
BasicComponents	Void	Void
EffectBundles	CcoEffectBundle (list)	Void
RandomSubPayloads	Void	Void

CcoCampaignPayloadResourceTransactionRecord

Wrapper for a CAMPAIGN_PAYLOAD_RESOURCE_TRANSACTION_RECORD

Functions

Name	Return Type	Arguments
Required	Bool	Void
RecordList	CcoCampaignPayloadResourceTransactionRecord (list)	Void
PayloadContext	CcoCampaignPayloadRecord	Void
Duration	Int	Void
ApplyImmediately	Bool	Void
ResourceTransactionContext	CcoResourceCostRecord	Void

CcoCampaignPayloadUnitComponentRecord

Wrapper for a CAMPAIGN_PAYLOAD_UNIT_COMPONENT_RECORD

Functions

Name	Return Type	Arguments
PayloadContext	CcoCampaignPayloadRecord	Void
Amount	Int	Void
Xp	Void	Void
RecordList	CcoCampaignPayloadUnitComponentRecord (list)	Void
UnitContext	CcoMainUnitRecord	Void
ComponentType	Void	Void

CcoCampaignStormTypeRecord

Functions

Name	Return Type	Arguments
ForSea	Void	Void
CanDecay	Void	Void
CanMove	Void	Void
Key	Void	Void
RecordList	Void	Void
CanSpawnOverCharacter	Void	Void
RespectExcludedRegionsTable	Void	Void
ForLand	Void	Void

CcoCampaignStreakEffectRecord

Functions

Name	Return Type	Arguments
OnScreenName	Void	Void
Max	Void	Void
Min	Void	Void
RecordList	Void	Void
CampaignStreakKey	Void	Void
Key	Void	Void
EffectList	Void	Void
EffectUnfilteredList	Void	Void

CcoCampaignStreakRecord

Functions

Name	Return Type	Arguments
Max	Void	Void
StreakEffectList	Void	Void
Key	Void	Void
ResetTurns	Void	Void
Min	Void	Void
RecordList	Void	Void
Type	Void	Void

CcoCampaignVideoRecord

Functions

Name	Return Type	Arguments	Description
ScriptedValueRegistryKey	String	Void	Returns the scripted value registry key of the video (used for unlocking videos)
LocalisedTitle	UniString	Void	Returns the video's localised title
StillPath	String	Void	Returns the still/thumbnail path for the video
VideoRecordContext	CcoVideoRecord	Void	Returns the CcoVideoRecord associated with the video

CcoCapturePointCategoryTypeRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
IconPath	Void	Void
Key	Void	Void
LocalisedName	Void	Void

CcoCapturePointTypeRecord

A DB record wrapper for a battle capture point type

Functions

Name	Return Type	Arguments	Description
RecordList	CcoCapturePointTypeRecord (list)	Void
Key	String	Void	Returns the DB primary key for this capture point type
OnscreenName	UniString	Void	Returns a localised UniString that should be the displayed name for this capture point type
IconName	String	Void	Returns a string path of this capture point types' icon
VisibilitySpottingRange	Float	Void	Gets the spotting range (in metres) that the capture point can be spotted

CcoCaravanContractRecord

Wrapper for a CARAVAN_CONTRACT_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoCaravanContractRecord (list)	Void	Returns a list of all contract in the db
CargoToResourceBoughtRate	Float	Void	Returns a float with the rate at which the cargo is bought
Irrevocable	Bool	Void	Returns true if the contract cannot be revoked
ResourceSoldContext	CcoCampaignPooledResource	CcoCampaignFaction (optional)	Returns a CcoCampaignPooledResource with the resource sold context. Tries to get resource from faction then from faction capital
CargoToResourceSoldRate	Float	Void	Returns a float with the rate at which the cargo is sold
Key	String	Void	Returns the key of the record
ResourceBoughtContext	CcoCampaignPooledResource	CcoCampaignFaction (optional)	Returns a CcoCampaignPooledResource with the resource bought context. Tries to get resource from faction then from faction capital

CcoCdirEventsCategoryRecord

Functions

Name	Return Type	Arguments
Type	Void	Void
RecordList	Void	Void
CategoryKey	Void	Void
OnScreenName	Void	Void

CcoCdirEventsDilemmaChoiceDetailRecord

Record wrapper for a CDIR_EVENTS_DILEMMA_CHOICE_DETAIL_RECORD

Functions

Name	Return Type	Arguments	Description
LocalisedChoiceLabel	UniString	Void	Returns a localised label for the choice
RecordKey	String	Void	Returns the key of the record
ChoiceKey	String	Void	Returns the key of the choice
ChoiceAudio	String	Void	Returns the associated vo event for this choice
ResourceTransactionList	CcoCampaignResourceTransaction (list)	Void	Returns a list with all pooled resource transactions granted by the payload of this choice
EffectBundleList	CcoEffectBundle (list)	Void	Returns a list with all effect bundles granted by the payload of this choice
RecordList	CcoCdirEventsDilemmaChoiceDetailRecord (list)	Void	Returns a list with all choice records from the database table
AncillaryList	CcoAncillaryRecord (list)	Void	Returns a list with all ancillaries granted by the payload of this choice
LocalisedChoiceTitle	UniString	Void	Returns a localised title for the choice
TreasureHuntImageList	CcoString (list)	CcoTreasureHuntExtraInformationRecord	Returns a list with all treasure hunt symbols for the this choice, given the treasure hunt info passed in
DilemmaKey	String	Void	Returns the key of the dilemma that this choice is part of

CcoCharacterAncillaryQuestUiDetailRecord

Record wrapper for character ancillary quest details

Functions

Name	Return Type	Arguments	Description
Instant	Bool	Void	Returns true if the ancillary is instantly awarded without a quest or mission
IsQuestBattle	Bool	Void	Returns true if the ancillary will be awarded after a quest battle
RecordList	CcoCharacterAncillaryQuestUiDetailRecord (list)	Void	Returns a list of all character ancillary quest details from the table
AncillaryContext	CcoAncillaryRecord	Void	Returns the context of the ancillary of this junction
Rank	Int	Void	Returns the rank at which the ancillary quest gets unlocked for the agent subtype
AgentSubtypeContext	CcoAgentSubtypeRecord	Void	Returns the context of the agent subtype of this junction

CcoCharacterSkillRecord

Wrapper for a character skill record.

Functions

Name	Return Type	Arguments	Description
DefaultLocalisedDescription	UniString	Void	Returns the default localised description of the skill
Key	String	Void	Returns the key of the record
RecordList	CcoCharacterSkillRecord (list)	Void	Returns a list with all skills in the database
EffectListForLevel	CcoEffect (list)	Int	Returns a list of CcoEffect with all default effects for the level passed in
IsFemaleOnlyBackgroundSkill	Bool	Void	Returns true if this is a female only background skill
IsMaleOnlyBackgroundSkill	Bool	Void	Returns true if this is a male only background skill
DefaultLocalisedName	UniString	Void	Returns the default localised name of the skill
UnlockedAtRank	Int	Void	Returns an int with the rank at which this skill unlocks
IsBackgroundSkill	Bool	Void	Returns true if this is a background skill
DefaultImagePath	String	Void	Returns the default image path of the skill

CcoCharacterTrainingDilemmaChoiceRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
DilemmaRecordContext	Void	Void
ChoiceEffectRecord	Void	Void
Index	Void	Void
Key	Void	Void
LocalisedLabel	Void	Void

CcoCharacterTrainingDilemmaRecord

Functions

Name	Return Type	Arguments
LocalisedDescription	Void	Void
TrainingEffectType	Void	Void
RecordList	Void	Void
ChoiceList	Void	Void
Key	Void	Void
LocalisedTitle	Void	Void

CcoCharacterTraitLevelRecord

Functions

Name	Return Type	Arguments
EffectUnfilteredList	Void	Void
LoseLevelDescription	Void	Void
EffectText	Void	Void
FlavourDescription	Void	Void
ExplanationDescription	Void	Void
ThresholdPoints	Void	Void
TraitRecordContext	Void	Void
Level	Void	Void
Name	Void	Void
Key	Void	Void
TraitKey	Void	Void
BonusValues	Void	Void
RecordList	Void	Void
EffectList	Void	Void

CcoCharacterTraitRecord

Functions

Name	Return Type	Arguments
AntitraitsList	Void	Void
AllTraitsList	Void	Void
ExcludedCulturesList	Void	Void
TraitLevelsList	Void	Void
PreBattleSpeechParameter	Void	Void
IncludedAgentsList	Void	Void
Precedence	Void	Void
IconPath	Void	Void
Hidden	Void	Void
HasMultipleLevels	Void	Void
Key	Void	Void
NoGoingBackLevel	Void	Void
RecordList	Void	Void

CcoClimateRecord

Functions

Name	Return Type	Arguments	Description	Tags	Events
Key	Void	Void
RecordList	Void	Void

CcoCookingIngredientGroupRecord

Functions

Name	Return Type	Arguments
Colour	Void	Void
RecordList	Void	Void
FlavourText	Void	Void
Key	Void	Void
Ingredients	Void	Void
DisplayName	Void	Void
Icon	Void	Void

CcoCookingIngredientRecord

Record wrapper for a COOKING_INGREDIENT_RECORD

Functions

Name	Return Type	Arguments	Description
Index	Int	Void	Returns the index of the db record
DisplayText	UniString	Void	Returns a localised string with the display text/name of the ingredient
FlavourText	UniString	Void	Returns a localised string with the flavour text/description of the ingredient
Key	String	Void	Returns a string with the key of the ingredient
Icon	String	Void	Returns a string with the icon path of the ingredient
RecordList	CcoCookingIngredientRecord (list)	Void	Returns a list of all ingredients in the db
AlliedUnitEffectsContext	CcoCampaignEffectListRecord	Void	Returns a CcoCampaignEffectListRecord with the allied unit effect list of this ingredient
GroupContext	CcoCookingIngredientGroupRecord	Void	Returns a CcoCookingIngredientGroupRecord with the group the ingredient is part of
FactionLeaderEffectsContext	CcoCampaignEffectListRecord	Void	Returns a CcoCampaignEffectListRecord with the faction leader effect list context
EnemyUnitEffectsContext	CcoCampaignEffectListRecord	Void	Returns a CcoCampaignEffectListRecord with the enemy unit effect list of this ingredient
IngredientVOTrigger	Int	Void	Returns an int with the VO enum type
FactionEffectsContext	CcoCampaignEffectListRecord	Void	Returns a CcoCampaignEffectListRecord with the faction effect list context
DisplayUnlockText	UniString	Void	Returns a localised string with the text displaying how to unlock the ingredient

CcoCookingRecipeRecord

Record wrapper for a COOKING_RECIPE_RECORD

Functions

Name	Return Type	Arguments	Description
FactionEffectsContext	CcoCampaignEffectListRecord	Void	Returns a CcoCampaignEffectListRecord with the faction effect list of this recipe
CookingRecipieVO	Int	Void	Returns an int with the VO type
RequiresSpecificIngredient	Bool	Void	Returns true if this recipe requires a specific ingredient
FlavourText	UniString	Void	Returns a localised string with the flavour text/description of the recipe
Index	Int	Void	Returns an int with the db index of this recipe
Duration	Int	Void	Returns an int with the duration of the recipe
Icon	String	Void	Returns a string with the icon of the recipe
DisplayText	UniString	Void	Returns a localised string with the display text/name of the recipe
Key	String	Void	Returns a string with the key of the record
RecordList	CcoCookingRecipeRecord (list)	Void	Returns a list of all recipes from the db
IsRequiredIngredient	Bool	CcoCookingIngredientRecord	Returns true if the passed in ingredient is part of the required ingredients for this recipe
FactionLeaderEffectsContext	CcoCampaignEffectListRecord	Void	Returns a CcoCampaignEffectListRecord with the faction leader effect list of this recipe
EnemyUnitEffectsContext	CcoCampaignEffectListRecord	Void	Returns a CcoCampaignEffectListRecord with the enemy unit effect list of this recipe
AlliedUnitEffectsContext	CcoCampaignEffectListRecord	Void	Returns a CcoCampaignEffectListRecord with the allied unit effect list of this recipe
ResourceCostContext	CcoResourceCostRecord	Void	Returns a CcoResourceCostRecord with the cost of this recipe

CcoCorruptionCounterIntervalRecord

Wrapper for a CORRUPTION_COUNTER_INTERVAL_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoCorruptionCounterIntervalRecord (list)	Void	Returns a list of all intervals in the table
LowerBound	Int	Void	Returns the lower bound of the interval
UpperBound	Int	Void	Returns the upper bound of the interval
SegmentPercentage	Float	Int	Returns what percentage this interval takes out of a max value passed in
Key	String	Void	Returns the key of the record

CcoCorruptionTypeRecord

Wrapper for a CORRUPTION_TYPE_RECORD

Functions

Name	Return Type	Arguments	Description
CorruptionColour	Colour	Void	Return the colour of the corruption record
Name	UniString	Void	Return the localised name for the corruption type for display in the UI
RecordList	CcoCorruptionTypeRecord (list)	Void	Returns list of all corruption types in the db
Key	String	Void	Return the unique key for the record
BattleTileUpgradeString	String	Void	Return the tile upgrade name that gets applied as tile upgrade to battle when corruption active
IconPath	String (list)	Void	Return the optional icon path for the corruption type

CcoCultureRecord

Wrapper for a culture record

Functions

Name	Return Type	Arguments	Description
FrontendDescription	UniString	Void
UnitList	CcoUnitsCustomBattlePermissionRecord (list)	Void
GroupedUnitList	CcoGroupList (list)	Bool (optional)
StripImagePath	String	Void
StripLargeImagePath	String	Void
IsSlaanesh	Bool	Void
LargeImagePath	String	Void
IsTzeentch	Bool	Void
FramePath	String	Void
UiBackgroundImage	String	Void
RecordList	CcoCultureRecord (list)	Void
IsOgreKingdoms	Bool	Void
IsSkaven	Bool	Void
ImagePath	String	Void
Fallback	String	Void
IsLizard	Bool	Void
Name	UniString	Void
IsNurgle	Bool	Void
Key	String	Void
IsGreenskins	Bool	Void
Index	Void	Void	Not Implemented
IsKhorne	Bool	Void
GroupByCulture	Bool	Void
IsDaemon	Bool	Void
QuestBattleGroupList	CcoBattleSetPieceFrontendGroupRecord (list)	Void

CcoCustomBattleCorruptionType

Wrapper for the corruption type setting in custom battle

Functions

Name	Return Type	Arguments	Description	Tags	Events
Name	UniString	Void	Returns the localised name for the corruption type to display in the UI
RecordContext	CcoCorruptionTypeRecord	Void	Returns the record context (which can be null)

CcoCustomBattleFactionRecord

Functions

Name	Return Type	Arguments
SortOrder	Void	Void
CultureSortOrder	Void	Void
FactionContext	Void	Void
RecordList	Void	Void

CcoCustomBattleSettingRecord

Wrapper for a CUSTOM_BATTLE_SETTING_RECORD

Functions

Name	Return Type	Arguments	Description
Name	UniString	Void	Returns the name of the custom battle setting
RecordList	CcoCustomBattleSettingRecord (list)	Void	Returns a list with all custom battle settings in the db
Key	String	Void	Returns the key of the custom battle setting
Value	Float	Void	Returns the value of the custom battle setting

CcoDaemonAbilityBarDescriptionRecord

wrapper for a DAEMON_ABILITY_BAR_DESCRIPTION_RECORD

Functions

Name	Return Type	Arguments	Description
Description	UniString	Void	Returns the record's description
ContainsFaction	Bool	CcoFactionRecord	Returns true if the faction set of this record contains the passed in faction
Key	String	Void	Returns the record's key
Title	UniString	Void	Returns the record's title
RecordList	CcoDaemonAbilityBarDescriptionRecord (list)	Void	Returns a list of all Daemon ability bar description records

CcoDeployableRecord

Functions

Name	Return Type	Arguments
CanAttack	Void	Void
Name	Void	Void
DamageValue	Void	Void
Hitpoints	Void	Void
IconName	Void	Void
Key	Void	Void
CustomBattleEnabled	Void	Void
RecordList	Void	Void
IgnitionThreshold	Void	Void
Tooltip	Void	Void
Description	Void	Void
RecruitmentCap	Void	Void

CcoDeployablesCustomBattleRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
Cap	Void	Void
Probability	Void	Void
DeployableContext	Void	Void

CcoDilemmaRecord

Record wrapper for a DILEMMA_RECORD

Functions

Name	Return Type	Arguments	Description
Prioritized	Bool	Void	Returns true if this dilemma should be prioritized
SoundClickOverride	String	Void	Returns the sound click override string, if any
LocalisedDescription	UniString	Void	Returns the localised description of the dilemma
UiImage	String	Void	Returns the ui image of the dilemma
SoundPopupOverride	String	Void	Returns the sound popup override string, if any
Key	String	Void	Returns the db key of the dilemma
RecordList	CcoDilemmaRecord (list)	Void	Returns a list with all dilemma records in the database
EventCategoryContext	CcoCdirEventsCategoryRecord	Void	Returns a CcoCdirEventsCategoryRecord with the event category context
ChoiceList	CcoCdirEventsDilemmaChoiceDetailRecord (list)	Void	Returns a list of CcoCdirEventsDilemmaChoiceDetailRecord with the choices of this dilemma
LocalisedTitle	UniString	Void	Returns the localised title of the dilemma
Generate	Bool	Void	Returns true if should generate the dilemma

CcoDiplomaticStanceRecord

Functions

Name	Return Type	Arguments
StatusState	Void	Void
Stance	Void	Void
RecordList	Void	Void
Key	Void	Void
OnscreenText	Void	Void

CcoElectorCountRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
AncillaryRewardContext	Void	Void
UnitRewardContext	Void	Void
MapPosY	Void	Void
MapPos	Void	Void
MinisterialPositionEffectBundle	Void	Void
MapPosX	Void	Void
CapitalRegionContext	Void	Void

CcoEndTurnNotificationRecord

Functions

Name	Return Type	Arguments
DisplayText	Void	Void
IsRelevantToPlayersFaction	Void	Void
RecordList	Void	Void
CanBeSuppressedByPlayer	Void	Void
Blocking	Void	Void
Title	Void	Void
DetailedDescription	Void	Void
Id	Void	Void
EnabledByDefault	Void	Void
Icon	Void	Void

CcoEventFeedCategoryRecord

Record wrapper for an event feed category record

Functions

Name	Return Type	Arguments	Description
Name	UniString	Void	Returns a string from the category enum
RecordList	CcoEventFeedCategoryRecord (list)	Void	Returns a list of all CcoEventFeedCategoryRecord in the database
Key	String	Void	Returns the key of the record

CcoFactionRecord

Wrapper for a faction record

Functions

Name	Return Type	Arguments	Description
BannerSecondaryColour	Colour	Void	Returns the faction's banner secondary colour
FactionSkin	String	Void	Returns faction's skin
MechanicList	CcoEffect (list)	Void	Returns the faction's mechanics as a list of CcoEffects
Key	String	Void	Returns the key of this faction record
FactionSpecificAscendancyEffectList	CcoEffect (list)	Void	Returns the effects provided to this faction by all storm of magic ascendancy lores
PrimaryColour	Colour	Void	Returns the faction's primary colour
OwnershipProductRequirementList	CcoOwnershipProductRequirement (list)	Void	Returns the list of CcoOwnershipProductRequirement required to be owned for this faction, if it came in a DLC
ClimatesList	CcoSettlementClimateTypeRecord (list)	String, String	Returns the list of CcoSettlementClimateTypeRecord with the climate list for this faction
RecordList	CcoFactionRecord (list)	Void	Returns a list of all CcoFactionRecords
TextReplacementKeys	String (list)	Void	Returns the list of text replacement keys for this faction in order evaluated. Used to "skin" text using the ui_text_replacements table
OwnershipProductRecordList	CcoOwnershipProductRecord (list)	Void	Returns the list of CcoOwnershipProductRecord required to be owned for this faction, if it came in a DLC
FlagPathRotated	String	Void	Returns the path to the rotated version of the faction's flag
FlagDir	String	Void	Returns flag directory for this faction
FlagPathMedium	String	Void	Returns the path to the medium version of the factio'n flag
FlagPathLarge	String	Void	Returns the path to the large version of the faction's flag
MarkAsHasSeenContent	Void	Void	Marks this faction as seen content
NameWithIcon	UniString	Void	Returns the faction's name along with a small icon of their flag
FlagPathSmall	String	Void	Returns the path to the small version of the faction's flag
BannerTertiaryColour	Colour	Void	Returns the faction's banner tertiary colour
IsFactionUnlocked	Bool	Void	Returns if the faction is unlocked
AudioVoiceoverCulture	Int	Void	Returns the faction audio voiceover culture
HasSeenContent	Bool	Void	Returns true if the faction hasn't been seen by the player yet
Name	UniString	Void	Returns the faction's localised name
SubcultureContext	CcoSubcultureRecord	Void	Returns the faction's subculture context
BannerPrimaryColour	Colour	Void	Returns the faction's banner primary colour

CcoFactionSetRecord

Wrapper for a FACTION_SET_RECORD

Functions

Name	Return Type	Arguments	Description
Name	UniString	Void	Returns the name of the faction set
ContainsFaction	Bool	CcoFactionRecord	Returns true if the set contains the passed in faction record
RecordList	CcoFactionSetRecord (list)	Void	Returns a list with all faction sets in the database
Key	String	Void	Returns the key of the faction set

CcoFormationRecord

Functions

Name	Return Type	Arguments
Name	Void	Void
Tooltip	Void	Void
Order	Void	Void
IsArmy	Void	Void
IsNaval	Void	Void
Formation	Void	Void
IconName	Void	Void
RecordList	Void	Void
Description	Void	Void

CcoFrontendFactionLeaderRecord

Functions

Name	Return Type	Arguments
Name	Void	Void
DescriptionText	Void	Void
ActionPointsText	Void	Void
Key	Void	Void
ImagePath	Void	Void
HasAccessToCampaignType	Void	Void
RecordList	Void	Void
FrontendDescription	Void	Void
Voiceover	Void	Void
StartPosMap	Void	Void
StartPosDescription	Void	Void
Difficulty	Void	Void
DifficultyLocalised	Void	Void
MoviePath	Void	Void
SkillEffectList	Void	Void
LoadingScreenText	Void	Void
LoadingScreenImagePath	Void	Void

CcoGroundTypeRecord

Functions

Name	Return Type	Arguments
ColourRed	Void	Void
ColourGreen	Void	Void
OnscreenName	Void	Void
Description	Void	Void
Key	Void	Void
BurnRate	Void	Void
IgnorePenaltiesAttribute	Void	Void
RecordList	Void	Void
EffectsForSelectionList	Void	Void
IconPath	Void	Void
ColourBlue	Void	Void
MinimumThreshold	Void	Void

CcoGroundTypeToStatEffectRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
EffectText	Void	Void
EffectTextWithValue	Void	Void
AffectedGroupName	Void	Void
IsPositive	Void	Void
Value	Void	Void
ValueForDisplay	Void	Void
GroundType	Void	Void

CcoGroupPooledResourceEffectRecord

Wrapper for a campaign group pooled resource effect, which provides an effect bundle when the pooled resource is between the lower and upper bounds

Functions

Name	Return Type	Arguments	Description
UpperBound	Int	Void	Returns an int with the upper bound of this group
EffectBundle	CcoEffectBundle	Void	Returns the effect bundle that is provided by this group when the pooled resource is between the lower and upper bounds
LowerBound	Int	Void	Returns an int with the lower bound of this group
RecordList	CcoGroupPooledResourceEffectRecord (list)	Void	Returns a list with all group pooled resource effects from the table

CcoIncidentRecord

Wrapper for an incident record

Functions

Name	Return Type	Arguments	Description
HasSepiaFade	Bool	Void	Returns if the incident has a sepia fade
CampaignVOActorGroup	Int	Void	Returns the incident's campaign voice over actor group
Prioritised	Bool	Void	Returns true if this incident is prioritised
MoviePath	String	Void	Returns the incident's movie path pointed to the correct EventPic movie folder
SepiaFadeMultiplier	Float	Void	Returns the incident's sepia fade multiplier
CampaignVODelay	Float	Void	Returns the incident's campaign voice over delay
IsLargeIncident	Bool	Void	Returns if the incident is a large incident
CampaignVOEventName	String	Void	Returns the incident's campaign voice over event name
ImagePath	String	Void	Returns the incident's image path pointed to the correct EventPic image folder
Image	String	Void	Returns the ui image of this incident record
AdditionalSoundEvent	String	Void	Returns the incident's additional sound event
Description	UniString	Void	Returns the incident's localised description
ButtonText	UniString	Void	Returns the incident's localised button text
Key	String	Void	Returns the key of this incident record
EventCategory	CcoCdirEventsCategoryRecord	Void	Returns the event category of this incident if it has one assigned to it
Title	UniString	Void	Returns the incident's localised title
UseRevealingText	Bool	Void	Returns true if this incidents uses revealing text
RecordList	CcoIncidentRecord (list)	Void	Returns a list of all CcoIncidentRecord

CcoInitiativeRecord

Record wrapper for a INITIATIVE_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoInitiativeRecord (list)	Void	Returns a list of all initiatives from the database
EffectUnfilteredList	CcoEffect (list)	Void	Returns a list of all the effects provided when active
PayloadRecordList	CcoCampaignPayloadRecord (list)	Void	Returns a list of payloads for the initiative
UpkeepResourceTransactionContext	CcoCampaignResourceTransaction	Void	Returns the upkeep of the resources used while the initiative is active
EffectList	CcoEffect (list)	Void	Returns a list of the effects with priority higher than 0, that are provided when active
ExpendedResourceTransactionContext	CcoCampaignResourceTransaction	Void	Returns the resources that will be spent to activate the initiative
RequiredResourceTransactionContext	CcoCampaignResourceTransaction	Void	Returns the resources required to activate the initiative
PercentageRequirementFulfilled	Float	CcoCampaignMilitaryForce	Returns the progress of the completion in percentage
ForceMeetsUnitRequirements	Bool	CcoCampaignMilitaryForce	Returns a flag whether all the unit requirements have been met for a force
TotalCountOfRequiredUnits	Int	Void	Returns the total count of required units
TotalNumberOfRequirementsMetForForce	Int	CcoCampaignMilitaryForce	Returns the number of unit requirements met for a millitary force
Description	UniString	Void	Returns the localised description of the initiative
CooldownForPayload	Int	CcoCampaignPayloadRecord	Returns the cooldown of the paylaod
Duration	Int	Void	Returns the duration of the initiative
ImagePath	String	Void	Returns the image path of the initiative
RequiredUnits	CcoMainUnitRecord (list)	Void	Returns a list of all required units for this initiative
Name	UniString	Void	Returns the localised name of the initiative
UnitRequirements	CcoInitiativeUnitSetRequirementsRecord (list)	Void	Returns a list of all requrement records CCOs for this initiative
LinkedAgentSubtypeList	CcoAgentSubtypeRecord (list)	Void	Returns a list of agent subtypes that are linked to this initiative
Key	String	Void	Returns the key of the initiative

CcoInitiativeSetCategoryRecord

Wrapper for a INITIATIVE_SET_CATEGORY_RECORD

Functions

Name	Return Type	Arguments
RecordList	CcoInitiativeSetCategoryRecord (list)	Void
DisplayName	UniString	Void
Key	String	Void

CcoInitiativeSetRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
ActiveInitiativeLimit	Void	Void
ActivationCooldown	Void	Void
CategoryContext	Void	Void
Key	Void	Void
Items	Void	Void

CcoInitiativeUnitSetRequirementsRecord

Record wrapper for a INITIATIVE_UNIT_SET_REQUIREMENT_RECORD

Functions

Name	Return Type	Arguments	Description
RequiredNumber	Int	Void	Returns the number of required units to fulfill this requirement
UnitSetContext	CcoUnitSetRecord	Void	Returns the CCO of the unit set record this requirement is linked to
RequiredUnits	CcoMainUnitRecord (list)	Void	Returns a list of main unic records of the unit set
InitiativeContext	CcoInitiativeRecord	Void	Returns the CCO of the initiative record this requirement is linked to
DisplayName	UniString	Void	Returns localised display name, or empty if it has none
NumberOfRequirementsMetForForce	Int	CcoCampaignMilitaryForce	Returns the number of requirements met for a particular force
ForceMeetsUnitRequirements	Bool	CcoCampaignMilitaryForce	Returns the flag whether the requirements are met for this requirement CCO
IconPath	String	Void	Returns the path to an optional icon representing this requirement

CcoLabSettingRecord

Wrapper for a LAB_SETTING_RECORD

Functions

Name	Return Type	Arguments
StepSize	Float	Void
LocalisedTooltip	UniString	Void
SortOrder	Int	Void
MaxValue	Float	Void
VideoPath	String	Void
LocalisedName	UniString	Void
ImagePath	String	Void
ComparisonImagePath	String	Void
Key	String	Void
IsWindsOfMagicSetting	Bool	Void
RecordList	CcoLabSettingRecord (list)	Void
DefaultValue	Float	Void
DisplayAsPercentage	Bool	Void
MinValue	Float	Void

CcoLandUnitArticulatedVehicleRecord

Wrapper for a LAND_UNIT_ARTICULATED_VEHICLE_RECORD

Functions

Name	Return Type	Arguments
ArticulationNode3Offset	Float	Void
ArticulationNode1Radius	Float	Void
ArticulationNode2Offset	Float	Void
Key	String	Void
ArticulationNode1Offset	Float	Void
GunMountEntityContext	CcoBattleEntityRecord	Void
ArticulatedEntityContext	CcoBattleEntityRecord	Void
AmmoCaissonEntityContext	CcoBattleEntityRecord	Void
AmmoCaissionKey	String	Void
AmmoCaissonDestroyedModel	String	Void
HeadOffset	Float	Void
RecordList	CcoLandUnitArticulatedVehicleRecord (list)	Void
ArticulationNode3Radius	Float	Void
ArticulationMaxAngle	Float	Void
ArticulationNode2Radius	Float	Void

CcoLandUnitsToExtraEngineRecord

Wrapper for a LAND_UNITS_TO_EXTRA_ENGINE_RECORD

Functions

Name	Return Type	Arguments
RecordList	CcoLandUnitsToExtraEngineRecord (list)	Void
BattleEngineContext	CcoBattlefieldEngineRecord	Void
AttachArticulation	Int	Void
LandUnitContext	CcoUnitLandRecord	Void

CcoLoadingScreenQuotesRecord

Record wrapper for a loading screen quote record

Functions

Name	Return Type	Arguments	Description
HasNoImage	Bool	Void	Returns if the image path is empty
CharacterQuoteText	UniString	Void	Returns the character quote text of the loading screen quote
HasUnitImage	Bool	Void	Returns if the image path points to a unit image
Title	UniString	Void	Returns the title of the loading screen quote
ImagePath	String	Void	Returns the image path of the loading screen quote
Description	UniString	Void	Returns the long description of the loading screen quote
Key	String	Void	Returns the key of the record
BulletPointList	CcoBulletPoint (list)	Void	Returns the bullet points of the loading screen quote
RecordList	CcoLoadingScreenQuotesRecord (list)	Void	Returns a list with all loading screen quotes in the table
IsOfCharacterQuoteCategory	Bool	Void	Returns if the quote category is of character quote
HasPortraitImage	Bool	Void	Returns if the image path points to a portrait image

CcoMainUnitRecord

Wrapper for a main unit

Functions

Name	Return Type	Arguments	Description
UpgradedUnitDetailsContext	CcoUnitDetails	CcoCampaignUnit, Int (optional)	Returns a context to the unit details the provided unit would have if upgraded to this unit record
CategoryName	UniString	Void	Returns the category name of the unit
TrainCarriageCompositionList	CcoMainUnitRecord (list)	Void	Returns a list of CcoMainUnitRecords with the records that the unit is composed of, i.e. carriges for a train
DefaultProjectileRecord	CcoProjectileRecord (list)	Void	Returns a record of the default projectile for the unit (if there is one)
UsesHitpointsInCampaign	Bool	Void	Returns whether this unit uses hitpoints.
Cost	Int	Int (optional)	Returns the cost to recruit the unit
BaseCost	Int	Int (optional)	Returns the base cost to recruit the unit
UnitDetailsContext	CcoUnitDetails	Void	Returns a context to the unit details of the unit
IsRecruitmentDisabled	Bool	CcoCampaignFaction (optional)	Returns whether the recruitment is disabled for this unit. Optional pass the faction for which to check, defaults to players faction
OwnershipProductRequirementList	CcoOwnershipProductRequirement (list)	Void	Returns a list of CcoOwnershipProductRequirement for this unit
Description	UniString	Void	Returns a description of the unit
Key	String	Void	Returns the unit's key
ParentGroupSortOrder	Int	Void	Returns the sort order of the parent group that this unit record is part of
AbilityList	CcoUnitAbility (list)	Void	Returns a list of abilities for the unit
IsRenown	Bool	Void	Returns true if this is a unit of renown
BuildingUnlockTooltip	UniString	Void	Returns a tooltip with the additional requirements to unlock this unit.
IsNaval	Bool	Void	Returns true if the unit is a naval one
InfoPicPath	String	Void	Returns a path to the icon of the unit
AdditionalBuildingRequirementContext	CcoBuildingLevelRecord	Void	Returns the context of the additional building requirement for this unit, if any
ClassName	UniString	Void	Returns the class name for the unit
Name	UniString	Void	Returns the name of the unit
CategoryParentTooltip	UniString	Void	Returns the name of the parent category
SpecialAbilityGroupList	CcoSpecialAbilityGroupRecord (list)	Void	Returns a list of special abilities for the unit
RecordList	CcoMainUnitRecord (list)	Void	Return a context list of all main units
Tier	Int	Void	Returns the tier of the unit
Upkeep	Int	Void	Returns the upkeep for the unit
UnitSetUnitCapList	CcoUnitSetToMpUnitCapRecord (list)	Void	Returns list of unit sets to unit caps for the unit
IconPath	String	Void	Returns a path to the icon of the unit
HistoricalDescription	UniString	Void	Returns the historical description of the unit
UnitLandRecordContext	CcoUnitLandRecord	Void	Returns this or the base version of the mount according to unit permissions table
ShapeshiftFormContext	CcoShapeshiftForm	Void	Returns the associated CcoShapeshiftForm if there is one
BannerHp	Int	Void	Returns the banner hitpoints for the unit
CustomBattlePermissionsContext	CcoUnitsCustomBattlePermissionRecord	CcoFactionRecord (optional)	Returns a context to the battle permissions of the unit
PortholeCompositeScene	String	Void	Returns the porthole composite scene filepath used by this record if any (optional in db)
PortholeCameraSettingContext	CcoUnitPortholeCameraSettingRecord	Void	Returns a context to the unit porthole camera setting for the unit record
UnmountedUnitRecordContext	CcoMainUnitRecord	Void	Returns this or the base version of the mount according to unit permissions table
SpecialCategoryKey	String	Void	Returns the key of the special category of the unit (default if none)
CategoryTooltip	UniString	Void	Returns the tooltip text for the category of the unit
IsTrain	Bool	Void	Returns whether this unit is a train unit
UiUnitGroupContext	CcoUiUnitGroupingRecord	Void	Returns a context to the unit group of the unit
CategoryParentIcon	String	Void	Returns the name of the parent category's icon
IsVisuallyExcludedFromEffects	Bool	Void	Returns whether this unit should be hidden from effect lists by the UI
CategoryIcon	String	ExpressionState	Returns a path to the category icon of the unit
RecruitableUnitDetailsContext	CcoUnitDetails	Void	Returns a context to the unit details of the unit with predicted values a unit might be recruited with
IsOwned	Bool	Void	Returns whether this unit is owned by the player

CcoMeleeWeaponRecord

Functions

Name	Return Type	Arguments
IsMagical	Void	Void
SplashAttackMaxAttacks	Void	Void
BuildingDamageContext	Void	Void
MeleeWeaponType	Void	Void
RecordList	Void	Void
SplashAttackTargetSize	Void	Void
SplashAttackPowerMultiplierContext	Void	Void
WeaponLength	Void	Void
DamageContext	Void	Void
ApDamageContext	Void	Void
BonusVLargeContext	Void	Void
BonusVInfantryContext	Void	Void
CollisionAttackMaxTargetsCooldown	Void	Void
Key	Void	Void
ContactPhase	Void	Void
CollisionAttackMaxTargets	Void	Void
IgnitionAmount	Void	Void

CcoMercenaryRecruitmentInfoRecord

Record wrapper for a mercenary recruitment info record

Functions

Name	Return Type	Arguments	Description
OrnamentIconPath	String	Void	Returns the image path of the ornament icon of the confirmation button
ConfirmButtonIconPath	String	Void	Returns the image path of the confirm button of the mercenary recruitment info
HUDButtonIconPath	String	Void	Returns the image path of the HUD button of the mercenary recruitment info
ConfirmButtonTitle	UniString	Void	Returns the confirm button title of the mercenary recruitment info

CcoMissileWeaponRecord

Functions

Name	Return Type	Arguments
UseSecondaryAmmoPool	Void	Void
RecordList	Void	Void
Precursor	Void	Void
ProjectileContextList	Void	Void
Key	Void	Void

CcoMissionIssuerRecord

Functions

Name	Return Type	Arguments
Name	Void	Void
RecordList	Void	Void
DefaultRoundsBetween	Void	Void
IconPath	Void	Void
Key	Void	Void

CcoMissionRecord

Wrapper for a MISSION_RECORD

Functions

Name	Return Type	Arguments
TriggerRadius	Float	Void
EventCategoryContext	CcoCdirEventsCategoryRecord	Void
LocationX	Int	Void
LocalisedDescription	UniString	Void
LocalisedMissionCompletedText	UniString	Void
QuestCharacter	String	Void
LocalisedTitle	UniString	Void
LocalisedSupplementaryText	UniString	Void
LocalisedTitleKey	String	Void
BattleSetPieceRecordContext	CcoBattleSetPieceRecord	Void
UiImage	String	Void
QuestMission	Bool	Void
Key	String	Void
LocalisedDescriptionKey	String	Void
RecordList	CcoMissionRecord (list)	Void
IsQuest	Bool	Void
Prioritised	Bool	Void
StickyByDefault	Bool	Void
BaseCategoryWeight	Float	Void
Generate	Bool	Void
LocationY	Int	Void

CcoMortuaryCultCategoryRecord

Wrapper for a MORTUARY_CULT_CATEGORY_RECORD

Functions

Name	Return Type	Arguments
Key	String	Void
RecordList	CcoMortuaryCultCategoryRecord (list)	Void
LocalisedButtonDescription	UniString	Void
ShowOrder	Int	Void
LocalisedName	UniString	Void
CraftButtonText	UniString	Void
CategoryIcon	String	Void
LocalisedDescription	UniString	Void

CcoMountRecord

Functions

Name	Return Type	Arguments
Key	Void	Void
Entity	Void	Void
RecordList	Void	Void

CcoMountableArtilleryUnitsCustomBattleRecord

Functions

Name	Return Type	Arguments
Probability	Void	Void
FactionContext	Void	Void
RecordList	Void	Void
UnitRecordContext	Void	Void
Cap	Void	Void

CcoMultiplayerCampaignSettingRecord

Wrapper for a MULTIPLAYER_CAMPAIGN_SETTING_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoMultiplayerCampaignSettingRecord (list)	Void	Return a context list of all mp campaign settings, sorted in the right order
Key	String	Void	Return unique db key for setting
IsPerPlayerSetting	Bool	Void	Returns true if this setting can be set by all players (like difficulty), if false only host can set
LocalisedName	UniString	Void	Returns localised name for the setting
LocalisedTooltip	UniString	Void	Returns localised tooltip for the setting

CcoMultiplayerCampaignSettingsOptionRecord

Functions

Name	Return Type	Arguments
Tooltip	Void	Void
RecordList	Void	Void
Order	Void	Void
Value	Void	Void
MultiplayerCampaignSettingContext	Void	Void
LocalisedName	Void	Void

CcoNarrativeViewerEntryRecord

Wrapper for a NARRATIVE_VIEWER_ENTRY_RECORD

Functions

Name	Return Type	Arguments	Description
DefaultLocked	Bool	Void	Returns true if the entry is locked by default
AudioState	Int	Void	Returns the audio state used for this entry
IsCampaignVideoEntry	Bool	Void	Returns true when this entry has a valid campaign video
IsStoryIncidentEntry	Bool	Void	Returns true when this entry has a valid story incident
NarrativeViewerTabContext	CcoNarrativeViewerTabRecord	Void	Returns the CcoNarrativeViewerTabRecord associated with this entry
Sort	Int	Void	Returns the sort value used to order entries in tabs
StoryPanelIncidentContext	CcoIncidentRecord	Void	Returns the CcoIncidentRecord associated with this entry
CampaignVideoContext	CcoCampaignVideoRecord	Void	Returns the CcoCampaignVideoRecord associated with this entry
ThumbnailImagePath	String	Void	Returns the thumbnail image path from it's campaign video record or story panel incident
ScriptedValueRegistryKey	String	Void	Returns the string id which should be looked up in the registry to tell whether this entry has been unlocked
Key	String	Void	Returns the key of this NARRATIVE_VIEWER_ENTRY_RECORD
LocalisedTitle	UniString	Void	Returns the localised title from it's campaign video record or story panel incident
RecordList	CcoNarrativeViewerEntryRecord (list)	Void

CcoNarrativeViewerTabRecord

Wrapper for a NARRATIVE_VIEWER_TAB_RECORD

Functions

Name	Return Type	Arguments	Description
EntriesList	CcoNarrativeViewerEntryRecord (list)	Void	Returns a list of this tab's entries
RecordList	CcoNarrativeViewerTabRecord (list)	Void	Returns a list of all CcoNarrativeViewerTabRecords
CultureContext	CcoCultureRecord	Void	Returns the CcoCultureRecord for the tab
Sort	Int	Void	Returns the integer used to sort the tabs
OffsetX	Int	Void	Returns the offset in the x direction of the tab
Name	UniString	Void	Returns the localised name of the tab
ImagePath	String	Void	Returns the tab image path
Key	String	Void	Returns the tab key

CcoNewContentPatchNoteRecord

Functions

Name	Return Type	Arguments
Order	Void	Void
RecordList	Void	Void
LocalisedPatchNote	Void	Void
Key	Void	Void

CcoOwnershipProductRecord

Wrapper for a OWNERSHIP_PRODUCT_RECORD

Functions

Name	Return Type	Arguments	Description
SteamAppId	Int	Void	Returns the product id linked to a store front for this product
Description	UniString	Void	Returns a localised description to describe the product in the UI
Key	String	Void	Returns the unique key for this record
OpenStore	Void	Void	Opens up a store page for the product (like in steam overlay)
RecordList	CcoOwnershipProductRecord (list)	Void	Returns list of all product records
IsTwa	Bool	Void	Returns true if this product is free as part of Total War Access
IsOwned	Bool	Void	Returns true if this product is currently owned and installed (so accessible basically)
ReleaseOrder	Int	Void	Returns the release order, used to determine which order dlcs came in for sorting purposes, etc
IsFlc	Bool	Void	Returns true if this product is free

CcoPlagueComponentUiDataRecord

Wrapper for a plague component slot defined in Jade, used by the UI

Functions

Name	Return Type	Arguments
Offset	Vector4	Void
LinkedSlotsList	CcoPlagueComponentUiDataRecord (list)	Void
Id	Int	Void

CcoPlagueEffectList

A class that wraps a plague effect list together with its faction sets and target types

Functions

Name	Return Type	Arguments	Description
TargetTypeList	CcoString (list)	Void	Returns a list of valid targets in string form
FactionSetList	CcoFactionSetRecord (list)	Void	Returns a list of faction sets that the effects apply to
EffectListWithSourceList	CcoCampaignPlagueCompositionEffectList (list)	Void	Returns the list of effect lists, each with a source where they come from (if no sources are included, there will be a single list with null as source)
Name	UniString	Void	Returns the name of the effect list, including the faction sets and the taregt list (example: 'Plague effects on Nurgle armies and settlements)

CcoPlagueEffectRecord

Wrapper for a PLAGUE_EFFECT_RECORD

Functions

Name	Return Type	Arguments	Description
EffectBundleList	CcoEffectBundle (list)	Void	Returns a list of effect bundles
Key	String	Void	Returns the key of the record
EffectsAndTypeList	CcoPlagueEffectList (list)	ExpressionState, Context (optional)	Returns a list of CcoPlagueEffectList, which provide a list of effects, together with targets and faction sets specifying where the effects will apply
RecordList	CcoPlagueEffectRecord (list)	Void	Returns a list of all plague effect records in the table

CcoPlagueMutationUiDataRecord

Wrapper for a mutation type defined in Jade, used by the UI

Functions

Name	Return Type	Arguments	Description
ValueExpression	String	Void	String representation of expression used to calculate value shown in UI
TotalValueExpression	String	Void	String representation of expression used to calculate value of combined effect value shown in UI
SortOrder	Int	Void	Returns the sorting order used by the UI
LocalisedHint	UniString	Void	Localised hint to be used in the UI
LocalisedTooltip	UniString	Void	Localised tooltip to be used in the UI
MutationLevelsList	CcoCampaignPlagueIngredient (list)	CcoCampaignPlaguesCompositionSystem (optional)	Returns each of the mutation levels

CcoPlagueParameterRecord

Wrapper for a PLAGUE_PARAMETER_RECORD

Functions

Name	Return Type	Arguments
InfectionDuration	Int	Void
InfectionChanceReductionPostSpreadUnary	Float	Void
MinimumInfectionChanceUnary	Float	Void
RecordList	CcoPlagueParameterRecord (list)	Void
RegionToRegionInfectionChanceUnary	Float	Void
ForceToRegionInfectionChanceUnary	Float	Void
RegionToForceInfectionChanceUnary	Float	Void
ForceToForceBattleInfectionChanceUnary	Float	Void
ForceToForceInfectionChanceUnary	Float	Void
SpreadCountMax	Int	Void
ImmunityDuration	Int	Void
Key	String	Void

CcoPlagueRecord

Wrapper for a PLAGUE_RECORD

Functions

Name	Return Type	Arguments	Description
Lifetime	Int	Void	Returns the lifetime of the plague
SortOrder	Int	Void	Returns the lifetime of the plague
ImagePath	String	Void	Returns the image path of the plague
Key	String	Void	Returns the key of the plague record
RecordList	CcoPlagueRecord (list)	Void	Returns a list with all plague records in the table

CcoPlagueSpecialCompositionRecord

Wrapper for a PLAGUE_SPECIAL_COMPOSITION_RECORD

Functions

Name	Return Type	Arguments	Description
Key	String	Void	Returns the key of the record
AwardedIngredientContext	CcoCampaignPlagueIngredient	Void	Returns the component that will be awarded when using the components from the plague composition
RecordList	CcoPlagueSpecialCompositionRecord (list)	Void	Returns a list with all compositions in the table
FactionPlagueCompositionContext	CcoCampaignPlagueComposition	CcoCampaignFaction	Returns the plague composition for the given faction

CcoPooledResourceThresholdOperationSetRecord

Wrapper for a pooled_resource_threshold_operation_set_record

Functions

Name	Return Type	Arguments	Description
UnlocksUnit	Bool	CcoMainUnitRecord	Returns true if any of the operation sets unlock the passed in unit
UnlocksAgent	Bool	CcoAgentRecord	Returns true if any of the operation sets unlock the passed in agent
ChooseOperationSet	Void	CcoCampaignFaction, CcoCampaignOperationSetRecord	Chooses the passed in operation set
ActiveOperationSetList	CcoCampaignOperationSetRecord (list)	CcoCampaignFaction	Returns the operation set record that has been selected for this threshold, if any
RecordList	CcoPooledResourceThresholdOperationSetRecord (list)	Void	Returns a list with all records in the table
UpperBound	Int	Void	Returns the upper bound, which is used for the exit operations
CampaignOperationSetList	CcoCampaignOperationSetRecord (list)	Void	Returns a list of operation sets in this threshold
PooledResourceList	CcoCampaignPooledResource (list)	CcoCampaignFaction (optional)	Returns the pooled resource from the faction passed in, which sets the bounds of the operations. If no faction gets passed in, default to player faction
Key	String	Void	Returns the key of the record
LowerBound	Int	Void	Returns the lower bound, which is used for the enter operations
IsGrantedByAchievement	Bool	Void	Returns true if this operation set is granted by unlocking an achievement
IsLockedByAchievement	Bool	Void	Returns true if this operation set is currently locked by an achievement

CcoProjectileBombardmentRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
RadiusSpread	Void	Void
NumProjectiles	Void	Void
Key	Void	Void
ProjectileContext	Void	Void

CcoProjectileRecord

Cco wrapper for querying a projectile record

Functions

Name	Return Type	Arguments	Description
ExplosiveApDamageContext	CcoUnitStat	Void	Gets CcoUnitStat for the projectile explosive armour piercing damage context
DamageContext	CcoUnitStat	Void	Gets CcoUnitStat for the projectile damage
ExplosiveArmourPiercingPercentage	Int	Void	Returns the calculated explosive armour piercing value as a percentage
ApDamageContext	CcoUnitStat	Void	Gets CcoUnitStat for the projectile armour piercing damage
ShotsPerVolley	Int	Void
IconPath	String	Void	Returns a path for the associated icon for this projectile
TotalProjectilesPerReload	Int	Void
ArmourPiercingPercentage	Int	Void	Returns the calculated armour piercing value as a percentage
EffectiveRangeContext	CcoUnitStat	Void	Gets CcoUnitStat for the effective range of the projectile
NumProjectiles	Int	Void	The number of projectiles associated with this projectile record
ShotTypeKey	String	Void
Name	UniString	Void	Returns a string for the onscreen name of the projectile
BurstSize	Int	Void
Tooltip	UniString	Void	Returns a string of the associated tooltip text for this projectile
IsMagical	Bool	Void	Returns whether the projectile inflicts magical damage
RecordList	CcoProjectileRecord (list)	Void
IsFlaming	Bool	Void	Returns whether the projectile inflicts flaming damage
Key	String	Void
ContactPhaseContext	CcoSpecialAbilityPhaseRecord	Void	Gets the CcoSpecialAbilityPhaseRecord for the effect of contact with the projectile
OverheadPhaseContext	CcoSpecialAbilityPhaseRecord	Void	Gets the CcoSpecialAbilityPhaseRecord for the effect of the projectile flying overhead
BonusVsLargeContext	CcoUnitStat	Void	Gets CcoUnitStat for the projectile bonus vs large units
CanDamageBuildings	Bool	Void
BaseReloadTimeContext	CcoUnitStat	Void	Gets CcoUnitStat for the projectile base reload time
BonusVsInfantryContext	CcoUnitStat	Void	Gets CcoUnitStat for the projectile bonus vs infantry
ExplosiveDamageContext	CcoUnitStat	Void	Gets CcoUnitStat for the projectile explosive damage

CcoProphecyOfSotekStageRecord

Wrapper for a PROPHECY_OF_SOTEK_STAGE_RECORD

Functions

Name	Return Type	Arguments
LocalisedDescription	UniString	Void
EffectBundleContext	CcoEffectBundle	Void
TooltipType	String	Void
RecordList	CcoProphecyOfSotekStageRecord (list)	Void
Order	Int	Void
Stage	String	Void
LocalisedName	UniString	Void

CcoProphecyOfSotekStagesToMissionRecord

Wrapper for a PROPHECY_OF_SOTEK_STAGES_TO_MISSION_RECORD

Functions

Name	Return Type	Arguments
Order	Int	Void
RecordList	CcoProphecyOfSotekStagesToMissionRecord (list)	Void
StageContext	CcoProphecyOfSotekStageRecord	Void
MissionContext	CcoMissionRecord	Void

CcoProvinceAutomanagementFocusRecord

Wrapper for a PROVINCE_AUTOMANAGEMENT_FOCUS_RECORD

Functions

Name	Return Type	Arguments	Description
Description	UniString	Void	Return the localised description of the focus
RecordList	CcoProvinceAutomanagementFocusRecord (list)	Void	Returns a list with all focus records in the table
Key	String	Void	Returns the key of the record
Name	UniString	Void	Return the localised name of the focus

CcoProvinceInitiativeRecord

Functions

Name	Return Type	Arguments
Order	Void	Void
EffectBundleContext	Void	Void
Key	Void	Void
EffectBundleContextForCurrentProvince	Void	Void
RecordList	Void	Void
IconPath	Void	Void
StatusForCurrentProvince	Void	Void
LocalisedName	Void	Void

CcoRegionGroupRecord

Wrapper for a REGION_GROUP_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoRegionGroupRecord (list)	Void	Returns a list of all CcoRegionGroupRecords
ZoomToGroupAtHeight	Void	Float	Moves the camera to the average position of regions in the group and zooms it to the desired amount
OrderSortedRegionRecordsList	CcoRegionRecord (list)	Void	Returns a list of CcoRegionGroups linked to this region group
Key	String	Void	Returns the key of the region group
LocalisedName	UniString	Void	Returns the localised name of the region group

CcoRegionRecord

Wrapper for a REGION_RECORD

Functions

Name	Return Type	Arguments	Description
OwnerEffectBundleList	CcoEffectBundle (list)	Void	Returns a list of CcoEffectBundle with the owner bundle effects
FactionSwappingId	String	Void	Returns a string with the faction swapping id of the region
SettlementContext	CcoCampaignSettlement	Void	Returns a CcoCampaignSettlement with the settlement context of this region
OnscreenNameKey	String	Void	Returns a string with the onscreen name key of the region
BattleNameKey	String	Void	Returns a string with the battle name key of the region
Key	String	Void	Returns a string with the key of the region
RecordList	CcoRegionRecord (list)	Void	Returns a list of all regions in the database
RegionGroupsList	CcoRegionGroupRecord (list)	Void	Returns a list of CcoRegionGroupRecords that this region is part of

CcoReignOfChaosRecord

Wrapper for a REIGN_OF_CHAOS_RECORD

Functions

Name	Return Type	Arguments	Description
ArmyAbility	CcoUnitAbility	Void	Returns the CcoUnitAbility associated with this record
Tier	Int	Void	Returns the tier of this effect
GodType	String	Void	Returns a string key for the god type associated with this record
Name	UniString	Void	Returns the name of the outcome
Description	UniString	Void	Returns the description of the outcome's effects
RecordList	CcoReignOfChaosRecord (list)	Void	Returns a list of reign of chaos records

CcoResourceCostRecord

Functions

Name	Return Type	Arguments
RequiredAncillariesList	Void	Void
PooledResourceCostsList	Void	Void
ExpenditureType	Void	Void
RequiredTradeResourcesList	Void	Void
TreasuryCost	Void	Void
IncomeType	Void	Void
Id	Void	Void
RecordList	Void	Void

CcoResourceRecord

Functions

Name	Return Type	Arguments
StrategicValue	Void	Void
Description	Void	Void
RecordList	Void	Void
TradeValue	Void	Void
IconFilepath	Void	Void
UnitNamePlural	Void	Void
PricePerUnit	Void	Void
HasUnitName	Void	Void
UnitNameSingular	Void	Void
Key	Void	Void
OnscreenText	Void	Void

CcoRitualCategoryGroupRecord

Wrapper for a RITUAL_CATEGORY_GROUP_RECORD

Functions

Name	Return Type	Arguments
Key	String	Void
RecordList	CcoRitualCategoryGroupRecord (list)	Void
DisplayName	UniString	Void
SortOrder	Int	Void
CategoryList	CcoRitualCategoryRecord (list)	Void

CcoRitualCategoryRecord

Wrapper for a RITUAL_CATEGORY_RECORD

Functions

Name	Return Type	Arguments
Id	String	Void
RitualListForManager	CcoCampaignRitual (list)	CcoCampaignRitualManager
RecordList	CcoRitualCategoryRecord (list)	Void
SortOrder	Int	Void
DisplayName	UniString	Void
GroupContext	CcoRitualCategoryGroupRecord	Void
Category	String	Void
IconPath	String	Void

CcoRitualChainRecord

Wrapper for a RITUAL_CHAIN_RECORD

Functions

Name	Return Type	Arguments
SortOrder	Int	Void
Colour	Colour	Void
DisplayName	UniString	Void
RitualSitesRequired	Int	Void
RitualsList	CcoRitualRecord (list)	Void
CategoryContext	CcoRitualCategoryRecord	Void
Description	UniString	Void
Key	String	Void
RecordList	CcoRitualChainRecord (list)	Void

CcoRitualPayloadAncillaryRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
Payload	Void	Void
AncillaryContext	Void	Void

CcoRitualPayloadChangeAgentCapacityRecord

Functions

Name	Return Type	Arguments
Capacity	Void	Void
RecordList	Void	Void
AgentRecordContext	Void	Void
PayloadContext	Void	Void

CcoRitualPayloadChangeUnitAllowanceCapacityRecord

Wrapper for a RITUAL_PAYLOAD_CHANGE_UNIT_CAPACITY_RECORD

Functions

Name	Return Type	Arguments
Capacity	Int	Void
RecordList	CcoRitualPayloadChangeUnitAllowanceCapacityRecord (list)	Void
PayloadContext	CcoRitualPayloadRecord	Void
UnitListRecordContext	CcoUnitListRecord	Void

CcoRitualPayloadChangeUnitCapacityRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
PayloadContext	Void	Void
UnitRecordContext	Void	Void
Capacity	Void	Void

CcoRitualPayloadDiplomaticAttitudeChangeRecord

Functions

Name	Return Type	Arguments
AttitudeDelta	Void	Void
RecordList	Void	Void
Payload	Void	Void

CcoRitualPayloadRecord

Wrapper for a ritual payload record

Functions

Name	Return Type	Arguments	Description
AncillariesList	CcoRitualPayloadAncillaryRecord (list)	Void	Returns a list of ancillaries that this payload will provide
MercenarySpawnsList	CcoRitualPayloadSpawnMercenaryRecord (list)	Void	Returns a list of mercenaries that the payload will spawn
CampaignPayloadContext	CcoCampaignPayloadRecord	Void	Returns the campaign payload that will activate with this ritual payload, if valid
AgentSpawnsList	CcoRitualPayloadSpawnAgentRecord (list)	Void	Returns a list of agents that the payload will spawn
ArmySpawnsList	CcoRitualPayloadSpawnArmyRecord (list)	Void	Returns a list of armies that the payload will spawn
DilemmaContext	CcoRitualPayloadTriggerDilemmaRecord	Void	Returns a CcoRitualPayloadTriggerDilemmaRecord with the context of the dilemma that this payload will trigger, if any
ConfederatedFactionsList	CcoCampaignFaction (list)	Void	Returns a list with factions that will be confederated by this payload
DiplomaticAttitudeChangeContext	CcoRitualPayloadDiplomaticAttitudeChangeRecord	Void	Returns a CcoRitualPayloadDiplomaticAttitudeChangeRecord with the diplomatic attitude that this payload will change
UnitAllowanceCapList	CcoRitualPayloadChangeUnitAllowanceCapacityRecord (list)	Void	Returns a list with unit allowance caps affected by this payload
AgentCapList	CcoRitualPayloadChangeAgentCapacityRecord (list)	Void	Returns a list with agent caps affected by this payload
HumanOnly	Bool	Void	Returns true if the payload only applies to human factions
UnitCapUnitList	CcoRitualPayloadChangeUnitCapacityRecord (list)	Void	Returns a list with unit caps affected by this payload
Key	String	Void	Returns the key of the payload record
RecordList	CcoRitualPayloadRecord (list)	Void	Returns a list with all payload records in the database
ArmyTeleportList	CcoRitualPayloadTeleportArmyRecord (list)	Void	Returns a list of CcoRitualPayloadTeleportArmyRecord
StormSpawnsList	CcoRitualPayloadSpawnStormRecord (list)	Void	Returns a list of storms that this payload will spawn
EffectBundleList	CcoEffectBundle (list)	Void	Returns a list of effect bundles that this payload will provide
EffectBundleAndDurationPairList	CcoPair (list)	Void	Returns a list of effect bundles and their duration that this payload will provide
ResourceTransactionsList	CcoResourceCostRecord (list)	Void	Returns a list of resource transactions that this payload will apply

CcoRitualPayloadSpawnAgentRecord

Functions

Name	Return Type	Arguments
SpawnToPool	Void	Void
RecordList	Void	Void
AgentTypeContext	Void	Void
AgentSubtypeContext	Void	Void
Payload	Void	Void

CcoRitualPayloadSpawnArmyRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
FactionOverrideContext	Void	Void
SpawnAtRitualSite	Void	Void
SpawnableForceContext	Void	Void
Id	Void	Void
Payload	Void	Void

CcoRitualPayloadSpawnMercenaryRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
SpawnableUnitContext	Void	Void
Id	Void	Void
Payload	Void	Void

CcoRitualPayloadSpawnStormRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
RegionContext	Void	Void
MaxTurnsDuration	Void	Void
StormTypeContext	Void	Void
Payload	Void	Void
Strength	Void	Void

CcoRitualPayloadTeleportArmyRecord

Wrapper for a RITUAL_PAYLOAD_TELEPORT_ARMY_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoRitualPayloadTeleportArmyRecord (list)	Void	Returns a list of all teleport payloads in the database
PayloadContext	CcoRitualPayloadRecord	Void	Returns a CcoRitualPayloadRecord with the payload context
RegionContext	CcoRegionRecord	Void	Returns a CcoRegionRecord with the region record where the army will teleport to

CcoRitualPayloadTriggerDilemmaRecord

Functions

Name	Return Type	Arguments
DilemmaContext	Void	Void
RecordList	Void	Void
Payload	Void	Void

CcoRitualRecord

Record wrapper for a RITUAL_RECORD

Functions

Name	Return Type	Arguments	Description
FailureCooldownTime	Int	Void	Returns the cooldown time of the ritual after failing to perform
CategoryContext	CcoRitualCategoryRecord	Void	Returns a CcoRitualCategoryRecord with the category the ritual is part of
SpawnedMilitaryForceType	UniString	Void	The display name without the first part (only the actual name)
ResourceTransactionContext	CcoCampaignResourceTransaction	Void	Returns the base resource cost of the ritual
SlaveCost	Int	Void	Returns the amount of slaves needed to perform this ritual
DisplayName	UniString	Void	Returns the localised name of the ritual
StartPayloadContext	CcoRitualPayloadRecord	Void	Returns a CcoRitualPayloadRecord with the payload that gets applied at the start of the ritual
AdditionalExplanationText	UniString	Void	Returns the additional ui explanation text of the ritual
CompletionPayloadContext	CcoRitualPayloadRecord	Void	Returns a CcoRitualPayloadRecord with the payload that gets applied at the completion of the ritual
Category	String	Void	Returns a string with the category the ritual is part of
CompletionPayloadEffectBundleList	CcoEffectBundle (list)	Void	Returns a list of effect bundles that get applied at the completion of the ritual
Description	UniString	Void	Returns the localised description of the ritual
ActiveEffectList	CcoEffect (list)	Void	Returns a list of effects that are applied while the ritual is active
Key	String	Void	Returns the key of the ritual
RecordList	CcoRitualRecord (list)	Void	Returns a list with all ritual records from the database
Icon	String	Void	Returns the icon path of the ritual
StartPayloadEffectBundleList	CcoEffectBundle (list)	Void	Returns a list of effect bundles that get applied at the start of the ritual
Interruptable	Bool	Void	Returns true if the ritual can be interrupted
DelayPayloadApplication	Bool	Void	Returns true if payload application is delayed for this ritual
SortOrder	Int	Void	Returns the sort order of the ritual
Hostile	Bool	Void	Returns true if the ritual is hostile
CastTime	Int	Void	Returns the cast time of the ritual
CooldownTime	Int	Void	Returns the cooldown time until the ritual can be performed again
TargetCategoryCooldown	Int	Void	Returns the cooldown of the ritual category
GlobalCooldownTime	Int	Void	Returns the cooldown time of the ritual among all campaign faction

CcoSeasonRecord

Functions

Name	Return Type	Arguments
Key	Void	Void
Onscreen	Void	Void
RecordList	Void	Void

CcoSettlementClimateTypeRecord

Functions

Name	Return Type	Arguments
UiBackgroundImage	Void	Void
Type	Void	Void
RecordList	Void	Void
UiName	Void	Void
UiDescription	Void	Void
UiIconImage	Void	Void

CcoSpawnableForceRecord

Functions

Name	Return Type	Arguments
Key	Void	Void
RecordList	Void	Void
UnitsList	Void	Void
UnitListsList	Void	Void

CcoSpawnableForceUnitJunctionRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
MinAmount	Void	Void
MinXp	Void	Void
MaxAmount	Void	Void
MaxXp	Void	Void
SpawnableForce	Void	Void
UnitContext	Void	Void
Id	Void	Void

CcoSpawnableForceUnitListJunctionRecord

Functions

Name	Return Type	Arguments
UnitListContext	Void	Void
RecordList	Void	Void
MinAmount	Void	Void
MinXp	Void	Void
Id	Void	Void
MaxAmount	Void	Void
MaxXp	Void	Void
SpawnableForce	Void	Void

CcoSpecialAbilityGroupRecord

Wrapper for a SPECIAL_ABILITY_GROUP_RECORD record from special_ability_groups_tables

Functions

Name	Return Type	Arguments	Description
SortOrder	Int	Void	Returns the sort order for ability groups
ButtonIconPath	String	Void	Returns the icon path to use specifically for buttons on the UI
Name	UniString	Void	Returns the localised name to use for the ability group
Key	String	Void	Returns the db key
IconPath	String	Void	Returns the icon path for UI
RecordList	CcoSpecialAbilityGroupRecord (list)	Void	Returns the list of all CcoSpecialAbilityGroupRecord in the special_ability_groups_table
ParentLoreContext	CcoSpecialAbilityGroupRecord	Void	Returns the CcoSpecialAbilityGroupRecord context for our parent lore if we are a child (sub) lore, such as a specific vampires vampiric lore
AscendancyPhaseRecord	CcoSpecialAbilityPhaseRecord	Void	Returns the the phase record for the current Storm of Magic ascendancy, which contains the effects and attributes lists
CataclysmAbility	CcoUnitAbility	Void	Returns the the cataclysm CcoUnitAbility for the Storm of Magic ascendancy
AbilityList	CcoUnitSpecialAbilityRecord (list)	Void	Returns the list of CcoUnitSpecialAbilityRecord in this ability group
IsRunicLore	Bool	Void	Returns true if this is a runic lore
IsCompositeGroup	Bool	Void	Returns true if this is a group that consists of abilities from other groups (special cases where some units have mix of lores)
IsSkavenLore	Bool	Void	Returns true if this is one of the three skaven lores
ButtonName	String	Void	Returns the state name for use on buttons
Colour	Colour	Void	Returns the colour for this ability group

CcoSpecialAbilityIntensitySettingRecord

Wrapper for a SPECIAL_ABILITY_INTENSITY_SETTING_RECORD

Functions

Name	Return Type	Arguments
RecordList	CcoSpecialAbilityIntensitySettingRecord (list)	Void
IntensityType	String	Void
HasConstantIntensity	Bool	Void
MaxIntensity	Float	Void
Inverse	Bool	Void
UpdatesOnlyWhenAbilityActive	Bool	Void
DefaultAmount	Float	Void
MaxAmount	Float	Void
AbilityRecordContext	CcoUnitSpecialAbilityRecord	Void

CcoSpecialAbilityPhaseRecord

Wrapper for a SPECIAL_ABILITY_PHASE_RECORD

Functions

Name	Return Type	Arguments	Description
HealPercent	Float	Void	Percentage of targets max HP will heal for each HpChangeFrequency (0-1), (so if phase lasts 10 seconds and HpChangeFrequency is 2, then will heal this amount 5 times)
EffectList	CcoEffect (list)	ExpressionState, Float (optional)	Returns a list of CcoEffect so can see effects of phase
RemoveMagical	Bool	Void	Returns true if this removes magical attacks on the target
Intensity	Float	ExpressionState	Returns the ability intensity value
FatigueChangeRatio	Float	Void	Returns the multiplier applies to fatigue (for freezing fatigue or tiring a unit out)
PhaseEffectFlagList	CcoStringValue (list)	Void	Returns a list of CcoStringValues for the phase effect flags (special case things like freeze fatigue)
AmmunitionReplenishment	Float	Void	Returns the ammunition replenishment this phase gives. positive value replenish ammunition, negative value destroys ammunition
InspirationAuraRangeMod	Float	Void	Returns the modifier applies to inspiration aura of a unit
Resurrect	Bool	Void	Returns true if this resurrects a unit
ManaMaxDepletionMod	Float	Void	Returns the modifier to the maxa max depletion
IntensifiedRangeValueText	UniString	ExpressionState, Float, UniString, Float	Takes unintensified value and a float formatter then returns the range value of label as string (e.g if we have intensity as 0.4f and max is 1, then we pass 8 and %f. It will format float into value fields with (1.6 - 3.2) and (4 - 8))
HasUnitAttributes	Bool	Void	Returns true if this phase provides unit attributes
IntensifiedRangeIntValueText	UniString	ExpressionState, Int, UniString, Float	Takes unintensified value and an int formatter then returns the range value of label as string (e.g if we have intensity as 0.4f and max is 1, then we pass 10 and %d. It will format int into value fields with (2 - 4) and (5 - 10))
SpreadRange	Int	Void	Returns the range the effect can spread like a contagion if this is set to a non-zero value
RemovesAttribute	Bool	CcoUnitAttributeRecord	Returns true if this phase removes provided unit attribute, e.g. removes causes fear attribute on Whip of Agony
MaxDamagedEntities	Int	Void	Returns the max number of entities that can be damaged by this phase
HasManaRegenMod	Bool	Void	Returns true if regenerates mana
IntensifiedIntValueText	UniString	ExpressionState, Int, UniString	Takes unintensified value and an int formatter then returns the value of label as string (e.g if we have intensity as 0.4f and max is 1, then we pass 10 and %d. It will format int into value fields with 4 and 10)
ManaRegenMod	Float	Void	Returns the modifier to mana regeneration
HasManaMaxDepletionMod	Bool	Void	Returns true if this depletes mana
HasEffects	Bool	Void	Returns true if this phase has effects
DamageAmount	Int	Void	Returns the record wrapped damage amount
IconPath	String	Void	Returns icon path to use in UI icons representing the phase
HasBarrierHealAmount	Bool	Void	Returns true if this phase heals barrier
OnscreenName	UniString	Void	Returns the localised name to display on the UI
DamagePerSecond	Int	Void	Returns the calculated damage per second amount
HasDamageAmount	Bool	Void	Returns true if this phase deals damage
IntensifiedValueText	UniString	ExpressionState, Float, UniString	Takes unintensified value and a float formatter then returns the value of label as string (e.g if we have intensity as 0.4f and max intensity is 1, then we pass 8 and %f. It will format float into value fields with 3.2f and 8)
HasAbilityRechargeChange	Bool	Void	Returns true if this phase affects recharge
Key	String	Void	Returns the db key of the phase record
HpChangeFrequency	Int	Void	Returns how often applys HealPercent to target
Damage	Int	Void	Returns the calculated overall damage amount
EffectType	String	Void	Returns string for positive, negative or both
HasHealAmount	Bool	Void	Returns true if this phase heals
AdditionalUiEffectList	CcoUnitAbilitiesAdditionalUiEffectRecord (list)	Void	Returns the additional ui effect list of this phase
AffectsAllies	Bool	Void	Returns true if this phase affects allies
Duration	Int	Void	Returns the duration in seconds that this phase lasts
ImbueContactContext	CcoSpecialAbilityPhaseRecord	Void	Returns the CcoSpecialAbilityPhaseRecord for the effect imbued to the target
AffectsEnemies	Bool	Void	Returns true if this phase affects enemies
MoraleChange	Int	Void	Returns the modifier to morale
UnitAttributeList	CcoUnitAttributeRecord (list)	Void	Returns a list of CcoUnitAttributeRecord provided by phase
ImbueIgnition	Bool	Void	Returns true if this imbues a units attack with flaming attack bonuses
TotalHealPercent	Float	Void	Percentage of targets max HP will heal after all HpChangeFrequency ticks, (so if phase lasts 10 seconds and HpChangeFrequency is 1 and HealPercent is 0.01, then will heal 10%)
IsHiddenInUi	Bool	Void	Returns true if this phase should NOT be displayed in the UI
RecordList	CcoSpecialAbilityPhaseRecord (list)	Void	Returns list of all CcoSpecialAbilityPhaseRecord in db table special_ability_phases_table
TotalBarrierHealPercent	Float	Void	Percentage of targets max barrier HP will heal after all HpChangeFrequency ticks, (so if phase lasts 10 seconds and HpChangeFrequency is 1 and HealPercent is 0.01, then will heal 10%)
HasAmmunitionReplenishment	Bool	Void	Returns true if this phase replenish or destroy ammunition. positive value replenish ammunition, negative value destroys ammunition
AbilityRechargeChange	Float	Void	Returns the modifier applied to recharge times of abilities
AbilityPhaseEffectsList	CcoSpecialAbilityPhaseStatEffectRecord (list)	Void	Returns a list of CcoSpecialAbilityPhaseStatEffectRecord so know what stats affected by phase
ImbueMagical	Bool	Void	Returns true if this imbues a units attack with magic attack bonuses

CcoSpecialAbilityPhaseStatEffectRecord

Functions

Name	Return Type	Arguments
How	Void	Void
RecordList	Void	Void
Phase	Void	Void
Value	Void	Void
Stat	Void	Void

CcoSubcultureRecord

Wrapper for a subculture record

Functions

Name	Return Type	Arguments	Description
RecordList	CcoSubcultureRecord (list)	Void
ConfederationSummaryName	UniString	Void
BattlePlaystyleDescription	UniString	Void
Name	UniString	Void
ConfederationScreenName	UniString	Void
Culture	CcoCultureRecord	Void
Index	Int	Void
Key	String	Void
ArmyAbilityList	CcoArmySpecialAbilityRecord (list)	Void	Returns list of CcoArmySpecialAbilityRecord where each faction in custom battle with this culture has this army ability (so race army abilities)

CcoTechnologyRecord

Record wrapper for a technology record

Functions

Name	Return Type	Arguments	Description
IsHidden	Bool	Void	Returns true if this technology should be hidden in the technology screen
RecordList	CcoTechnologyRecord (list)	Void	Returns a list with all technologies in the table
ShortDescription	UniString	Void	Returns the short description of the technology
LongDescription	UniString	Void	Returns the long description of the technology
Key	String	Void	Returns the key of the record
OnscreenName	UniString	Void	Returns the localised name of the technology

CcoTechnologyUiGroupRecord

Record wrapper for technology ui group record

Functions

Name	Return Type	Arguments	Description
RightMostTechnology	CcoCampaignTechnology	CcoCampaignFaction (optional)	Returns the context of the right-most technology for this group
BottomMostTechnology	CcoCampaignTechnology	CcoCampaignFaction (optional)	Returns the context of the bottom-most technology for this group
LeftMostTechnology	CcoCampaignTechnology	CcoCampaignFaction (optional)	Returns the context of the left-most technology for this group
RecordList	CcoTechnologyUiGroupRecord (list)	Void	Returns a list with all technology ui groups in the table
TopMostTechnology	CcoCampaignTechnology	CcoCampaignFaction (optional)	Returns the context of the top-most technology for this group
Name	UniString	Void	Returns the localised name of this group, if any
Description	UniString	Void	Returns the localised description of this group, if any
BackgroundImage	String	Void	Returns the background image for this group
Key	String	Void	Returns the key of this record
Colour	Colour	Void	Returns the colour of the group
ChildAndLinkPositionsList	CcoPair (list)	Void	Returns a list of CcoPair, where each pair has a CcoTechnologyUiGroupRecord and a VECTOR_4 with link positions

CcoTechnologyUiTabRecord

Wrapper for a TECHNOLOGY_UI_TAB_RECORD

Functions

Name	Return Type	Arguments
SortOrder	Int	Void
TierOffset	Int	Void
RecordList	CcoTechnologyUiTabRecord (list)	Void
LocalisedName	UniString	Void
TooltipString	UniString	Void
Key	String	Void

CcoTeleportationNetworkNodeRecord

Wrapper for a TELEPORTATION_NETWORK_NODE_RECORD

Functions

Name	Return Type	Arguments	Description
OwningFactionContext	CcoCampaignFaction	Void	Returns a CcoCampaignFaction of the faction that own the region where the node is positioned
RecordList	CcoTeleportationNetworkNodeRecord (list)	Void	Returns a list with all records in the database
TravelTime	Int	Void	Returns the time it takes to travel to this node
Position	Vector4	Void	Returns the display position of the node
ProvinceContext	CcoCampaignProvince	Void	Returns a CcoCampaignProvince of the province in which the teleport node is positioned
TeleportationTemplateContext	CcoTeleportationNodeTemplateRecord	Void	Returns the context of the teleportation template that the node is part of, if any
HandleDoubleClick	Void	Void	Handles a double click event
Key	String	Void	Returns the key of the record
EffectList	CcoEffect (list)	Void	Returns a list with the effects the node provides, will be an empty list if the node is closed

CcoTeleportationNodeTemplateRecord

Wrapper for a TELEPORTATION_NODE_TEMPLATE_RECORD

Functions

Name	Return Type	Arguments	Description
Key	String	Void	Returns the key of the record
RecordList	CcoTeleportationNodeTemplateRecord (list)	Void	Returns a list of all templates in the table
EffectList	CcoEffect (list)	Void	Returns a list of effects that the teleportation nodes from this template provide
Closable	Bool	Void	Returns true if the teleportation nodes in this template can be closed by the player
ShouldDisplayTimer	Bool	Void	Returns true if the teleportation nodes using this template display timer
Name	UniString	Void	Returns the localised name of the template
Description	UniString	Void	Returns the localised description of the template
IconPath	String	Void	Returns the image path of the template
Layout	String	Void	Returns the layout name of the template

CcoTimeOfLegendsCampaignRecord

Wrapper for a TIME_OF_LEGENDS_CAMPAIGN_RECORD

Functions

Name	Return Type	Arguments
RecordList	CcoTimeOfLegendsCampaignRecord (list)	Void
LocalisedTitle	UniString	Void
ImagePath	String	Void
LocalisedDescription	UniString	Void
Key	String	Void
CampaignMap	String	Void

CcoTreasureHuntExtraInformationRecord

Functions

Name	Return Type	Arguments
Option1Image	Void	Void
OverlayImage	Void	Void
Option4Image	Void	Void
ColourBlindModeOverlay	Void	Void
Option2Image	Void	Void
Option3Image	Void	Void
Key	Void	Void

CcoUiColourRecord

Functions

Name	Return Type	Arguments
SetCustomColour	Void	Void
Colour	Void	Void
ShowInUied	Void	Void
CanPlayerSet	Void	Void
Description	Void	Void
PlayerDescription	Void	Void
Blue	Void	Void
Type	Void	Void
Red	Void	Void
Green	Void	Void
Key	Void	Void
RecordList	Void	Void

CcoUiMainThemeOptionRecord

Wrapper for a UI_MAIN_THEME_OPTION_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoUiMainThemeOptionRecord (list)	Void	Return list of CcoUiMainThemeOptionRecords in the database
Colour	Colour	Void	Returns the colour for the main theme
FullscreenBackgroundColour	Colour	Void	Returns the colour used by fullscreen background images for the main theme
TooltipText	UniString	Void	Returns the tooltip text for the main theme
MainTheme	String	Void	Returns the key of the main theme record
MainThemeName	UniString	Void	Returns the display name for the main theme

CcoUiPurchasableEffectsToHexIdRecord

Functions

Name	Return Type	Arguments
Tier	Void	Void
RecordList	Void	Void
HexId	Void	Void
Category	Void	Void
UnitPurchasableEffectContext	Void	Void

CcoUiUnitGroupParentRecord

Functions

Name	Return Type	Arguments
GroupList	Void	Void
RecordList	Void	Void
MpCap	Void	Void
UnitList	Void	Void
Icon	Void	Void
Key	Void	Void
Order	Void	Void
OnscreenName	Void	Void

CcoUiUnitGroupingRecord

Functions

Name	Return Type	Arguments
Icon	Void	Void
Key	Void	Void
Tooltip	Void	Void
ParentGroup	Void	Void
RecordList	Void	Void
Onscreen	Void	Void

CcoUiUnitStatRecord

Wrapper for a UI_UNIT_STAT_RECORD

Functions

Name	Return Type	Arguments	Description
MinValue	Int	Void	Returns the min value permitted for this stat
SortOrder	Int	Void	Returns the integer used to sort stats (Lower is higher priority)
TooltipText	UniString	Void	Returns the localised tooltip text for the stat
IconPath	String	Void	Returns the icon path associated with the stat
Key	String	Void	Returns the key of the stat
Name	UniString	Void	Returns the localised name of the stat (Sometimes with a leading image)
PreviewAiStatModifierString	String	Float	Returns a string with the modifier the ai would receive from the passed in float.
RecordList	CcoUiUnitStatRecord (list)	Void	Returns a list of all CcoUiUnitStatRecords
ClampDisplayedMinimum	Bool	Void	Returns whether the value should be clamped when below the minimum
ClampDisplayedMaximum	Bool	Void	Returns whether the value should be clamped when above the maximum
MaxValue	Int	Void	Returns the max value permitted for this stat

CcoUiUnitStatusRecord

Functions

Name	Return Type	Arguments
Key	Void	Void
Priority	Void	Void
RecordList	Void	Void
Tooltip	Void	Void
IconPath	Void	Void

CcoUnitAbilitiesAdditionalUiEffectRecord

Wrapper for a UNIT_ABILITIES_ADDITIONAL_UI_EFFECT_RECORD

Functions

Name	Return Type	Arguments
Key	String	Void
SortOrder	Int	Void
EffectState	String	Void
RecordList	CcoUnitAbilitiesAdditionalUiEffectRecord (list)	Void
LocalisedText	UniString	Void

CcoUnitAbilityRecord

Functions

Name	Return Type	Arguments
IconName	Void	Void
Key	Void	Void
RequiresEffectEnabling	Void	Void
IconPathSmall	Void	Void
RecordList	Void	Void
IconPath	Void	Void
VideoName	Void	Void
IsUnitUpgrade	Void	Void
IsHiddenInUi	Void	Void
TooltipText	Void	Void

CcoUnitAbilityTypeRecord

Wrapper for a UNIT_ABILITY_TYPE_RECORD

Functions

Name	Return Type	Arguments	Description
RecordList	CcoUnitAbilityTypeRecord (list)	Void	Returns all CcoUnitAbilityTypeRecords
IconPath	String	Void	Returns the icon path for this ability type
ShowCursorTrail	Bool	Void	Returns whether a cursor trail should be shown
Name	UniString	Void	Returns the localised name of this ability type
Description	UniString	Void	Returns the localised description of this ability type (Used in tooltips)
Key	String	Void	Returns the key of the ability type record

CcoUnitAttributeRecord

Functions

Name	Return Type	Arguments
IconPath	Void	Void
ImuedEffectText	Void	Void
RemovesEffectText	Void	Void
Key	Void	Void
RecordList	Void	Void
BulletText	Void	Void

CcoUnitLandRecord

Wrapper for a UNIT_LAND_RECORD

Functions

Name	Return Type	Arguments
Accuracy	Int	Void
DamageModMissile	Int	Void
BonusHitPoints	Int	Void
BattlePersonalities	Void	Void
Key	String	Void
DamageModFlame	Int	Void
PrimaryMeleeWeaponContext	CcoMeleeWeaponRecord	Void
FactionsUnitVariants	Void	Void
PrimaryMissileWeaponContext	CcoMissileWeaponRecord	Void
DamageModMagic	Int	Void
SelectionVOSecondary	Void	Void
SecondaryAmmo	Int	Void
OnScreenName	UniString	Void
SelectionVOTertiary	Void	Void
OnScreenNameKey	String	Void
PrimaryAmmo	Int	Void
EngineRecordContext	CcoBattlefieldEngineRecord	Void
NumMounts	Int	Void
SpotDistScrub	Float	Void
SelectionVOPrimary	Void	Void
ConcealedName	UniString	Void
HidingScalar	Float	Void
ManEntityContext	CcoBattleEntityRecord	Void
ExtraEnginesList	CcoLandUnitsToExtraEngineRecord (list)	Void
VisibilitySpottingRangeMax	Float	Void
MountRecordContext	CcoMountRecord	Void
SpotDistTree	Float	Void
IsMale	Bool	Void
SyncLocomotion	Bool	Void
CampaignActionPoints	Int	Void
VisibilitySpottingRangeMin	Float	Void
RecordList	CcoUnitLandRecord (list)	Void
ManAnimationsTable	String	Void
CanBrace	Bool	Void
Morale	Int	Void
NumEngines	Int	Void
IsCamels	Bool	Void
MountedDraughts	Bool	Void
Reload	Int	Void
DamageModAll	Int	Void
ChargeBonus	Int	Void
MeleeAttack	Int	Void
TrainingLevel	Void	Void
CanSkirmish	Bool	Void
MeleeDefence	Int	Void
ArticulatedRecordContext	CcoLandUnitArticulatedVehicleRecord	Void
RankDepth	Int	Void
DamageModPhysical	Int	Void

CcoUnitListRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
Key	Void	Void
UnitsList	Void	Void

CcoUnitPortholeCameraSettingRecord

Wrapper for a UNIT_PORTHOLE_CAMERA_SETTING_RECORD

Functions

Name	Return Type	Arguments	Description
Fov	Float	Void	Returns camera fov in degrees
Phi	Float	Void	Returns camera phi in degrees
EnvironmentFile	String	Void	Returns the environment filepath to use
Distance	Float	Void	Returns camera distance
Key	String	Void	Returns the db records unique key
RecordList	CcoUnitPortholeCameraSettingRecord (list)	Void	Returns list of all records of this type
Theta	Float	Void	Returns camera theta in degrees
Target	Vector4	Void	Returns x,y,z,0 of camera target

CcoUnitPurchasableEffectRecord

Functions

Name	Return Type	Arguments
RecordList	Void	Void
ResourceIcon	Void	Void
EffectBundleContext	Void	Void
CategoryContext	Void	Void
ResourceCost	Void	Void
ResourceName	Void	Void
Key	Void	Void
CostContext	Void	Void

CcoUnitPurchasableEffectsCategoryRecord

Functions

Name	Return Type	Arguments
IconPath	Void	Void
Key	Void	Void
OnscreenName	Void	Void
OnscreenDescription	Void	Void
RecordList	Void	Void

CcoUnitSetRecord

Wrapper for a UNIT_SET_RECORD

Functions

Name	Return Type	Arguments
DevCcoStringObjectId	CcoString	Void
MaxUnitExpLevelInclusive	Int	Void
RecordList	CcoUnitSetRecord (list)	Void
UseUnitExpLevelRange	Bool	Void
MinUnitExpLevelInclusive	Int	Void
UnitsInSetList	CcoMainUnitRecord (list)	Void
SpecialEditionMask	Void	Void

CcoUnitSetToMpUnitCapRecord

Wrapper for a UNIT_SET_TO_MP_UNIT_CAP_RECORD

Functions

Name	Return Type	Arguments
Cap	Int	Void
RecordList	CcoUnitSetToMpUnitCapRecord (list)	Void
LocalisedName	UniString	Void

CcoUnitSpecialAbilityRecord

Functions

Name	Return Type	Arguments
TargetGroundUnderAllies	Void	Void
OverpowerOptionContext	Void	Void
TargetEnemies	Void	Void
BasicOptionAbilityContext	Void	Void
BaseRecordContext	Void	Void
UnitAbilityContext	Void	Void
ActivatedProjectileContext	Void	Void
RecordList	Void	Void
TargetFriends	Void	Void
UpdateTargetsEveryFrame	Void	Void
MiscastGlobalBonus	Void	Void
InitialRecharge	Void	Void
TargetSelf	Void	Void
NumEffectedFriendlyUnits	Void	Void
ParentAbilityKey	Void	Void
NumEffectedEnemyUnits	Void	Void
IsMurderousProwess	Void	Void
AlwaysAffectSelf	Void	Void
AdditionalMeleeCp	Void	Void
OnlyAffectTarget	Void	Void
AdditionalMissileCp	Void	Void
IsPassive	Void	Void
MinRange	Void	Void
AffectSelf	Void	Void
MiscastChance	Void	Void
RechargeTime	Void	Void
TargetGroundUnderEnemies	Void	Void
WindUpTime	Void	Void
TargetInterceptRange	Void	Void
EffectRange	Void	Void
ManaCost	Void	Void
TargetGround	Void	Void
NumUses	Void	Void
ActiveTime	Void	Void

CcoUnitsCustomBattleMountRecord

Functions

Name	Return Type	Arguments
Cost	Void	Void
RecordList	Void	Void
MountName	Void	Void
IconName	Void	Void
LocalisedDescription	Void	Void
BaseUnitContext	Void	Void
MountedUnitContext	Void	Void

CcoUnitsCustomBattlePermissionRecord

Functions

Name	Return Type	Arguments
ArmoryItemList	Void	Void
GeneralPortrait	Void	Void
SetPieceCharacterContext	Void	Void
SiegeUnitAttacker	Void	Void
SiegeUnitDefender	Void	Void
IsGeneralUnit	Void	Void
UnitContext	Void	Void
UnitDetailsContext	Void	Void
FactionContext	Void	Void
HasCustomBattleUpgrades	Void	Void
RecordList	Void	Void
Cost	Void	Void
IconPath	Void	Void

CcoUnitsCustomBattleTypeCategoryRecord

Wrapper for a UNITS_CUSTOM_BATTLE_TYPE_CATEGORY_RECORD

Functions

Name	Return Type	Arguments
IsHorizontalGroup	Bool	Void
RecordList	CcoUnitsCustomBattleTypeCategoryRecord (list)	Void
CategoryName	UniString	Void
CategoryKey	String	Void
CategoryDescription	UniString	Void

CcoUnitsCustomBattleTypeRecord

Wrapper for a UNITS_CUSTOM_BATTLE_TYPE_RECORD

Functions

Name	Return Type	Arguments
Colour	Colour	Void
TypeCategoryContext	CcoUnitsCustomBattleTypeCategoryRecord	Void
TypeIcon	String	Void
RootTypeContext	CcoUnitsCustomBattleTypeRecord	Void
AlternateUnitContext	CcoMainUnitRecord	Void
BaseUnitContext	CcoMainUnitRecord	Void
SortOrder	Int	Void
RecordList	CcoUnitsCustomBattleTypeRecord (list)	Void
CategoryTypeName	UniString	Void
LocalisedDescription	UniString	Void

CcoVictoryConditionRecord

Functions

Name	Return Type	Arguments	Description	Tags	Events
Key	Void	Void
RecordList	Void	Void

CcoVideoRecord

Functions

Name	Return Type	Arguments
PlayVideo	Void	Void
RecordList	Void	Void
Key	Void	Void

Common

CcoAdvisor

Functions

Name	Return Type	Arguments	Description	Tags	Events
AdviceHistoryList	Void	Void
ClearHistory	Void	Void

CcoAgentSubtypeAgentPair

Functions

Name	Return Type	Arguments
AgentContext	CcoAgentRecord	Void
UnitDetailsContext	CcoUnitDetails	Void
AgentSubtypeContext	CcoAgentSubtypeRecord	Void

CcoBattleResult

Wrapper for a battle result

Functions

Name	Return Type	Arguments
IsDraw	Bool	Void
ResultTypeRecordContext	CcoBattleResultTypeRecord	Void
OtherResultAllianceContext	CcoBattleResultAlliance	Void
IsLocalPlayerWinner	Bool	Void
LocalResultPlayerAllianceContext	CcoBattleResultAlliance	Void
Duration	UniString	Void

CcoBattleResultAlliance

Functions

Name	Return Type	Arguments
ResultName	Void	Void
ResultType	Void	Void
ArmyContext	Void	Void
ArmyList	Void	Void

CcoBattleResultArmy

Functions

Name	Return Type	Arguments
FactionFlagDir	Void	Void
NumEntities	Void	Void
NumEntitiesInitial	Void	Void
SetupArmyContext	Void	Void
GeneralsName	Void	Void
PlayerName	Void	Void
IsHuman	Void	Void
FactionRecordContext	Void	Void
UnitList	Void	Void
FactionName	Void	Void

CcoBattleResultUnit

Wrapper for a battle result unit

Functions

Name	Return Type	Arguments	Description
ImagePath	String	ExpressionState	Path to the unit card image for the unit
DidRout	Bool	Void	Returns true if the unit routed during the battle
DidLeaveBattlefield	Bool	Void	Returns true if the unit left the battle (a shameful display)
DamageDealtCost	Int	Void	Gold value of the damage dealt by the unit
HealthPercent	Float	Void	Percentage health remaining for the unit
IsCommander	Bool	Void	Returns true if the unit is a commander
ExperienceLevel	Int	Void	Experience level of the unit
DamageDealt	Int	Void	Damage dealt by the unit
NumHitPoints	Int	Void	Number of hitpoints post result
NumHitPointsInitial	Int	Void	Number of hitpoints before result
NumEntities	Int	Void	Number of entities post result
Name	UniString	Void	Localised name of the unit
NumEntitiesInitial	Int	Void	Initial number of entities before result
UnitRecordContext	CcoMainUnitRecord	Void	Returns a CcoMainUnitRecord context for the unit
NumKills	Int	Void	Number of kills the unit got in the result
NumKillsFriendlies	Int	Void	Number of friendly kills the unit got in the result

CcoCallbackExpressionStore

A class representing a one-to-one relationship between a component and one of its callbacks.

Functions

Name	Return Type	Arguments	Description	Tags	Events
ValueList	ContextList	Void	Returns a list of all the expression values stored for this callback-component pair.	ui, debug

CcoCampaignEffectGroup

Functions

Name	Return Type	Arguments	Description	Tags	Events
EffectList	Void	Void
LocalisedTitle	Void	Void

CcoCampaignFactionMercenaryPool

Component context wrapper for a faction mercenary pool

Functions

Name	Return Type	Arguments	Description
MercenaryPoolUnitList	CcoCampaignMercenaryPoolUnit (list)	Void	Returns the list of available mercenary pool units
CanRecruitUnitForFaction	Bool	CcoCampaignFaction, CcoCampaignMercenaryPoolUnit	Returns if the unit can be recruited from the pool for a faction
MercenaryPoolSizeFilteredByFaction	Int	CcoCampaignFaction	Returns the size of the list of available mercenary pool units filtered by faction
IsProvidingMercenaryUnitForFaction	Bool	CcoCampaignFaction	Returns if the mercenary pool provides any unit for the given faction
MercenaryPoolSize	Int	Void	Returns the size of the list of available mercenary pool units

CcoCampaignMercenaryPoolUnit

Component context wrapper for a mercenary pool unit

Functions

Name	Return Type	Arguments	Description
HasInfiniteUnitCount	Bool	Void	Returns if the mercenary pool unit has infinite amount available
AvailableUnitCount	Int	Void	Returns the available mercenary pool unit count
CurrentMaxUnitCount	Int	Void	Returns the max mercenary pool unit count
MainUnitRecordContext	CcoMainUnitRecord	Void	Returns the main unit record of this mercenary pool unit

CcoCampaignModelBuilding

Model safe context wrapper for a campaign building

Functions

Name	Return Type	Arguments	Description
Region	CcoCampaignModelRegion	Void	Region that contains this building
Province	CcoCampaignModelProvince	Void	Province that contains this building
ChainRecordKey	String	Void	Database record key of the building chain this building belongs to
Owner	CcoCampaignModelFaction	Void	Faction that owns this building and the region
RecordKey	String	Void	Database record key of this building

CcoCampaignModelFaction

Model safe context wrapper for a campaign faction

Functions

Name	Return Type	Arguments	Description
IsRitualActive	Bool	String	Returns true if ritual for ritual key is currently active
ModelPooledResourceContext	CcoCampaignModelPooledResource	String	Model pooled resource context for given key, if valid
IsCampaignFeatureAvailable	Bool	String	Test if specific campaign feature is available
IsEffectBundleActive	Bool	String	Test if specific effect bundle is active on the faction
IsInFactionSet	Bool	String	Test if the faction is contained in the specified faction set
IsTechnologyResearched	Bool	String	Test if tech for given tech key is researched or not
CultureIsOneOf	Bool	ArgumentPack	Test if the culture key is one of the specified list. Can accept any number of culture keys
SubcultureIsOneOf	Bool	ArgumentPack	Test if the subculture key is one of the specified list. Can accept any number of subculture keys
IsRogueFaction	Bool	Void	Is this faction a rogue faction?
RecordKeyIsOneOf	Bool	ArgumentPack	Test if the faction key is one of the specified list. Can accept any number of faction keys
CultureKey	String	Void	Database record key of this factions culture
SubcultureKey	String	Void	Database record key of this factions subculture
Treasury	Int	Void	Current treasury balance
UnitCapForUnit	Int	String	Unit cap for main unit record key. -1 if uncapped or not valid
IsOwnershipProductUnlocked	Bool	String	Checks if ownership product is unlocked for a faction
InitiativeManagerContext	CcoCampaignModelInitiativeManager	Void	Faction level initiative manager context
RecordKey	String	Void	Database record key of this faction

CcoCampaignModelInitiative

Initiative wrapper safe to use in campaign model contexts

Functions

Name	Return Type	Arguments	Description	Tags	Events
IsActive	Bool	Void	Test if initiative is active
Key	String	Void	Db key of the initiative

CcoCampaignModelInitiativeManager

Cco wrapper for a initiative manager, safe to use in campaign model contexts

Functions

Name	Return Type	Arguments	Description
OwnedSets	CcoCampaignModelInitiativeSet (list)	Void	List of owned initiative sets
InitiativeSetContext	CcoCampaignModelInitiativeSet	String	Initiative set context for given key if valid
FactionContext	CcoCampaignModelFaction	Void	Owning faction of the manager

CcoCampaignModelInitiativeSet

Initiative set wrapper safe to use in campaign model contexts

Functions

Name	Return Type	Arguments	Description	Tags	Events
InitiativeContext	CcoCampaignModelInitiative	String	Initiative context for given key, if valid
ActiveInitiatives	CcoCampaignModelInitiative (list)	Void	List of active initiatives in set

CcoCampaignModelMilitaryForce

Model safe context wrapper for a campaign military force

Functions

Name	Return Type	Arguments	Description	Tags	Events
CanMoveInCurrentStance	Bool	Void	Returns whether the military force can move in the current stance

CcoCampaignModelPooledResource

Campaign model wrapper for a pooled resource

Functions

Name	Return Type	Arguments	Description
Total	Int	Void	Current total of this resource
PercentageOfCapacity	Float	Void	Percentage towards full capacity for this resource
Min	Int	Void	Minimum bound of this resource
Max	Int	Void	Maximum bound of this resource

CcoCampaignModelProvince

Model safe context wrapper for a campaign province

Functions

Name	Return Type	Arguments	Description
RecordKey	String	Void	Database record key of this province
Regions	CcoCampaignModelRegion (list)	Void	Regions contained in this province
IsEnemyOfFactionMilitaryForcePresent	Bool	CcoCampaignModelFaction	Test if a military force that is an enemy of the specified faction is present in the province
IsFactionMilitaryForcePresent	Bool	CcoCampaignModelFaction	Test if a military force belonging to the specified faction is present in the province
IsEnemyOfFactionAgentSubtypePresent	Bool	String, CcoCampaignModelFaction	Test if the a character of the specified agent subtype, owned by an enemy of the specified faction, is present in the province
IsAnyMilitaryForcePresent	Bool	Void	Test if any military force is present in the province
IsFactionAgentSubtypePresent	Bool	String, CcoCampaignModelFaction	Test if the a character of the specified agent subtype, owned by the specified faction, is present in the province
IsEnemyOfFactionAgentPresent	Bool	String, CcoCampaignModelFaction	Test if the a character of the specified agent type, owned by an enemy of the specified faction, is present in the province
IsFactionAgentPresent	Bool	String, CcoCampaignModelFaction	Test if the a character of the specified agent type, owned by the specified faction, is present in the province
IsAgentPresent	Bool	String	Test if any character of the specified agent type is present in the province
IsAgentSubtypePresent	Bool	String	Test if any character of the specified agent subtype is present in the province
FactionRegions	CcoCampaignModelRegion (list)	CcoCampaignModelFaction	Regions contained in this province, owned by the specified faction
IsFactionOwnerOfEntireProvince	Bool	CcoCampaignModelFaction	Does the specified faction own the entire province?

CcoCampaignModelRegion

Model safe context wrapper for a campaign region

Functions

Name	Return Type	Arguments	Description
Owner	CcoCampaignModelFaction	Void	Returns the faction that owns this region. May be rebel if abandoned or following a successful rebellion
BelongsToRegionGroup	Bool	String	Returns true if the region belongs to the region group with the passed in key
Growth	Int	Void	Amount of growth accumulated towards the next development point. This value will be the same for every region owned by the faction in this province
ClimateKey	String	Void	Returns the key of the climate of the settlement attached to this region
IsHomeRegion	Bool	Void	Is this the factions home region?
IsEffectBundleActive	Bool	String	Test if specific effect bundle is active in the region
PublicOrder	Int	Void	Public order balance for this turn. This value will be the same for every region owned by the faction in this province
RecordKey	String	Void	Returns the record key of this region
NextTurnPublicOrder	Int	Void	Public order balance for next turn. This value will be the same for every region owned by the faction in this province
Province	CcoCampaignModelProvince	Void	Province that contains this region
IsAbandoned	Bool	Void	Returns true if the region is abandoned
IsAnyOwnAgentPresent	Bool	CcoCampaignModelFaction (optional)	Test if any agent owned by the local faction is present in the region
IsFactionAgentPresent	Bool	String, CcoCampaignModelFaction	Test if the specified agent type is present in the region and owned by the specified faction
IsOwnMilitaryForcePresent	Bool	CcoCampaignModelFaction (optional)	Test if any military force owned by the local faction is present in the region
IsFactionAgentSubtypePresent	Bool	String, CcoCampaignModelFaction	Test if the specified agent subtype is present in the region and owned by the specified faction
IsOwnAgentPresent	Bool	String, CcoCampaignModelFaction (optional)	Test if the specified agent type is present in the region and owned by the local faction
IsAnyEnemyAgentPresent	Bool	CcoCampaignModelFaction (optional)	Test if any enemy agent is present in the region
IsAnyEnemyMilitaryForcePresent	Bool	CcoCampaignModelFaction (optional)	Test if any enemy military force is present in the region
IsOwnAgentSubtypePresent	Bool	String, CcoCampaignModelFaction (optional)	Test if the specified agent subtype is present in the region and owned by the local faction
IsAnyAgentPresent	Bool	Void	Test if any agent is present in the region
IsEnemyAgentSubtypePresent	Bool	String, CcoCampaignModelFaction (optional)	Test if the specified agent subtype is present in the region and owned by an enemy faction
IsAnyMilitaryForcePresent	Bool	Void	Test if any force is present in the region
WindsOfMagicStrengthLevel	Int	Void	Currently active winds of magic strength level for the region
IsAgentSubtypePresent	Bool	String	Test if the specified agent subtype is present in the region
WindsOfMagicStrengthKey	String	Void	Record key of the currently active winds of magic strength level for the region
IsEnemyAgentPresent	Bool	String, CcoCampaignModelFaction (optional)	Test if the specified agent type is present in the region and owned by an enemy faction
GDP	Int	Void	GDP (income) that this Region generates. Cannot be negative
RecordKeyIsOneOf	Bool	ArgumentPack	Test if the region key is one of the specified list. Can accept any number of region keys
FactionProvinceGDP	Int	Void	GDP (income) that the owning faction generates from all of its regions in the province
IsAgentPresent	Bool	String	Test if the specified agent type is present in the region
GrowthPerTurn	Int	Void	Amount of growth accumulated per-turn. This value will be the same for every region owned by the faction in this province
OriginatingSubcultureKey	String	Void	Returns the record key of the originating subculture of this region
DevelopmentPoints	Int	Void	Amount of development points accumulated and unspent. This value will be the same for every region owned by the faction in this province
IsOriginatingSubcultureOneOf	Bool	ArgumentPack	Test if the originating subculture key is one of the specified list. Can accept any number of subculture keys
PublicOrderChangePerTurn	Int	Void	Amount that public order is currently changing per-turn. This value will be the same for every region owned by the faction in this province

CcoCampaignModelRoot

Model safe context wrapper for the campaign root, allows access to other model ccos from context viewer for example

Functions

Name	Return Type	Arguments	Description	Tags	Events
IsMultiplayer	Bool	Void	Returns if it's a multiplayer game
CampaignKey	String	Void	Returns the campaign key for this campaign

CcoCampaignModelUnit

Model safe context wrapper for a campaign unit

Functions

Name	Return Type	Arguments	Description	Tags	Events
OwningFactionContext	CcoCampaignModelFaction	Void	Context of the unit's faction
ExperienceLevel	Int	Void	Current level of the unit

CcoCampaignProvinceMercenaryPool

Component context wrapper for a province mercenary pool

Functions

Name	Return Type	Arguments	Description
IsProvidingMercenaryUnitForFaction	Bool	CcoCampaignFaction	Returns if the mercenary pool provides any unit for the given faction
MercenaryPoolSize	Int	Void	Returns the size of the list of available mercenary pool units
MercenaryPoolSizeFilteredByFaction	Int	CcoCampaignFaction	Returns the size of the list of available mercenary pool units filtered by faction
MercenaryPoolUnitList	CcoCampaignMercenaryPoolUnit (list)	Void	Returns the list of available mercenary pool units
CanRecruitUnitForFaction	Bool	CcoCampaignFaction, CcoCampaignMercenaryPoolUnit	Returns if the unit can be recruited from the pool for a faction

CcoCampaignStartInfo

Wrapper for frontend campaign start info

Functions

Name	Return Type	Arguments	Description
CultureList	CcoCultureRecord (list)	Void	Returns a list of CcoCultureRecords with the cultures from this campaign
VictoryDescriptionText	UniString	Void	Returns the localised victory description of the campaign which describes how to obtain victory
StartDate	Int	Void	Returns an int with the start date of the campaign
Name	UniString	Void	Returns the localised name of the campaign
DescriptionText	UniString	Void	Returns the localised description of the campaign
CampaignMapPlayableAreaRecordContext	CcoCampaignMapPlayableAreaRecord	Void	Returns a CcoCampaignMapPlayableAreaRecord with the playable area record for this campaign
TimeOfLegendsCampaignRecordContext	CcoTimeOfLegendsCampaignRecord	Void	Returns the CcoTimeOfLegendsCampaignRecord for this campaign, if any (only used in a subset of mp campaigns)
Key	String	Void	Returns a string with the campaign key
GenerateMapOverlayForFaction	Void	ExpressionState, CcoFactionRecord	Generates overlay for supplied faction and sets up component called on
CharacterList	CcoFrontendFactionLeaderRecord (list)	Void	Returns a list of CcoFrontendFactionLeaderRecord with faction leaders that are part of this campaign
LordForFaction	CcoFrontendFactionLeader	CcoFactionRecord, Int	Returns a CcoFrontendFactionLeader for the specified CcoFactionRecord if one exists
IsResumed	Bool	Void	Returns true if the campaign is resumed
OwnedLordListForFaction	CcoFrontendFactionLeader (list)	CcoCultureRecord	Returns a list of CcoFrontendFactionLeaders for a passed in culture that the player owns
MechanicListForCulture	CcoEffect (list)	CcoCultureRecord	Returns a list of effects that describe the unique traits of the passed in culture
OwnedCultureList	CcoCultureRecord (list)	Void	Returns a list of CcoCultureRecord for this campaign that the player owns
LordListForFaction	CcoFrontendFactionLeader (list)	CcoCultureRecord	Returns a list of CcoFrontendFactionLeaders for a passed in culture
FactionList	CcoFactionRecord (list)	Void	Returns a list of CcoFactionRecords with the factions in this campaign

CcoCharacterSpecialUnitAvailability

Component context wrapper for a character special units availability

Functions

Name	Return Type	Arguments	Description	Tags	Events
UnitDetailsContext	CcoUnitDetails	Void	Returns the CcoUnitDetails
IsLocked	Bool	Void	Returns true if the character special unit is locked

CcoClickHoldContext

Functions

Name	Return Type	Arguments	Description	Tags	Events
HoldPercent	Float	Void	Returns the percentage hold value

CcoComponent

Functions

Name	Return Type	Arguments	Description	Tags
NumChildren	Int	Void	Returns number of children
SpineContext	CcoSpineController	Void	Returns a CcoSpineController context for the component if it has a spine controller
ChildContext	CcoComponent	String	Returns the child with the id specified (essentially does a find from this component, so child doesnt have to be direct children of us but can be a child of a child)
SetDockPoint	Void	String	Sets the dock point using specified string key (tl, tc, tr, cl, c, cr, bl, bc, tle, tce, tre, cle, ce, cre, ble, bce, bre)
AnimationList	String	Void	Returns a list of the animations on the component as a string
FindWithPredicate	CcoComponent (list)	ExpressionState, Expression	Returns a list of every child component matching the passed predicate.
ToggleVisibility	Void	Void	Toggles the visibility of the component
RelativePosition	Vector4	Void	Returns the relative position of the component
ExportLayoutToXML	Void	Void	Exports the entire layout that the current component is in to an xml located in working_data/UI/GameLayoutExports	debug, hide_in_uied
ClearContext	Void	String, Bool	Clears specified context type, and propagates if specified
CustomTooltipClear	Void	Void	Clears any tooltip created with CustomTooltipCreate	debug, hide_in_uied
ChildCountPropagated	Int	Void	Returns the number of children recursively (so number of our children, and childrens children, and so forth)
ImageList	String	Void	Returns list of all image paths as string with each path on new line
ExportComponentAndChildrenToXML	Void	Void	Exports the current component and its children to an xml located in working_data/UI/GameLayoutExports	debug, hide_in_uied
EnableDebugDisplay	Void	Bool	Enables/disables debug display which helps to visualise the bounds of this component and any additional debug info	debug, hide_in_uied
ChildList	CcoComponent (list)	Void	Returns list of all children
SetState	Bool	String	Sets the state of the component to the supplied state
Dimensions	Vector4	Void	Returns the current dimensions of the component
ShortcutKeyText	UniString (list)	Void	Returns a string that represents the tooltip text for the component
Resize	Void	Int, Int, Bool (optional)	Resizes this component to the specified size
IsPriorityLocked	Bool	Void	Returns true if this components priority is lower than the current priority lock, meaning this component cannot be interacted with
ContextHistoryList	ContextList	Void	Allows to view the history of what contexts have been present on a component and where they originated from, useful for debugging flow of contexts	debug, hide_in_uied
DockOffset	Vector4	Void	Returns the dock offset of the component
IsDebugDisplayEnabled	Bool	Void	Checks if there is currently an active debug display for the component	debug, hide_in_uied
CurrentPriorityLocker	CcoComponent	Void	Returns the CcoComponent that is the current priority lock
CopyFullPathToClipboard	Void	Void	Returns the components path from the root so can see all the parent ids that lead to this component	debug, hide_in_uied
TemplatePath	String	Void	Returns the template layout path this component is authored from if any
StateList	String	Void	Returns the list of state names as a string
ToggleDebugDisplay	Void	Void	Toggles debug display which helps to visualise the bounds of this component and any additional debug info	debug, hide_in_uied
Id	String	Void	Returns the id of the component	ui
CopyDebugGuidToClipboard	Void	Void	Copies the debug guid to clipboard so can set conditional breakpoints easily	debug, hide_in_uied
CustomTooltipCreate	Void	Void	If this component has a custom tooltip layout, this command will create that layout and pin it allowing you to inspect it	debug, hide_in_uied
ForceUpdateContextDisplay	Void	Void	Forces the ContextCallback::UpdateDisplay call to hit, which is very handy for debugging combined with conditional breakpoints	debug, hide_in_uied
PropagateContext	Void	Context	Sets the context on a component (including children) using a specified context object given as a parameter
MemoryAddress	String	Void	Returns the memory address of this component	debug, hide_in_uied
SelectInActiveUiEd	Void	Void	If UiEd is open, this will open the layout this component is authored in and select it	debug, hide_in_uied
StartDragging	Void	Void	Will pin component to follow cursor until next left click. Primarily added for dev purposes so can find components easily and workaround overlap issues
IsParentOf	Bool	CcoComponent	Returns true if the component is a parent of the other component passed.
GetProperty	String	String	Returns the value of the specified user property key
IsActiveFocus	Bool	Void	Returns true if this component is the current focus (for example if a text input typing into)
SortChildren	Void	ExpressionState, Bool, Expression	Sorts children using the provided expression
Trash	Void	Void	Destroys this component
CopyMemoryAddressToClipboard	Void	Void	Copies the memory address of this component so that it can be used in conditional breakpoints	debug, hide_in_uied
Priority	Int	Void	Returns the priority of the component
SetCallbackProperty	Void	String, String, String	Sets the specified property key and value on the specified callback id
Position	Vector4	Void	Returns the absolute position of the component
LastScriptCallLocation	String	Void	Returns last location in script that did anything to the component which is useful when investigating functionality/issues	debug, hide_in_uied
NumVisibleChildren	Int	Void	Returns the number of visible children
ToggleHighlight	Void	Void	Toggles a highlighting effect on the component to make it easier to find	debug, hide_in_uied
CurrentTextLocalisationStrings	String	Void	Returns the localisation string sources for the component text
SetContextFromId	Void	String	Sets the context on a component using a specified context object id (type + objectid) to get it from the cache
SoundCategory	String	Void	Returns the sound category of the component	sound
IsCreatedFromScript	Bool	Void	Returns true if this component was created from script
SetImage	Void	Int, String	Sets image using specified image index and filepath
IsMouseOverChildren	Bool	Void	Returns true if the mouse is currently over this component or its children
LayoutPath	String	Void	Returns the layout path so know which layout this component is authored in
SetContext	Void	Context	Sets the context on a component only (not children) using a specified context object given as a parameter
CurrentTooltipLocalisationStrings	String	Void	Returns the localisation string sources for the component tooltip
IsInteractive	Bool	Void	Returns true if the component is currently interactive
SetText	Void	UniString	Sets the current text on the component
IsDisabled	Bool	Void	Returns true if the component is currently disabled
PropertyExists	Bool	String	Returns true if the specified property key exists
SimulateLClick	Void	Void	Simulates a left click on the component
IsVisible	Bool	Void	Returns true if visible property is set (can be true if this is visible but not parent)
StoredContextRequired	Context	String	Returns the stored context with the specified type id and will assert if it fails
CurrentText	UniString	Void	Returns the current text for the component
ListLayoutContext	CcoListLayout	Void	Returns list engine tied to the component if valid
ChildIndex	Int	Void	Returns the index we are in our parents child list
SetVisible	Void	Bool	Sets the visibility of the component based on specified bool
SetIsTopmostObject	Void	Bool	Sets a component to be a topmost object, meaning it will render on top of everything else
StoredContextRequiredFromParent	Context	String	Returns the stored context with the specified type id on any of our parents, and will assert if it fails
CurrentTooltip	UniString	Void	Returns the current tooltip for the component
IsVisibleFromRoot	Bool	Void	Returns true if visible and all parents to root are visible (meaning it can actually be seen by player if in the bounds of the screen and not occluded)
GetAnimationFrameProperty	Vector4	String, Int, String	Gets the values set for a given animation property on a specific frame of an animation on this component.
WarningList	CcoUiWarning (list)	Bool (optional)	Returns list of warnings of potential issues with this component
RotateImage	Void	Int, Float	Rotates the specified image index by the specified angle in degrees
IsMouseOver	Bool	Void	Returns true if the mouse is currently over this component
SetProperty	Void	String, String	Sets a property on the component using the supplied key and value
GuidOriginalDebugID	String	Void	This is the guid id to use when using conditional breakpoints, can just use CopyDebugGuidToClipboard to make this process smoother
ContextCallbacks	String	Void	Returns all context callbacks, context objects and functions as one big string for viewing in context viewer
CallbackStoreList	CcoCallbackExpressionStore (list)	Void		debug, hide_in_uied
FinishCurrentAnimationInstantly	Void	Void	Finishes the current animation instantly if there is one playing
MoveToAbsolute	Void	Vector4	Changes the absolute position of the component to the position specified
IsSameGuid	Bool	String	Returnstrue if supplied guid is same as ours
StoredContextFromParent	Context	String	Returns the stored context with the specified type id (if one exists) on any of our parents
IsUpdating	Bool	Void	Returns true if the last update time of the component matches the root i.e. did update this frame
SetAnimationFrameProperty	Void	String, Int, String, Vector4	Sets the specified property on a specific frame of a given animation on this component.
MoveToRelative	Void	Vector4	Changes the relative position of the component to the position specified
IsTopmostObject	Bool	Void	Returns true if the component is a topmost object, meaning it will render on top of everything else
PushPriorityLock	Void	Int	Pushes a priority lock, any component with a priority under the value supplied will be made non-interactive
SetDisabled	Void	Bool	Sets the components disabled flag to the specified bool value. Only relevant if a component is interactive, if a component is interactive but disabled it will handle mouseovers but not clicks
Guid	String	Void	This is the globally unique id has currently in game, for layouts created in game will be different to UiEd as we regenerate to ensure unique
IsFullscreen	Bool	Void	Returns true if component dimensions are the same as the root component dimensions (so same size as screen). Used to easily toggle child components on based on if a panel is occupying whole of screen for example.
CurrentState	String	Void	Returns the current state name as a string
HasCallback	Bool	String	Returns whether the component have a specific callback
CurrentAnimation	String	Void	Returns the current animations id if any
SetDockOffset	Void	Int, Int	Sets dock offset on component (only works if already docked)
ClearPriorityLock	Void	Void	Clears the current priority lock
IsSelected	Bool	Void	Returns true if in a selected state
GuidOriginal	String	Void	This is the globally unique id that the layout has in uied, but not the same necessarily it has in game since gets regenerated to ensure uniqueness. Useful for debug breakpoints
ContextsList	ContextList	Void	Returns list of all contexts stored on this component and its callbacks
StoredContext	Context	String	Returns the stored context with the specified type id (if one exists)
SetListOffset	Void	Int, Int	Sets list offset on component (only works if in a list)
HasPlaceholderImage	Bool	Void	Returns true if any image on component is currently set to placeholder due to image tried to set not existing	debug
TriggerAnimation	Void	String	Triggers the specified animation
HasChildren	Bool	Void	Returns true if has any children
ModelViewContext	CcoComponentModelView	Void	Returns a CcoComponentModelView context for the component if it has a model view (3d model display)
SetDebugDisplayColour	Void	Int, Int, Int	Sets the colour of the debug display activated with ToggleDebugDisplay. Useful for when debugging layout engines within layout engines for example
ImagePath	String	Int	Returns the image path of the image at the specified index
SetImageMetricSize	Void	Int, Int, Int	Sets the size of the image metric on the current state
ParentContext	CcoComponent	String (optional)	Returns the parent component if we have one
FontCategoryName	String	Void	Returns the current name of the current font category in the current state
SetInteractive	Void	Bool, Bool (optional)	Sets the components interactive flag to the specified bool value, and if specify false as a second parameter will just apply to current state (defaults to all states). Interactivity determines if a component can handle mouse interactions like clicks and mouseovers
SetPriority	Void	Int	Sets the priority of the component to the supplied priority
BreakForDebugging	Void	Void	Breaks into code when attached to VS so can inspect internal component in greater detail	debug, hide_in_uied

CcoComponentModelView

Wrapper for a Components model view, so can get/set model/camera info

Functions

Name	Return Type	Arguments	Description
CameraPhi	Float	Void	Returns the phi angle for the orientation of the camera in degrees
SetCameraDistance	Void	Float	Sets the cameras distance from the target
SetCameraTarget	Void	Vector4	Sets the cameras target position
CameraTheta	Float	Void	Returns the pheta angle for the orientation of the camera in degrees
SetCameraFov	Void	Float	Sets the camera field of view in degrees
SetCameraTheta	Void	Float	Sets the camera theta orientation in degrees
SetCameraPhi	Void	Float	Sets the camera phi orientation in degrees
CameraDistance	Float	Void	Returns the distance of the camera from the target
CameraTarget	Vector4	Void	Returns the x,y,z,0 of the cameras target position
EnvironmentFilepath	String	Void	Returns the environment filepath that is being used (that affects lighting)
CameraFov	Float	Void	Returns the field of view of the camera in degrees

CcoContextHistoryObject

Functions

Name	Return Type	Arguments
ContextObjectId	String	Void
Reason	String	Void
Time	Int	Void
OriginComponentContext	Context	Void
CcoContext	Context	Void
CallbackId	String	Void
ContextId	String	Void

CcoContextSelection

Functions

Name	Return Type	Arguments	Description
SelectionParentContext	CcoComponent	Void	Returns the CcoComponent that has the selection parent that is sending us
FirstObject	Context	Void	Returns the first selected context object
MouseOverContext	Context	Void	Returns the context currently mousing over if we have one
SelectedObjectList	ContextList	Void	Returns the list of selected context objects

CcoCustomBattleArmyPreset

Wrapper for an army preset that can be saved / loaded

Functions

Name	Return Type	Arguments	Description
SiegeEquipmentList	CcoBattlefieldSiegeVehicleRecord (list)	Void	Returns a list of siege equipment saved in the army preset
FactionContext	CcoFactionRecord	Void	Returns a context to the faction that this preset stores an army for
Delete	Void	Void	Removes the army preset from the filesystem, and removes it from the context cache
UnitList	CcoMainUnitRecord (list)	Void	Returns a list of unit saved in the army preset
TogglePinned	Void	Void	Toggles the preset as pinned in the save / load army presets panel
IsHidden	Bool	Void	Returns whether the preset is hidden to save / load panel
LoadForPlayerSlot	Void	CcoCustomBattlePlayerSlot	Loads the preset for the given player slot context
IsCustomBudget	Bool	Void	Returns true if this army preset was saved with a custom budget
IsPinned	Bool	Void	Returns true if this army preset is pinned in the save / load army preset panel
TimeStampRaw	Int	Void	Returns the raw time stamp
IsValid	Bool	Void	Returns true if the preset is valid. Invalid files either failed to load or did not pass DLC checks
MainArmyCost	Int	Void	Returns the cost of the main army
ReinforcingArmyCost	Int	Void	Returns the cost of reinforcing units of the army
TimeStampFormat	UniString	String	Returns timestamp formatted with given string
FactionKey	String	Void	Returns the key of the faction that this is a preset for
BattleTypeContext	CcoBattleTypeRecord	Void	Returns a context to the battle type stored in the preset
Name	UniString	Void	Returns the name of the preset
ReinforcingUnitList	CcoMainUnitRecord (list)	Void	Returns a list of reinforcing units saved in the army preset

CcoCustomBattleArmyPresetFileHandler

Singleton wrapper for army preset file handler

Functions

Name	Return Type	Arguments	Description
ConfirmSaveOverwrite	Void	Void	Saves army preset once the overwrite operation has been accepted
ArmyPresetExists	Bool	UniString	Returns true if an army preset exists with the given filename
SaveArmyPresetForPlayerSlot	Void	UniString, CcoCustomBattlePlayerSlot	Saves the provided player slot's army with name given as the first argument
ArmyPresetList	CcoCustomBattleArmyPreset (list)	Int	Returns a list of army presets saved to disk

CcoCustomBattleLobby

Wrapper for the custom battle lobby

Functions

Name	Return Type	Arguments	Description	Tags
CountdownTimeSecs	Int	Void	Returns the current auto/faction lock/commencement countdown in seconds (only used in quick battles). Returns -1 if not active
PlayerSlotList	CcoCustomBattlePlayerSlot (list)	Void	Returns list of CcoCustomBattlePlayerSlot that are active in lobby
IsFactionSelectionCountdownPhase	Bool	Void	Returns whether the current phase is faction selection (ready button locks in faction rather than starts game)
LocalBalanceOfPowerPercent	Float	Void	Returns a simulate autoresolve balance of power based on armies in the lobby
NumberOfPlayerSlots	Int	Void	Returns the number of player slots in the lobby
ToggleReady	Void	Void	Toggles ready status of player
NumberOfPlayers	Int	Void	Returns the number of active players in the lobby
CanAddSpectatorSlot	Bool	Void	Returns true if can currently add a spectator slot
ReadyButtonText	UniString	Void	Returns ready button text
IsUsingSmallCards	Bool	Void	Returns true if should use small card format (based on resolution)
CanAutoResolve	Bool	Void	Returns true if can use autoresolve simulation	debug, hide_in_uied
DefaultSelectedPlayerSlotContext	CcoCustomBattlePlayerSlot	Void	Returns the default CcoCustomBattlePlayerSlot to select when entering lobby (default army shown)
ReadyStatusText	UniString	Void	Returns the text used on tooltip for ready button (to show ready errors)
IsReadyCountdownActive	Bool	Void	Returns true if the ready countdown is active (active once all players readied up)
ReadyButtonState	String	ExpressionState	Returns the current state to set on the ready button for local player
IsLocalPlayerFactionLocked	Bool	Void	Returns true if the player can no longer change their faction
CanInvite	Bool	Void	Returns true if can currently invite a player to the lobby
ArmyPresetFileHandlerContext	CcoCustomBattleArmyPresetFileHandler	Void	Returns the CcoCustomBattleArmyPresetFileHandler context which handles loading/saving army presets
IsActive	Bool	Void	Returns true if lobby is currently active/in use
HostSlotContext	CcoCustomBattlePlayerSlot	Void	Returns the host players CcoCustomBattlePlayerSlot
IsLocalPlayerReady	Bool	Void	Returns true if the local player is ready to play
AutoresolveBattleResultsContext	CcoBattleResult	Void	Returns the CcoBattleResult for an autoresolve simulation of units armies currently in the lobby	debug, hide_in_uied
SettingsContext	CcoCustomBattleSettings	Void	Returns the CcoCustomBattleSettings context that handles settings for lobby
IsLocalPlayerHost	Bool	Void	Returns true if the local player is currently the host
LocalPlayerSlotContext	CcoCustomBattlePlayerSlot	Void	Returns the local players CcoCustomBattlePlayerSlot
IsLocalPlayerSpectating	Bool	Void	Returns true if the local player is currently spectating
DevUISetCorruptionTileType	Void	String	For dev purposes, sets corruption tile type for trying out different corruptions in battles to make testing easier for env artists	debug, hide_in_uied
SpectatorSlotList	CcoCustomBattlePlayerSlot (list)	Void	Returns list of CcoCustomBattlePlayerSlot that are currently spectators
IsMatchmadeBattle	Bool	Void	Returns true if this lobby is for a matchmade quick battle
IsSinglePlayer	Bool	Void	Returns true if this is a single player lobby (custom battle)
ToggleFactionLockReady	Void	Void	Toggles ready-for-faction-lock status of player
AddSpectatorSlot	Void	Void	Adds a new spectator slot to lobby
TeamList	CcoCustomBattleTeam (list)	Void	Returns list of CcoCustomBattleTeam that are active in lobby

CcoCustomBattleMap

Wrapper for a custom map

Functions

Name	Return Type	Arguments	Description	Tags
IsPreset	Bool	Void	Returns whether the map is a preset
IsFavourite	Bool	Void	Returns whether the map is favourited
ClickgenCoords	Vector4	Void	Returns the clickgen co-ordinates
ClickgenCoordsRaw	Vector4	Void	Returns the raw clickgen co-ordinates
ClickgenProvinceName	UniString	Void	Returns the clickgen province name
ClickgenGroundTypeName	UniString	Void	Returns the clickgen ground type
Name	UniString	Void	Returns the name of the map
ClickgenRegionName	UniString	Void	Returns the clickgen region name
ClickgenClimateContext	CcoClimateRecord	Void	Returns the climate context for the map
BattleTypeString	String	Void	Returns the battle type for the map
OpenTerrainHTML	Void	Void	Opens the terrain.html file in your appdata/logs folder so you can see more details about the current selected map in custom battle	debug, hide_in_uied
CampaignBattlePresetRecordContext	CcoCampaignBattlePresetRecord	Void	Returns the campaign battle preset context for the map
DevInfo	UniString	Void	Returns string containing technical details about the map	debug, hide_in_uied
CampaignMapRecordContext	CcoCampaignMapPlayableAreaRecord	Void	Returns the campaign map record context for the map
ToggleFavourite	Void	Void	Toggles this map as a favourite
TogglePinned	Void	Void	Toggled this map as pinned in custom battle UI
BattleRecordContext	CcoBattleRecord	Void	Returns the battle context for the map
IsPinned	Bool	Void	Returns whether the map is pinned in custom battle UI

CcoCustomBattlePlayerSlot

Functions

Name	Return Type	Arguments
IsUsingAutogenUnits	Void	Void
FundsRemaining	Void	Void
AutogenerateUnits	Void	Void
IsAvailableForAutogenForDev	Void	Void
ClearUnits	Void	Void
TeamContext	Void	Void
AvailableSiegeEquipmentList	Void	Void
IsHuman	Void	Void
SetFaction	Void	Void
FundsBudget	Void	Void
ClearMainArmy	Void	Void
UnitListForUnitGroupParent	Void	Void
IsEmpty	Void	Void
UnitList	Void	Void
SwitchTeam	Void	Void
ToggleAutogenAvailabilityForDev	Void	Void
IsAllocated	Void	Void
ReinforcingUnitList	Void	Void
IsAI	Void	Void
RecruitUnit	Void	Void
IsSynchronisedWithLobby	Void	Void
NumEntities	Void	Void
IsTeamLeader	Void	Void
RemovePlayerSlot	Void	Void
TooltipToModifyUnits	Void	Void
AvailableFactionsForCurrentSubcultureList	Void	Void
IsOpen	Void	Void
KickPlayerInSlot	Void	Void
CycleFactionForCurrentSubculture	Void	Void
IsRecruitingReinforcements	Void	Void
FactionsForCulture	Void	Void
CanSwitchTeam	Void	Void
SlotIndex	Void	Void
NumSiegeVehiclesAvailable	Void	Void
AvailableSubcultureList	Void	Void
CanInvite	Void	Void
IsLocalPlayer	Void	Void
IsHost	Void	Void
NetworkPlayerContext	Void	Void
SetSubculture	Void	Void
SiegeVehicleTooltip	Void	Void
CanSelectFaction	Void	Void
AllianceColour	Void	Void
CanViewUnits	Void	Void
SetIsRecruitingReinforcements	Void	Void
SubcultureContext	Void	Void
CanRecruitUnit	Void	Void
CanModifyUnits	Void	Void
FactionRecordContext	Void	Void
TooltipForUnit	Void	Void
FactionSavedCharactersContext	Void	Void
AvailableFactionList	Void	Void
AddSiegeEquipment	Void	Void
IsSpectator	Void	Void
GetReinforcementFundsMultiplier	Void	Void
AutogenerateMainArmy	Void	Void
RemoveSiegeEquipment	Void	Void
CanKickOrRemove	Void	Void
IsFactionVisibleToLocalPlayer	Void	Void
AutogenerateReinforcements	Void	Void
PlayerName	Void	Void
CanModifySlot	Void	Void
SiegeEquipmentList	Void	Void
IsReady	Void	Void
GetTotalBudget	Void	Void
ClearReinforcements	Void	Void
CanAddSiegeEquipment	Void	Void

CcoCustomBattleSettings

Wrapper for the settings of custom battles

Functions

Name	Return Type	Arguments	Description
SettlementLevelSettingList	CcoCustomBattleSettingRecord (list)	Void	Returns a list of available settlement level settings
ToggleMultipleLords	Void	ExpressionState	Toggles multiple lords enabled bool
ToggleIsUsingLargeArmies	Void	ExpressionState	Toggles large armies setting
IsUsingCustomTicketLimit	Bool	Void	Returns true if currently using custom ticket limit
HasConfigurableTicketLimit	Bool	Void	Returns whether the game type has a configurable ticket limit
SeasonRecordContext	CcoSeasonRecord	Void	Returns a context to the season record
CanUseSplitFunds	Bool	Void	Returns whether can use the split funds mode
IsUsingLargeArmies	Bool	Void	Returns whether large armies are being used
SetBattleTypeRecordContext	Void	ExpressionState, CcoBattleTypeRecord	Sets the given context as the battle type
TimeLimitSettingList	CcoCustomBattleSettingRecord (list)	Void	Returns a context list of time limit settings
SettlementMapList	CcoCustomBattleMap (list)	Void	Returns a list of custom battle maps that have settlements
SetTicketLimitSettingContext	Void	ExpressionState, CcoCustomBattleSettingRecord	Sets the ticket limit setting value
ToggleSplitFunds	Void	ExpressionState	Toggle the split funds mode
FundTypeSettingContext	CcoCustomBattleSettingRecord	Void	Returns a context to the fund type setting
SeasonRecordList	CcoSeasonRecord (list)	Void	Returns a list of available season records
SettlementLevelSettingContext	CcoCustomBattleSettingRecord	Void	Returns a context to the settlement level setting
IsTimeoutDraw	Bool	Void	Returns whether timeouts result in a draw
HistoryMapList	CcoCustomBattleMap (list)	Void	Returns list of custom battle map history
WeatherTypeRecordList	CcoBattleWeatherTypeRecord (list)	Void	Returns a list of available records for weather types
IsRealismMode	Bool	Void	Returns whether realism mode is being used
IsFreeForAll	Bool	Void	Returns whether this is a free for all battle
IsSplitFundsEnabled	Bool	Void	Returns true if split funds mode is enabled
SetWeatherTypeRecordContext	Void	ExpressionState, CcoBattleWeatherTypeRecord	Sets the given context as the weather type
TimeLimitSettingContext	CcoCustomBattleSettingRecord	Void	Returns a context to the setting record for time limit
TicketLimitSettingList	CcoCustomBattleSettingRecord (list)	Void	Returns a context list of ticket limit settings
FavouriteMapList	CcoCustomBattleMap (list)	Void	Returns a list of favourited custom battle maps
ToggleRealismMode	Void	ExpressionState	Toggles realism mode
CanAddAi	Bool	Void	Returns true if current battle type supports adding of AI
CanEnableStormOfMagic	Bool	Void	Returns whether can enable storm of magic setting (not matchmade and not survival battle)
SetUnitScaleSettingContext	Void	ExpressionState, CcoCustomBattleSettingRecord	Sets the given context as the unit scale setting
CanToggleAttackingTeam	Bool	Void	Returns whether the attacking team can be toggled (switched), some battle types do not allow toggling
CampaignBattleTypeString	String	Void	Returns a string representation of the battle type
WeatherTypeRecordContext	CcoBattleWeatherTypeRecord	Void	Returns a context to the weather type record
ForceSettingResync	Void	Void	Forces settings to be resynced
MaxUnitsCanRecruit	Int	Int	Returns the maximum number of units that can currently be recruited
ToggleAttackingTeam	Void	ExpressionState	Switches the attacking team
SetMapCoordinate	Void	ExpressionState, String, String	Sets the co-ord at index give ('x' or 'y'), to the value given
TimeLimitSeconds	Int	Void	Returns the time limit of the battle in seconds
ToggleStormOfMagic	Void	ExpressionState	Toggles storm of magic setting (storm of magic is for warhammer, where magic is greatly empowered and the lore boosted changes every so often)
IsUsingReinforcingUnits	Bool	Void	Returns whether reinforcing units are used
MapPresetList	CcoCustomBattleMap (list)	Void	Returns a list of currently available custom battle maps
HasAttackerDefender	Bool	Void	Returns whether this battle has attackers and defenders
TimeOfDaySettingList	CcoCustomBattleSettingRecord (list)	Void	Returns a list of available setting records for times of day
UnitScaleSettingList	CcoCustomBattleSettingRecord (list)	Void	Returns a list of available unit scale settings
IsStormOfMagicAvailable	Bool	Void	Returns if storm of magic setting available to use (currently just a dev thing accessible via dev_custom_battle tweaker
CanChangeSettings	Bool	Void	Returns whether custom battle settings can be changed
SetTimeOfDaySettingContext	Void	ExpressionState, CcoCustomBattleSettingRecord	Sets the given context as the time of day setting
IsCommanderRequiredFirst	Bool	Void	Returns whether a commander is required before the battle can start
SetBattleAiStatsModifier	Void	ExpressionState, Float	Sets the value of the ai stats modifier setting
AttackingTeamIndex	Int	Void	Returns the index of the attacking team
SetCustomFundsAmount	Void	ExpressionState, UniString	Sets the given amount as the custom funds limit
SetEscalationLevelSettingContext	Void	ExpressionState, CcoCustomBattleSettingRecord	Sets the given context as the escalation level setting
ToggleLoadingCharacters	Void	ExpressionState	Toggles unit caps
MapContext	CcoCustomBattleMap	Void	Returns a context to the current map
TicketLimitSettingContext	CcoCustomBattleSettingRecord	Void	Returns a context to the setting record for ticket limit
TimeOfDaySettingContext	CcoCustomBattleSettingRecord	Void	Returns a context to the time of day setting
IsSettlementBattleType	Bool	Void	Returns whether this is a settlement battle type
IsStormOfMagicEnabled	Bool	Void	Returns whether storm of magic setting enabled (storm of magic is for warhammer, where magic is greatly empowered and the lore boosted changes every so often)
UnitScaleSettingContext	CcoCustomBattleSettingRecord	Void	Returns a context to the unit scale setting
HasTwoAlliances	Bool	Void	Returns whether this battle has attackers and defenders
LaboratoryInfoContext	CcoBattleLaboratoryInfo	Void	Returns the context of the laboratory info
ToggleUnitCaps	Void	ExpressionState	Toggles unit caps
EscalationLevelSettingContext	CcoCustomBattleSettingRecord	Void	Returns a context to the escalation level setting
SetDifficultyLevelSettingContext	Void	ExpressionState, CcoCustomBattleSettingRecord	Sets the given context as the difficulty level
SetFundTypeSettingContext	Void	ExpressionState, CcoCustomBattleSettingRecord	Sets the given context as the fund type setting
BattleTypeRecordList	CcoBattleTypeRecord (list)	Void	Returns a list of available battle types for custom battle
CorruptionTypeRecordList	CcoCustomBattleCorruptionType (list)	Void	Returns a list of available CcoCorruptionTypeRecord
IsLoadingCharactersEnabled	Bool	Void	Returns whether unit set caps are enforced
BattleAiStatsModifier	Float	Void	Returns the value of the ai stats modifier setting
IsSiegeBattleType	Bool	Void	Returns whether this is a siege battle type
SetCorruptionTypeRecordContext	Void	ExpressionState, CcoCustomBattleCorruptionType	Sets corruption type for map supplying a CcoCorruptionTypeRecord, if pass empty then removes any corruption type (has visual impact on battlefield)
EscalationLevelSettingList	CcoCustomBattleSettingRecord (list)	Void	Returns a list of available escalation level settings
IsLabMode	Bool	Void	Returns if lab mode has been chosen for this battle
IsUsingCustomFunds	Bool	Void	Returns whether custom funds amount is being used
DifficultyLevelSettingContext	CcoCustomBattleSettingRecord	Void	Returns a context to the difficulty level
SetTimeLimitSettingContext	Void	ExpressionState, CcoCustomBattleSettingRecord	Sets the given time limit setting context
CostForSettlementLevel	Int	CcoCustomBattleSettingRecord	Returns the cost for the given settlement level context
CustomTicketLimitAmount	Int	Void	Returns the value of the current custom ticket limit
IsUsingUnitCaps	Bool	Void	Returns whether unit set caps are enforced
BattleTypeRecordContext	CcoBattleTypeRecord	Void	Returns a context to the battle type
ToggleLabMode	Void	ExpressionState	Toggles the lab mode on/off
SetSettlementLevelSettingContext	Void	ExpressionState, CcoCustomBattleSettingRecord	Sets the given context as the settlement level setting
CorruptionTypeRecordContext	CcoCustomBattleCorruptionType	Void	Returns the CcoCorruptionTypeRecord being used for the corruption setting, null if none (has visual impact on battlefield)
DifficultyLevelSettingList	CcoCustomBattleSettingRecord (list)	Void	Returns a list of available difficulty levels
CustomBudgetAmount	Int	Void	Returns the amount of the custom budget if being used
IsMultipleLordsEnabled	Bool	Void	Returns whether we can use multiple lords
MaxUnitsCanReinforce	Int	Int	Returns the maximum number of units that can reinforce
CanUseLargeArmies	Bool	Void	Returns whether large armies can be used
IsTimeLimitUsed	Bool	Void	Returns whether a time limit is used
SetMapContext	Void	ExpressionState, CcoCustomBattleMap	Sets the given custom map context as the current map
ChooseRandomMap	Void	ExpressionState	Chooses a random map and sets it as the current map
SetCustomTicketLimit	Void	ExpressionState, UniString	Sets the given amount as the custom ticket limit
FundTypeSettingList	CcoCustomBattleSettingRecord (list)	Void	Returns a list of available setting records for funds
SetSeasonRecordContext	Void	ExpressionState, CcoSeasonRecord	Sets the given context as the season

CcoCustomBattleTeam

Wrapper for the custom battle team

Functions

Name	Return Type	Arguments	Description
AddPlayerSlot	Void	ExpressionState	Adds an open player slot to this team for a player to join
AddAIBot	Void	Void	Adds an AI slot to this team
NumPlayerSlotsCanAdd	Int	Void	Returns the number of slots that can be added to this team
CanAddAI	Bool	Void	Returns true if can add an AI slot to this team
CanAddPlayerSlot	Bool	Void	Returns true if can add a player slot to this team
HasHumansOnTeam	Bool	Void	Returns true if the team contains any human players
IsAttacker	Bool	Void	Returns true if this is the attacking team
DefaultSelectedPlayerSlotContext	CcoCustomBattlePlayerSlot	Void	Returns the default CcoCustomBattlePlayerSlots that should be selected for the player on this team (when players/added removed, etc)
TeamIndex	Int	Void	Returns the numeric index of this team (team id)
TeamLeaderPlayerSlotContext	CcoCustomBattlePlayerSlot	Void	Returns the CcoCustomBattlePlayerSlots that is the current team leader for this team
PlayerSlotList	CcoCustomBattlePlayerSlot (list)	Void	Returns list of CcoCustomBattlePlayerSlots on this team

CcoCustomBattleUnit

Context object for a given player/unit/reinforcement slot combo

Functions

Name	Return Type	Arguments	Description
TransformationUnitOverrideContext	CcoMainUnitRecord	Void	Returns the unit's transformation unit override.
Cost	Int	Void	Returns the cost of the unit associated with the unit index stored on this context
MoveToDraggableUnit	Void	ExpressionState	Attempts to move the current context to the position of the context associated with state component passed in
IsValid	Bool	Void	Returns whether the unit associated with the unit index stored on this context is valid
ChangeUnitType	Void	CcoUnitsCustomBattleTypeRecord	Changes, to the provided alternate unit type, specified by the provided CcoUnitsCustomBattleTypeRecord
CostAtLevel	Int	Int	Returns the cost at a provided level of the unit with the unit index stored on this context
RemoveMount	Void	Void	Removes the mount of the unit associated with the unit index stored on this context
ExperienceLevel	Int	Void	Returns the level of the unit associated with the unit index stored on this context
CurrentMountRecordContext	CcoUnitsCustomBattleMountRecord	Void	Returns the CcoUnitsCustomBattleMountRecord associated with the unit index stored on this context
Name	UniString	Void	Returns the name of the unit with the unit index stored on this context
DecreaseExperience	Void	Void	Decreases the level of the unit associated with the unit index stored on this context
ChangeMount	Void	CcoUnitsCustomBattleMountRecord	Changes, to the provided CcoUnitsCustomBattleMountRecord, the mount of the unit associated with the unit index stored on this context
ImagePath	String	Void	Returns the portrait path of the unit with the unit index stored on this context
CustomBattleUnitRecordContext	CcoUnitsCustomBattlePermissionRecord	Void	Returns the CcoUnitsCustomBattlePermissionRecord record associated with the unit index stored on this context
RemoveUnit	Void	Void	Removes this unit from the player slot
UnitDetailsContext	CcoUnitDetails	Void	Returns the CcoUnitDetails associated with this unit index stored on this context
IncreaseExperience	Void	Void	Increases the level of the unit associated with the unit index stored on this context
UnitRecordContext	CcoMainUnitRecord	Void	Returns the CcoMainUnitRecord associated with the unit index stored on this context
CanChangeMount	Bool	CcoUnitsCustomBattleMountRecord	Returns whether the unit index stored on this context can change mount
UnmountedRecordContext	CcoMainUnitRecord	Void	Returns the CcoMainUnitRecord associated with the unmounted version of the unit index stored on this context
CanAffordMount	Bool	CcoUnitsCustomBattleMountRecord	Returns whether the unit index stored on this context can change mount
UnitTypes	CcoUnitsCustomBattleTypeRecord (list)	Void	Returns variants for this unit, eg different ammo or spell lore overrides
IsPersistentCharacter	Bool	Void	Returns whether the unit associated with the unit index stored on this context is a loaded character
HasArmory	Bool	Void	Returns whether the unit associated with the unit index stored on this context has an armory
PlayerSlotContext	CcoCustomBattlePlayerSlot	Void	Returns the CcoCustomBattlePlayerSlot associated with the slot index stored on this context
CanEverIncreaseExperience	Bool	Void	Returns whether the unit associated with the unit index stored on this context can ever increase its level
AvailableUpgradeList	CcoCustomBattleUnitUpgrade (list)	Void	Returns the CcoCustomBattleUnitUpgrades available to the unit associated with the unit index stored on this context
CurrentUpgradeList	CcoCustomBattleUnitUpgrade (list)	Void	Returns the current CcoCustomBattleUnitUpgrades of the unit associated with the unit index stored on this context
CanIncreaseExperience	Bool	Void	Returns whether the unit associated with the unit index stored on this context can currently increase its level
IsReinforcement	Bool	Void	Returns whether the unit associated with the unit index stored on this context is a reinforcement
SetTransformationUnitOverride	Void	CcoMainUnitRecord	Sets the unit's transformation unit override.
AvailableMountsList	CcoUnitsCustomBattleMountRecord (list)	Void	Returns the CcoUnitsCustomBattleMountRecords available to the unit associated with the unit index stored on this context
IsCommander	Bool	Void	Returns whether the unit associated with the unit index stored on this context is a commander

CcoCustomBattleUnitUpgrade

Functions

Name	Return Type	Arguments
CanAfford	Void	Void
ToggleEquipped	Void	Void
CanToggle	Void	Void
Tooltip	Void	Void
Cost	Void	Void
AncillaryContext	Void	Void
IsEquipped	Void	Void
AbilityContext	Void	Void
SkillContext	Void	Void
Name	Void	Void
IconPath	Void	Void
UnitContext	Void	Void
TypeName	Void	Void

CcoEffect

Component context wrapper for an effect, just a text and icon pair basically! Allows it to be generically created for different effect systems

Functions

Name	Return Type	Arguments	Description	Tags
UnitsFromEffectNotExcluded	CcoMainUnitRecord (list)	ExpressionState	Returns a list of all the units affected by the CAMPAIGN_EFFECT that are not excluded.
AttributeContext	CcoUnitAttributeRecord	ExpressionState	Returns the linked CcoUnitAttributeRecord with this effect if exists, only valid to call when created with a CAMPAIGN_EFFECT
LocalisedText	UniString	Void	Returns the localised text for the effect
UniqueAgentSubtypeAgentPairList	CcoAgentSubtypeAgentPair (list)	ExpressionState	Returns a list of linked agent subtype and agent pairs if they exist, only valid to call when created with a CAMPAIGN_EFFECT
AdditionalDetails	UniString	Void	Returns the additional description for this effect, if it exists
UnitSetsList	CcoUnitSetRecord (list)	ExpressionState	Returns a list of linked unit sets if they exist, only valid to call when created with a CAMPAIGN_EFFECT
PlagueList	CcoPlagueRecord (list)	ExpressionState	Returns a list of linked plague records if they exits, only valid to call when created with a CAMPAIGN_EFFECT
IconPath	String	Void	Returns the icon path
AdditionalDetailsIcon	String	Void	Returns the icon for the additional description of this effect, if it exists
AgentList	CcoAgentRecord (list)	ExpressionState	Returns a list of linked agent records if they exist, only valid to call when created with a CAMPAIGN_EFFECT
UnitList	CcoMainUnitRecord (list)	ExpressionState	Returns a list of linked units if they exits, only valid to call when created with a CAMPAIGN_EFFECT
EffectKey	String	ExpressionState	Returns the effect record key, only valid to call when created with a CAMPAIGN_EFFECT
SpecialAbilityPhaseRecordContext	CcoSpecialAbilityPhaseRecord	Void	Returns the first linked special ability phase record if it exists
Priority	Int	Void	Returns the priority of the effect, used for ordering and if 0 isn't shown in UI
InitiativeSetsList	CcoInitiativeSetRecord (list)	Void	Returns a list of linked INITIATIVE_SET_RECORDs
UnitListsList	CcoUnitListRecord (list)	Void	Returns a list of linked UNIT_LIST_RECORDs
Value	Int	Void	Returns the raw value of the effect as a number
PlagueComponentContext	CcoCampaignPlagueIngredient	CcoCampaignFaction	Returns the first linked plague component if it exists
UnitAbilityList	CcoUnitAbility (list)	Void	Returns a list of unit abilities linked to effect
IsPositive	Bool	Void	Returns true if this is a positive effect
RitualContext	CcoRitualRecord	ExpressionState	Returns the first linked CcoRitualRecord if it exists
DevUnitSetsFromEffectExcluded	CcoUnitSetRecord (list)	ExpressionState	Returns a list of all the unit sets affected by the CAMPAIGN_EFFECT that are excluded.	debug, hide_in_ui
ManipulationInfoContext	CcoCampaignDiplomacyManipulationInfo	ExpressionState, CcoCampaignFaction	Returns the first linked CcoCampaignDiplomacyManipulationInfo if it exists
DevUnitSetStringsFromEffectExcluded	CcoString (list)	ExpressionState	Returns a list of all the unit sets affected by the CAMPAIGN_EFFECT that are excluded (as strings with their owning effect key).	debug, hide_in_ui
RitualList	CcoRitualRecord (list)	Void	Returns a list of all linked CcoRitualRecord.
PooledResourceContext	CcoCampaignPooledResource	ExpressionState, String, Context	Returns the linked CcoCampaignPooledResource for the object passed in (faction, province manager etc), with the specified key, only valid to call when created with a CAMPAIGN_EFFECT
DevUnitsFromEffectExcluded	CcoMainUnitRecord (list)	ExpressionState	Returns a list of all the units affected by the CAMPAIGN_EFFECT that are excluded.	debug, hide_in_ui
EffectScopeContext	CcoCampaignEffectScopeRecord	Void	Returns the CcoCampaignEffectScopeRecord if it exists
UnitSetsFromAllSourcesList	CcoUnitSetRecord (list)	ExpressionState	Returns a list of linked unit sets from any sources that junction to unit sets, only valid to call when created with a CAMPAIGN_EFFECT
AbilityContext	CcoUnitAbility	ExpressionState	Returns the linked CcoUnitAbility with this effect if exists, only valid to call when created with a CAMPAIGN_EFFECT

CcoEffectBundle

Component context wrapper for an effect bundle, stores ptr to record and turns remaining. Used mostly for campaign effects. Can also get a list of effects.

Functions

Name	Return Type	Arguments	Description
Priority	Int	Void	Returns the priority (used for ordering and if 0 generally isnt shown in UI)
EffectList	CcoEffect (list)	ExpressionState	Returns the list of effects for this effect bundle (CcoEffect)
EffectsIncludingHiddenList	CcoEffect (list)	ExpressionState	Returns the list of all effects for this effect bundle, including hidden ones. This should never be used for displaying the effects, use EffectList for that
IconPath	String	Void	Returns the icon path
Name	UniString	Void	Returns the localised name
Description	UniString	Void	Returns the localised description
RecordList	CcoEffectBundle (list)	Void	Returns the list of all effect bundle records
Key	String	Void	Returns the unique key of the effect bundle record
IsHighlightedEffectBundle	Bool	Void	Returns true if show_in_3d_space is set to true on effect bundle record, used in conjunction with owner_only to highlight effect bundles on the 3d UI
ShowHighlightedOnOwnerOnly	Bool	Void	Returns true if owner_only is set to true on effect bundle record, used in conjunction with show_in_3d_space to highlight effect bundles on the 3d UI
HasOverrideEffects	Bool	Void	Returns true if has different effects to the effect bundle record, for example if the bundle was constructed from script
IsGlobalEffectBundle	Bool	Void	Returns true if is_global_effect is set to true on effect bundle record
TurnsRemaining	Int	Void	Returns the turns remaining for this effect bundle, 0 if infinite

CcoFactionSavedCharacters

Wrapper for a SAVED_CHARACTER_INFO struct

Functions

Name	Return Type	Arguments	Description
IsCampaign	Bool	Void	Returns true if we're in campaign, since some info will only show there
LoadSavedCharacter	Void	CcoSavedCharacterInfo, Context	Loads the passed in saved character at the settlement or military force passed in
DeleteSavedCharacter	Void	CcoSavedCharacterInfo	Deletes the passed in saved character file from the local machine's saved characters folder
FilteredCampaignCharacterInfoList	CcoSavedCharacterInfo (list)	Void	Returns a list of saved characters for this faction, filtered on whether should show agents or lords
SavedCharacterInfoList	CcoSavedCharacterInfo (list)	Void	Returns a list with all saved characters for this faction

CcoFactorBreakdown

Functions

Name	Return Type	Arguments
Header	Void	Void
Description	Void	Void
List	Void	Void

CcoFrontendFactionLeader

Wrapper for a frontend faction leader

Functions

Name	Return Type	Arguments	Description
FactionRecordContext	CcoFactionRecord	Void	Returns a CcoFactionRecord with the faction record that the lord is part of
GeneralKey	String	Void	Returns the start pos character key for the general
UnitList	CcoUnitDetails (list)	Void	Returns a list of CcoUnitDetails of units that are present in the leader's military force
AchievementLockedText	UniString	Void	Returns localised text to show for achievement locked lord
IsLocked	Bool	Void	Returns true if cant play as lord due to them being locked behind achievement currently
LockedReasonText	UniString	CcoCampaignMapPlayableAreaRecord	Returns the a localised description of why cant start campaign with this lord currently. Empty if nothing stopping starting the campaign
Name	UniString	Void	Returns the localised name of the general
RandomiseName	Void	Void	Generates a random name for the general
PinLocation	Vector4	Void	Returns the location of the lord on the map
SetName	Void	UniString	Sets the name of the general to the one passed in
FrontendFactionLeaderRecordContext	CcoFrontendFactionLeaderRecord	Void	Returns a CcoFrontendFactionLeaderRecord with the leader record
FactionEffectBundle	CcoEffectBundle	Void	Returns a list of faction effects to be displayed in frontend
SetAsActiveModel	Void	Void	Sets this leader as the active model

CcoFrontendRoot

Functions

Name	Return Type	Arguments	Description
AreIntroMoviesFinished	Bool	Void	Returns true if intro movies finished playing on loading into game
StartCampaign	Void	String, String, String	Starts campaign with specified campaign and faction key
IngameMessagingContext	CcoIngameMessaging	Void	Returns the in game messaging manager context
CurrentMenuId	String	Void	Returns the id of the current menu that is open in the frontend
CustomBattleLobbyContext	CcoCustomBattleLobby	Void	Returns the current custom battle lobby context
CampaignLobbyContext	CcoMPCampaignLobby	Void	Returns the current multiplayer campaign lobby context

CcoGameCore

Wrapper for the game core

Functions

Name	Return Type	Arguments	Description	Tags
AdvisorContext	CcoAdvisor	Void	Returns the Advisor context
IsOnline	Bool	Void	Returns whether the game is connected to an online service, e.g. Steam
IsDebugBuild	Bool	Void	Returns whether the build is a debug build, i.e. non final release
BuildNumber	String	Void	Returns the current build number
BuildNumberShort	String	Void	Returns the short version of the current build number
DevSetUiScale	Void	Float	Set the ui scale	dev
DevSetTextScale	Void	Float	Set the ui text scale	dev
InstalledProductList	CcoOwnershipProductRecord (list)	Void	Returns the list of installed product contexts
DevUiScale	Float	Void	Get the current ui scale	dev
NarrativeManagerContext	CcoNarrativeManager	Void	Returns the Narrative Manager context
TrialManager	CcoMoMTrialManager	Void	Returns the Mirrors of Madness Trial Manager context
IsMemoryLeakReportingEnabled	Bool	Void	Returns whether the -memory_leak_report is defined and so we are tracking memory allocations

CcoIngameMessaging

Ingame messaging singleton, used to get ingame news items

Functions

Name	Return Type	Arguments	Description
CurrentNewsItems	CcoIngameMessagingItem (list)	Void	Returns news items for the current page of news
FilteredNewsItems	CcoIngameMessagingItem (list)	Void	Returns all news items that could be visible (DLC permission checks, platform checks, etc)
PreviousPage	Void	Void	Goes back to previous page of news
CurrentPage	Int	Void	Returns the current page of news being viewed on frontend
NextPage	Void	Void	Advances news page by 1 to view next set of news
IsReady	Bool	Void	Returns true if ingame messaging is loaded and ready
CanGetAnyNews	Bool	Void	Returns true if we are able to get any news at all
HasMoreNews	Bool	Void	Returns true if there is more news to be shown

CcoIngameMessagingItem

A messaging item, basically news item. Can get fields based on JSON response for different templates

Functions

Name	Return Type	Arguments	Description
HasField	Bool	String	Returns true if given field is not empty (value has non-zero length and exists)
OpenLink	Void	ExpressionState	Opens up the button url in an external browser
TemplateId	String	Void	Returns the ID of the template used as a string
Field	UniString	String	Given a key return value for stored field on messaging item, from original JSON response
Category	String	Void	Returns the category of the item as a string

CcoJadeDatabase

Wrapper for the Jade database

Functions

Name	Return Type	Arguments	Description
PlagueComponentUiDataList	CcoPlagueComponentUiDataRecord (list)	Void	Returns a list of CcoPlagueComponentUiDataRecord.
MalakaiOathsQuestChainList	CcoMalakaiOathsQuestChain (list)	Void	Returns a list of CcoMalakaiOathsQuestChain.
PlagueMutationUiInfoList	CcoPlagueMutationUiDataRecord (list)	Void	Returns a list of CcoPlagueMutationUiDataRecord.

CcoListLayout

Wrapper for a component list engine

Functions

Name	Return Type	Arguments	Description
Spacing	Vector4	Void	Returns list layout spacing
Margins	Vector4	Void	Returns list layout margins
SetSizeToContents	Void	Bool	Sets whether list layout resizes to contents
SetItemsPerRow	Void	Int	Sets items allowed per row in list layout
SetSpacing	Void	Vector4	Sets spacing of list layout
SetMargins	Void	Vector4	Sets margins of list layout
SetSecondaryMargins	Void	Vector4	Sets secondary margins of list layout
ItemsPerRow	Int	Void	Returns the number of items per row the list layout allows
SizeToContents	Bool	Void	Returns whether the list layout resizes to contents
IsVertical	Bool	Void	Returns true if the list layout is a vertical list, or false if horizontal
SecondaryMargins	Vector4	Void	Returns list layout secondary margins

CcoLobbyBase

Functions

Name	Return Type	Arguments
IsSinglePlayer	Void	Void
CanAddSpectatorSlot	Void	Void
AutoReadyCountdownTimeSecs	Void	Void
IsActive	Void	Void
IsAutoReadyCountdownActive	Void	Void
ReadyCountdownTimeSecs	Void	Void
IsReadyCountdownActive	Void	Void
LocalPlayerSlotContext	Void	Void
HostSlotContext	Void	Void
NumberOfPlayers	Void	Void
PlayerSlotList	Void	Void
ReadyStatusText	Void	Void
NumberOfPlayerSlots	Void	Void
IsLocalPlayerReady	Void	Void
ReadyButtonState	Void	Void
IsLocalPlayerHost	Void	Void
AddSpectatorSlot	Void	Void
ToggleReady	Void	Void
IsLocalPlayerSpectating	Void	Void
IsMatchmadeBattle	Void	Void
SpectatorSlotList	Void	Void

CcoLobbyPlayer

Wrapper for a lobby player slot

Functions

Name	Return Type	Arguments	Description
IsHost	Bool	Void	Returns true if this player is the host of the lobby
CanSetFaction	Bool	CcoFactionRecord	Returns true if the passed in faction is valid to be set for this player
CanKick	Bool	Void	Returns true if this player can be kicked from the lobby
CurrentLordContext	CcoFrontendFactionLeader	Void	Returns the currently chosen lord
NetworkPlayerContext	CcoNetworkPlayer	Void	Returns the context of the network player
TeamID	Int	Void	Returns the team id of the player
CurrentFactionContext	CcoFactionRecord	Void	Returns the currently chosen faction
GetCurrentState	String	Void	Returns the current state of the player (ready/not ready)
PlayerID	Int	Void	Returns the id of the player
BattleDifficultyName	UniString	Void	Returns the name of the current battle difficulty
CampaignDifficultyName	UniString	Void	Returns the name of the current campaign difficulty
Name	UniString	Void	Returns the name of the player
SetCulture	Void	CcoCultureRecord	Sets the culture to the passed in one
StartingGeneralCustomName	UniString	Void	Returns the starting general custom name
KickPlayer	Void	Void	Kicks this player out of the lobby
SetFaction	Void	CcoFactionRecord	Sets the faction to the passed in one
SetLord	Void	CcoFrontendFactionLeader	Sets the lord to the passed in one
IsLocalPlayer	Bool	Void	Returns true if this player is the local player

CcoLobbyTeam

Component context wrapper for a MPC lobby team

Functions

Name	Return Type	Arguments	Description
Join	Void	Int	Makes the supplied player slot join this team
CanLocalPlayerJoin	Bool	Void	Returns true if the local player can currently join this team
ShouldShow	Bool	Void	Returns true if we should show this team in the UI
TeamID	Int	Void	Returns the team id (index)
IsFFATeam	Bool	Void	Returns true if this is free for all team

CcoMPCampaignLobby

Functions

Name	Return Type	Arguments
ReadyButtonState	Void	Void
MPCampaignSettings	Void	Void
IsLocalPlayerHost	Void	Void
IsResumed	Void	Void
IsLocalPlayerSpectating	Void	Void
IsActive	Void	Void
GetTeams	Void	Void
CampaignStartInfoContext	Void	Void
IsMatchmadeBattle	Void	Void
IsSinglePlayer	Void	Void
HostSlotContext	Void	Void
PlayersForTeam	Void	Void
PlayerSlotList	Void	Void
AutoReadyCountdownTimeSecs	Void	Void
IsAutoReadyCountdownActive	Void	Void
ToggleReady	Void	Void
UnselectedLords	Void	Void
ReadyCountdownTimeSecs	Void	Void
SettingsContext	Void	Void
IsReadyCountdownActive	Void	Void
DownloadProgressPercent	Void	Void
ReadyStatusText	Void	Void
LocalPlayerSlotContext	Void	Void
NumSelectedFactionsForCulture	Void	Void
NumberOfPlayerSlots	Void	Void
NumberOfPlayers	Void	Void
SelectedLords	Void	Void
IsLocalPlayerReady	Void	Void
PlayerForFactionLeaderContext	Void	Void
CanInvite	Void	Void

CcoMPCampaignMap

Wrapper for a playable map in multiplayer campaigns

Functions

Name	Return Type	Arguments	Description
MapImagePath	String	Void	Returns the map image path to be used on map displays
MaxPlayers	Int	Void	Returns the max number of players that can play in this campaign
Description	UniString	Void	Returns the localised description for the map
ImagePath	String	Void	Returns the image path to be used on selectable entries
TimeOfLegendCampaignRecordContext	CcoTimeOfLegendsCampaignRecord	Void	Returns the CcoTimeOfLegendsCampaignRecord for this map (can be empty)
CampaignStartInfoContext	CcoCampaignStartInfo	Void	Returns CcoCampaignStartInfo used for campaign select screen in mpc lobby in frontend, use this one instead of playable area record as it includes time of legend info
Name	UniString	Void	Returns the localised name for the map
CampaignMapRecordContext	CcoCampaignMapPlayableAreaRecord	Void	Returns the CcoCampaignMapPlayableAreaRecord for this map

CcoMPCampaignSettings

Functions

Name	Return Type	Arguments
CanChangeSetting	Void	Void
GetOptionsForSetting	Void	Void
SetBattleAiStatsModifier	Void	Void
ToggleAllianceOnly	Void	Void
GetBattleAiStatsModifier	Void	Void
SetOptionForSetting	Void	Void
ToggleOptionForSetting	Void	Void
IsAllianceOnlySettingActive	Void	Void
IsAllianceOnly	Void	Void
GetCurrentOptionForSetting	Void	Void

CcoMoMTrialManager

Wrapper for Mirrors of Madness Trials

Functions

Name	Return Type	Arguments	Description
TrialsHighScoreForBattle	Int	String	Returns an int with the highscore of the trial battle piece key passed
CurrentTierScore	Int	Int	Returns an int with the last tier that was already achieved relative to the passed in score
TrialGoldMedalScore	Int	Void	Returns an int with the score needed to achieve a gold medal in a trials battle
TrialPlatinumMedalScore	Int	Void	Returns an int with the score needed to achieve a gold medal in a trials battle
TrialBronzeMedalScore	Int	Void	Returns an int with the score needed to achieve a bronze medal in a trials battle
TrialSilverMedalScore	Int	Void	Returns an int with the score needed to achieve a silver medal in a trials battle
NextTierScore	Int	Int	Returns an int with the score needed to achieve the next tier relative to the passed in score

CcoMultiplayerRoot

Component context wrapper for the root of the mp system, so can get useful information such as local player, players in game, players waiting on, etc

Functions

Name	Return Type	Arguments	Description
HostPlayerContext	CcoNetworkPlayer	Void	Returns the CcoNetworkPlayer for the host player
FriendList	CcoNetworkPlayer (list)	Void	Returns the friend list of the local player as a list of CcoNetworkPlayer
PlayerList	CcoNetworkPlayer (list)	Void	Returns list of CcoNetworkPlayers in the current game
StalledNetworkPlayerList	CcoNetworkPlayer (list)	Void	Returns list of CcoNetworkPlayers waiting to load into the game still
LocalPlayerContext	CcoNetworkPlayer	Void	Returns the CcoNetworkPlayer for the local player

CcoNarrativeManager

Functions

Name	Return Type	Arguments	Description
SelectedTabKey	String	Void	Returns the selected tab index
SelectedTabIndex	Int	Void	Returns the selected tab key
TurnPageLeft	Void	Void	Decrements the page spread value if possible
TurnPageRight	Void	Void	Increments the page spread value if possible
SelectedTabContext	CcoNarrativeViewerTabRecord	Void	Returns the selected tab as a context object
NumEntriesForSelectedTab	Int	Void	Returns the number of CcoCampaignVideoRecords and CcoIncidentRecords associated with the current tab
CultureTabsList	CcoNarrativeViewerTabRecord (list)	Void	Returns a list of all CcoNarrativeViewerTabRecords for cultures in the current context
DlcTabsList	CcoNarrativeViewerTabRecord (list)	Void	Returns a list of all CcoNarrativeViewerTabRecords for dlcs in the current context
SetTabUsingKey	Void	String	Sets the current tab given a tab key
SetTabUsingContext	Void	CcoNarrativeViewerTabRecord	Sets the current tab given a tab record context
ContextSelectAppropriateTab	Void	Void	Selects an appropriate tab using the current campaign
EnableSubtitlesIfNecessary	Void	Void	Enables subtitles if the ENV_BOOL for subtitles is true or the language being used requires subtitles
CurrentPageSpread	Int	Void	Returns the current page spread as a number
PageSpreadsForSelectedTab	Int	Void	Returns the number of two page spreads to show for this tab

CcoNetworkPlayer

Wrapper for a player in the multiplayer system, can query current state, and send invites, view steam profile, etc

Functions

Name	Return Type	Arguments	Description
IsLocalPlayer	Bool	Void	Returns true if this player is the local player
SortId	Int	Void	Used for sorting in player lists. In frontend its just slot id, in battle its based on alliance/army, in campaign its based on team
IsOnline	Bool	Void	Returns true if this player is currently online
SessionPlayerId	Int	Void	Session player id for current game
TeamId	Int	Void	Returns team id for current game
CurrentGameControllableUnitList	CcoBattleUnit (list)	Void	Returns the units currently controllable by this player in a battle (either if active their armies units, or if passive participant the units they have been gifted)
AllianceColour	Colour	Void	Returns the alliance colour of this player in relation to local player
PlayerSlot	Int	Void	Slot id for current game
CurrentGameCampaignFactionContext	CcoCampaignFaction	Void	Returns the campaign faction for the player if they are currently in campaign
Id	String	Void	Unique mp client id
CurrentGameArmyContext	CcoBattleArmy	Void	Returns the battle army context for the player if they are currently in a battle
Name	UniString	Void	Display Name from mp client
AddAsFriend	Void	Void	Sends a friend invite via mp client
CurrentGameFactionRecordContext	CcoFactionRecord	Void	Returns the faction record for the player, if they are currently in a lobby (battle/campaign)
Invite	Void	Void	Sends a game invite to the player via mp client
ShowProfile	Void	Void	Shows the players profile in mp client (like steam overlay)
IsSpectating	Bool	Void	Returns true if this player is currently spectating in battle
IsPassiveParticipant	Bool	Void	Returns true if this player is currently a passive participant in battle (spectating but can receive units from active players to join in)
IsFriend	Bool	Void	Returns true if this player is a friend of the local player

CcoOwnershipProductRequirement

Wrapper for an ownership product mask

Functions

Name	Return Type	Arguments	Description	Tags	Events
OwnershipProductRecordList	CcoOwnershipProductRecord (list)	Void	Returns a list of CcoOwnershipProductRecord

CcoPieData

Functions

Name	Return Type	Arguments	Description	Tags	Events
SliceList	CcoPieSlice (list)	Void	Returns the list of pie slices (CcoPieSlice)

CcoPieSlice

Functions

Name	Return Type	Arguments	Description
Colour	Colour	Void	Returns the colour for the pie slice
Name	UniString	Void	Returns localised name for display on pie slice
Value	Float	Void	Returns the value for the pie slice

CcoRangeWithContext

Functions

Name	Return Type	Arguments	Description
PercentageOfTotal	Float	Void	Returns the percentage of the total difference between the ranges
RangeMax	Int	Void	Returns the max range value
RangeMin	Int	Void	Returns the min range value
Context	Context	Void	Returns the context associated with this range

CcoSavedCharacterInfo

Wrapper for a SAVED_CHARACTER_INFO struct

Functions

Name	Return Type	Arguments	Description
AgentSubtypeContext	CcoAgentSubtypeRecord	Void	Returns the agent subtype record context of the saved character
CanRecruit	Bool	Void	Returns true if the character can be recruited
BackgroundSkillRecordContext	CcoCharacterSkillRecord	Void	Returns the background skill record of the character
TooltipReason	UniString	Void	Returns a tooltip explaining why the character cannot be recruited, for campaign only
PortraitImagePath	String	Void	Returns portrait image filepath
RecruitmentCost	Int	Void	Returns an int with the cost to recruit this character
IsAgent	Bool	Void	Returns true if this character is an agent
CharacterTypeName	UniString	Void	Returns the localised character type name
CharacterTraitLevelList	CcoCharacterTraitLevelRecord (list)	Void	Returns a list of traits that the saved character has
UnitRecordContext	CcoMainUnitRecord	Void	Returns the main unit record for this saved character
UnitDetailsContext	CcoUnitDetails	Void	Returns the unit details associated with this unit
Name	UniString	Void	Returns the localised name of the saved character
AgentContext	CcoAgentRecord	Void	Returns the agent record context of the saved character

CcoScriptObject

Script adds these via script function effect.set_context_value.Then allows us to leverage context framework so for example could show fill bar for faction awesomeness without requiring any C++ code.Also these can be used in layouts for a global value registry system where can get/set arbitrary global values using ContextInitScriptObject in conjunction with other callbacks like ContextVisibilitySetter and ContextCommandLeftClick for example

Functions

Name	Return Type	Arguments	Description	Tags
LastComponentThatSetOurValue	String	Void	Returns the id of the last component that set our value	debug, hide_in_uied
NumericValue	Float	Void	Returns the numeric value of this script value
StringValue	String	Void	Returns the string value of this script value
Id	String	Void	Returns the unique key of this script object
SetStringValue	Void	ExpressionState, String	Sets the string value of the script object from the context system (instead of via script)
SetNumericValue	Void	ExpressionState, Float	Sets the numeric value of the script object from the context system (instead of via script)
TableValue	CcoScriptTableNode	Void	If script object for a table, returns root of table which is a recursive type which can point have child table nodes

CcoScriptObjectList

Used purely for Context viewer, has function to expose list of all script objects currently in cache so can track in context viewer

Functions

Name	Return Type	Arguments	Description	Tags	Events
ScriptObjectList	ContextList	Void	Returns the list of all script objects currently in cache so can track in the context viewer

CcoScriptTableNode

A wrapper for of a Lua Table, recursive type

Functions

Name	Return Type	Arguments	Description
HasValueForKey	Bool	String, Bool	Returns if there's a value for the key in the table value of the current node, can recurse through children.
FindValueForKey	ArgumentPack	String	Returns the value for the matching key in the table value of the current node if present, will traverse children using DFS.
ValueForKey	ArgumentPack	String	Returns the value for the matching key in the table value of the current node if present, doesn't traverse more nodes.
Key	ArgumentPack	Void	Returns the key of this node, can be a bool, String, numerical value, or another list of nodes
Value	ArgumentPack	Void	Returns the value of this node, can be a bool, String, numerical value, or another list of nodes

CcoShapeshiftForm

Temporary information about a shapeshifting form constructed with a form ancillary record

Functions

Name	Return Type	Arguments	Description	Tags
Equip	Void	Void	Equips this form for the players faction
DevUnlock	Void	Void	Unlocks this form for the current faction	debug, hide_in_ui
IsLocked	Bool	Void	Returns whether the form is locked for the current player
IsEquipped	Bool	Void	Returns whether the form is equipped for the current player
IsPartOfCulture	Bool	CcoCultureRecord	Returns whether this form is part of the given CcoCultureRecord
HasCharacter	Bool	Void	Returns whether there is a character on the map for this form
CharacterContext	CcoCampaignCharacter	Void	Returns the nearest CcoCampaignCharacter to the selected player for this form (or null)
CulturesPartOfList	CcoCultureRecord (list)	Void	Returns a list of CcoCultureRecords this form is part of
MatchesQuery	Bool	UniString	Returns whether this form should be in the list given a search string
AgentSubtypeRecordContext	CcoAgentSubtypeRecord	Void	Returns the associated CcoAgentSubtypeRecord
MainUnitRecordContext	CcoMainUnitRecord	Void	Returns the associated CcoMainUnitRecord
PortraitPath	String	Void	Returns the portrait path for this form. Looks in the 'ui/portraits/frontend_leaders' folder

CcoSliderValueContext

Functions

Name	Return Type	Arguments	Description	Tags	Events
SliderValue	Float	Void	Returns the percentage value of the slider

CcoSpineAnimationState

Wraps a spine animation state from a spine renderer

Functions

Name	Return Type	Arguments
SetEmptyAnimation	CcoSpineTrackEntry	Int, Float
SetAnimation	CcoSpineTrackEntry	String, Int, Bool
AddAnimation	CcoSpineTrackEntry	String, Int, Bool, Float
UpdateAnimation	Void	Float
Apply	Void	CcoSpineSkeleton
Track	CcoSpineTrackEntry	Int
ClearAnimations	Void	Int
AddEmptyAnimation	CcoSpineTrackEntry	Int, Float, Float

CcoSpineBone

Wrapper for a bone in spine that allows it to be modified through context

Functions

Name	Return Type	Arguments
SetRotation	Void	Float
WorldPosition	Vector4	Void
SetPosition	Void	Int, Int
Rotation	Float	Void

CcoSpineController

Wrapper for a spine rendering controller on a component

Functions

Name	Return Type	Arguments	Description
SetDockPoint	Void	String	Sets the spine dock point
SkeletonContext	CcoSpineSkeleton	Void	Returns the skeleton context of the spine controller
AnimationStateContext	CcoSpineAnimationState	Void	Returns the animation state context of the spine controller
SetAnimation	Void	String, Bool (optional), Int (optional)	Sets the spine animation on the component. Can pass it if it should loop (false by default) and also the track number (0 by default)

CcoSpineSkeleton

Wrapper for a skeleton in spine that allows it to be modified through context

Functions

Name	Return Type	Arguments
SetScale	Void	Vector2
SetToSetupPose	Void	Void
SetSkin	Void	String
Bone	CcoSpineBone	String
Scale	Vector2	Void
RootBone	CcoSpineBone	Void

CcoSpineTrackEntry

Wraps an animation track entry in spine

Functions

Name	Return Type	Arguments
CurrentAnimationName	String	Void
SetAnimationTimeScale	Void	Float
SetMixDuration	Void	Float
SetAnimationTime	Void	Float

CcoStringValue

Functions

Name	Return Type	Arguments	Description
FloatValue	Float	Void	Returns the numeric part of the value as a float
StringValue	UniString	Void	Returns the string part of the value
IntValue	Int	Void	Returns the numeric part of the value as an int

CcoSymbolTest

This is an example

Functions

Name	Return Type	Arguments	Description	Tags
id_args	Int	Int
VariadicArguments	Int	ArgumentPack
UsefulExtensionMethodWithConst	Bool	CcoSymbolTest
SameName	String	Void
GetContextIdOptional	Int	CcoSymbolTest (optional)
IsOptionalEmpty	Bool	CcoSymbolTest (optional)
UsefulExtensionMethod	Bool	CcoSymbolTest
ThisContext	CcoSymbolTest	Void
GetFloat	Float	Void		float, depreciated
GetString	String	Void		string, depreciated
GetInt	Int	Void		int, depreciated
Context	Context	Void
Ten	Int	Void
old	Void	Void
id	Int	Void	Useful function	debug, depreciated

CcoSymbolTestSecond

This is a second example

Functions

Name	Return Type	Arguments
id2	String	CcoSymbolTest
SameName	String	Void
id	String	CcoSymbolTest
Context	Context	Void

CcoTreeLink

Functions

Name	Return Type	Arguments	Description	Tags	Events
ParentContext	Context	Void	Returns the parent slot context linking from
ChildContext	Context	Void	Returns the child slot context linking to

CcoTreeLinkWithContexts

Functions

Name	Return Type	Arguments	Description
ChildContext	Context	Void	Returns the child context associated with the slot the link is going to
ParentContext	Context	Void	Returns the parent context associated with the slot from
ChildComponentContext	Context	Void	Returns the child component context the link is going to
ParentComponentContext	Context	Void	Returns the parent component context the link is from

CcoURI

Wrapper for a URI, allows access to fields and arguments provided

Functions

Name	Return Type	Arguments	Description
HasArgument	Bool	String	Return true if argument exists in query, otherwise false
Path	String	Void	Returns the URI's path, or empty if none
Argument	String	String	Return the value of the argument provided if it exists in URI
Scheme	String	Void	Returns the URI's scheme
Host	String	Void	Returns the URI's host, or empty if no authority

CcoUiWarning

Functions

Name	Return Type	Arguments	Description
Severity	String	Void	Returns the severity (high, medium, low) of this warning
ComponentContext	CcoComponent	Void	Returns the component context for this warning
Key	String	Void	Returns a key associated with this warning, unique within this type of warning (type + key is globally unique)
Description	String	Void	Returns a description of this warning
IsDisplayedInLocation	Bool	Void	Returns whether this ui warning is displayed in location
WarningType	String	Void	Returns the type of warning this is (category)
ToggleIsDisplayedInLocation	Void	Void	Toggles whether this ui location should be displayed in location

CcoUnitAbility

Wrapper for a BATTLE_SETUP_SPECIAL_ABILITY

Functions

Name	Return Type	Arguments	Description
BombardmentRecordContext	CcoProjectileBombardmentRecord	Void	Returns the bombardment record context for this ability
MiscastChance	Float	Void	Returns the chance that this unit ability will miscast
TimingDetailsText	UniString	Void	Returns the timing details text for this unit ability
MaxAffectedAllyCount	Int	Void	Returns maximum number of allies might be affected by this ability
ShouldShowTimingDetails	Bool	Void	Returns whether the timing details should be shown for this unit ability
ValidUsageDescription	UniString	ExpressionState	Returns the unit ability's valid usage description
MaxAffectedEnemyCount	Int	Void	Returns maximum number of enemies might be affected by this ability
AbilityGroupContext	CcoSpecialAbilityGroupRecord	Void	Returns the ability group context for this ability
ValidTargetDescription	UniString	ExpressionState	Returns the unit ability's valid target description
SharedRechargeTime	Int	Void	Returns the duration of shared time the unit ability takes to recharge when any other ability with shared cooldown is used
HasEnabledIfFlags	Bool	Void	Returns whether the unit ability has enabled if flags
SourceTypeName	UniString	Void	Returns the source type name of this unit ability
OpenSpellBrowser	Void	CcoMainUnitRecord (optional)	Opens the spell browser entry for this unit ability. Can supply an optional unit to open its page
TargetType	UniString	Void	Returns the unit ability's target type
WindUpTime	Int	Void	Returns the duration of time between triggering the unit ability and it actually being performed
IsHiddenInUI	Bool	Void	Returns whether this unit ability is hidden in the UI
TypeContext	CcoUnitAbilityTypeRecord	Void	Returns the unit ability's type as a CcoUnitAbilityTypeRecord cco
HasInvalidUsageFlags	Bool	Void	Returns whether the unit ability has invalid usage flags
Name	UniString	Void	Returns the name of the unit ability
HasSharedRechargeTimer	Bool	Void	Returns true if the ability has a shared cooldown
ActiveTime	Int	Void	Returns the duration of time that the unit ability is active
RechargeTime	Int	Void	Returns the duration of time the unit ability takes to recharge
HasInvalidTargetFlags	Bool	Void	Returns whether the unit ability has invalid target flags
TooltipText	UniString	Void	Returns the unit ability's tooltip
HasMirrorBehaviour	Bool	Void	Returns true if the ability has mirror behaviour associated with it
RecordKey	String	Void	Returns the unit ability's record key
AffectsAllies	Bool	Void	Returns whether allied units are affected by this ability
ManaUsed	Int	Void	Returns the amount of mana used by this unit ability
AdditionalUiEffectList	CcoUnitAbilitiesAdditionalUiEffectRecord (list)	Void	Returns the additional ui effect list of this unit ability
IconPath	String	Void	Returns the file path to the unit ability's icon
UpdatesEveryFrame	Bool	Void	Returns whether the unit ability updates every frame
HasAdditionalUiEffects	Bool	Void	Returns whether additional ui effects are present for this unit ability
SpreadRange	Int	Void	Returns how far this ability can spread (for hex abilities like contagion)
PhaseChannelList	CcoPair (list)	Void	Returns a list of CcoPair>; each channels name with the phases within that channel
TargetRange	Int	Void	Returns the maximum range of a target an ability can be used on
AffectsEnemy	Bool	Void	Returns whether enemy units are affected by this ability
NumUses	Int	Void	Returns the number of times this ability can be used. -1 indicates unlimited uses
AllChannelsPhaseList	CcoSpecialAbilityPhaseRecord (list)	Void	Returns a list of all CcoSpecialAbilityPhaseRecord from all channels
RechargeContextName	UniString	Void	Returns the recharge context details for this unit ability
IsPassive	Bool	Void	Returns whether the unit ability is passive
SpawnedUnitLandRecordContext	CcoUnitLandRecord	Void	Returns the unit ability's spawned unit as a CcoUnitLandRecord if it exists
MinimumRange	Int	Void	Returns the minimum range to use the ability
AffectsSelf	Bool	Void	Returns whether the unit ability affects the unit that triggered it
SpawnedMainUnitRecordContext	CcoMainUnitRecord	Void	Returns the unit ability's spawned unit as a CcoMainUnitRecord if it exists
IsTargetedAbility	Bool	Void	Returns whether this unit ability is targetted
UnitSpecialAbilityRecordContext	CcoUnitSpecialAbilityRecord	Void	Returns the unit special ability record
EffectRange	Int	Void	Returns the effect range of the ability
VortexRecordContext	CcoBattleVortexRecord	Void	Returns the vortex record context for this ability
AffectsOnlyEnemy	Bool	Void	Returns whether additional ui effects are present for this unit ability
SpecialAbilityBehaviourGroup	String	Void	Returns the special ability behaviour group key if possible (As a string)
AffectsOnlyFriendly	Bool	Void	Returns whether additional ui effects are present for this unit ability
ProjectileRecordContext	CcoProjectileRecord	Void	Returns the unit ability's projectile record context
CastRange	Float	Void	Returns the cast range of the unit ability
UniquenessRecordContext	CcoAncillaryUniquenessGroupingRecord	Void	Returns the uniqueness record context for this ability
EnabledIfDescription	UniString	ExpressionState	Returns the unit ability's enabled if description

CcoUnitAbilityDetails

Component context wrapper for unit ability details, any capability shown on unit info basically (traits, abilities, shot types, etc)

Functions

Name	Return Type	Arguments	Description	Tags
AbilityContext	CcoUnitAbility	Void	Returns the CcoUnitAbility associated with the unit ability details
IsLocked	Bool	Void	Returns true if this unit ability is locked
ShotTypesSoundCategory	String	Void	Returns the sound event related to this projectile shot type	sound
IsPassive	Bool	Void	Returns true if this unit ability is a passive ability
Tooltip	UniString	ExpressionState	Returns the localised tooltip of the unit ability
BehavioursSoundCategory	String	Void	Returns the sound event related to this ability behaviour	sound
Name	UniString	ExpressionState	Returns the localised name of this unit ability
State	String	Void	Returns active/inactive depending on if the unit ability is locked/unlocked
Icon	String	Void	Returns the icon path of the ability icon
Key	String	Void	Returns the key of this unit ability details
AbilityCollectionContext	CcoAbilityCollectionRecord	Void	Returns the CcoAbilityCollection associated with the unit ability details
ProjectileRecordContext	CcoProjectileRecord	Void	Returns the CcoProjectileRecord if the unit ability has a missile weapon record
CategoryStateName	String	Void	Returns the category state name this unit ability belongs to
CategoryStateList	CcoString (list)	Void	Returns a list of the ability categories

CcoUnitBulletPoint

Wrapper for a UI_UNIT_BULLET_POINT object

Functions

Name	Return Type	Arguments	Description
SortOrder	Int	Void	Returns the sort order of the bullet point
State	String	Void	Returns a string with the state of the bullet point
IconPath	String	Void	Returns a string with the icon path of the bullet point
LocalisedTextWithIcon	UniString (list)	Void	Returns a localised string with the name of the bullet point with the bullet icon in front
TooltipText	UniString	Void	Returns a localised string with the tooltip of the bullet point
LocalisedText	UniString	Void	Returns a localised string with the name of the bullet point

CcoUnitDetails

Component context wrapper for sharing common information for units of different types (battle, campaign, recruitable, etc) so can be shown on unit information panel as one type

Functions

Name	Return Type	Arguments	Description	Tags
HitPoints	Int	Void	Returns the number of hit points left in this unit
PurchasedEffectsList	CcoUnitPurchasableEffectRecord (list)	Void	Returns the list of effects purchased for this unit
BattleUnitContext	CcoBattleUnit	Void	Returns the CcoBattleUnit for this unit, if we're in battle	battle
ShowFoodCost	Bool	Void	Returns whether cost should be shown
BarrierMaxHp	Int	Void	Returns the max hp of the barrier attached to this unit
HealthBarColour	Colour	Void	Returns the colour of the alliance this unit belongs to	battle
BarrierHp	Int	Void	Returns the current hp of the barrier attached to this unit
Mass	Float	Void	Returns the mass of the unit
StatContextFromKey	CcoUnitStat	String	Returns the CcoUnitStat with the given key if it exists (and is visible) for this unit
BarrierHpPercent	Float	Void	Returns the current hp percent of the barrier attached to this unit
BaseStatContextFromKey	CcoUnitStat	String	Returns the base CcoUnitStat with the given key if it exists (and is visible) for this unit
HasExperience	Bool	Void	Returns whether the unit has experience
HealthTooltip	UniString	Void	Returns the health bar tooltip
BulletPointList	CcoUnitBulletPoint (list)	Void	Returns the bullet point list
UpkeepCost	Int	Void	Returns the upkeep cost of this unit
HasRandomisedSpells	Bool	Void	Returns true if the unit uses randomised spells on cast
StatList	CcoUnitStat (list)	ExpressionState	Returns the list of stats, such as weapon damage and defences, for this unit
HarmonyState	String	Void	Returns the state of the unit harmony(yin/yang) or empty if the unit doesn't have a harmony effect
KillCount	Int	Void	Returns the number of kills caused by this unit in a battle
IsBeingRecruited	Bool	Void	Returns true if the unit is being recruited
FoodCost	Int	Void	Returns the number of kills caused by this unit in a battle
AllianceColour	Colour	Void	Returns the colour of the alliance this unit belongs to	battle
Name	UniString	Void	Returns the localised name of this unit
ExperienceThreshold	Int	Void	Returns the threshold of the next level
IsKnownHp	Bool	Void	Returns whether the unit hp is known to the player
AbilityIconList	ContextList	Void	Returns the list of abilities attached to this unit
RecruitCost	Int	Void	Returns the recruit cost of this unit
BretonniaIconTooltipText	UniString	Void	Returns the text for bretonnia icon
IsPartOfTransportArmy	Bool	Void	Returns is the unit is part of a transport army
ExperienceEffectList	CcoStringValue (list)	Void	Returns the list of experience effects for this unit
IsLargeEntity	Bool	Void	Returns whether the unit is a large entity
PreBonusUnitDetailsContext	CcoUnitDetails	Void	Returns a CcoUnitDetails with the same unit details but without any previews
ExperienceScore	Int	Void	Returns the current experience of this unit
ExperienceRequiredForNextLevel	Int	Void	Returns the required experience to rank up
AbilityDetailsList	CcoUnitAbilityDetails (list)	Void	Returns the list of abilities attached to this unit
IsKnownXp	Bool	Void	Returns whether the unit xp known to the player
IsCharacter	Bool	Void	Returns true if this unit is a character
ExperienceProgress	Float	Void	Returns a percentage of how close this unit is to level up
UnitRecordContext	CcoMainUnitRecord	Void	Returns the CcoUnitRecord of this unit
CharacterContext	CcoCampaignCharacter	Void	Returns the CcoCampaignCharacter of this unit
IsBretonnianPeasant	Bool	Void	Returns whether the unit is a bretonnian peasant.
NumEntities	Int	Void	Returns the number of men alive in this unit
IsSpellBrowser	Bool	ExpressionState	Returns true if the spell browser is open
ComparisonContext	CcoUnitDetails	ExpressionState	Returns the comparison context of this unit compared to the currently pinned unit
HasComparison	Bool	ExpressionState	Returns true if a unit can be compared with another pinned unit
SetupUnitContext	CcoBattleSetupUnit	Void	Returns the CcoBattleSetupUnit
NumEntitiesInitial	Int	Void	Returns the number of initial men in this unit
ExperienceLevel	Int	Void	Returns the current experience level of the unit
AgentSubtypeAgentPairContext	CcoAgentSubtypeAgentPair	Void	Returns the CcoAgentSubtypeAgentPair of this unit
IsCampaign	Bool	Void	Returns true if we're in campaign
HitPointsInitial	Int	Void	Returns the number of initial hit points of this unit
HitPointsPercent	Float	Void	Returns the hit point percentage left
IsBattle	Bool	Void	Returns true if we're in battle
CampaignUnitContext	CcoCampaignUnit	Void	Returns the CcoCampaignUnit of this unit, if we're in campaign	campaign
ShowCost	Bool	Void	Returns whether cost should be shown
BaseStatValueFromKey	Int	String	Returns this unit's starting value of the given stat (key)
CharacterRank	Int	Void	Returns the rank of the commander of this unit, if in campaign	campaign

CcoUnitStat

Component context wrapper for a unit stat shown in stat list from CcoUnitDetails::StatList

Functions

Name	Return Type	Arguments	Description
ValuePercentHighest	Float	ExpressionState	Gets highest percentage for stat from either modified stat or base stat. Used for back fill bar so can see buffs/debuffs.
UnitDetailsContext	CcoUnitDetails	ExpressionState	Returns the CcoUnitDetails context of the unit detail that this stat belongs to
ValuePercent	Float	Void	Returns the current percentage of the stat
ModifierIconList	CcoUnitStatModIcon (list)	Void	Returns a list of stat modifier icons
ValuePercentBase	Float	ExpressionState	Returns percent value of stat with no mods/buffs/debuffs
ComparisonStatContext	CcoUnitStat	ExpressionState	Returns the CcoUnitStat of the compared unit stat
ComparisonModifierIconList	CcoUnitStatModIcon (list)	ExpressionState	Returns a list of stat modifier icons for compared stat
ValueBase	Float	ExpressionState	Returns value of stat with no mods/buffs/debuffs
MinValue	Float	Void	Returns the min value of the unit stat
Value	Float	Void	Returns returns the current value of the unit stat
DisplayedValue	Float	Void	Returns the displayed value of the unit stat, clamping it if necessary
ComparisonValuePercent	Float	ExpressionState	Returns the difference between this and compared stat's value in percentage
MaxValue	Float	Void	Returns the max value of the unit stat
ComparisonState	String	ExpressionState	Returns if stat is higher/lower/same than compared stat as a string
ComparisonValue	Float	ExpressionState	Returns the comparison value of this ability and pinned ability stat
Tooltip	UniString	Void	Returns the localised tooltip for the unit stat
Name	UniString	Void	Returns the name of the unit stat
SortOrder	Int	Void	Returns the sort order of the unit stat
Icon	String	Void	Returns the icon path
Key	String	Void	Returns the db key for the stat
IsPercentage	Bool	Void	Returns true if stat should be represented as a percentage
ValuePercentLowest	Float	ExpressionState	Gets lowest percentage for stat from either modified stat or base stat. Used for front fill bar so can see buffs/debuffs behind
PreBonusStatContext	CcoUnitStat	ExpressionState	Returns the CcoUnitStat of the unit stat without any previews

CcoUnitStatModIcon

Component context wrapper for a unit stat modifier icon

Functions

Name	Return Type	Arguments	Description
PhaseContext	CcoSpecialAbilityPhaseRecord	Void	Returns the CcoSpecialAbilityPhaseRecord for this stat modifier icon
Tooltip	UniString	Void	Returns localised tooltip
Icon	String	Void	Returns the icon path

Global Functions

flow

Name	Return Type	Arguments	Description	Tags	Events
Try	ArgumentPack	ExpressionState, Expression	Used to avoid asserts when calling an expression that is expected to fail on certain calls	flow

file

Name	Return Type	Arguments	Description	Tags	Events
FileExists	Bool	String, Bool (optional)	Returns true if specified file exists	file

random

Name	Return Type	Arguments	Description	Tags	Events
RandomInRange	Int	Int, Int	Returns a random number between [min,max]	random

chain_global

Name	Return Type	Arguments	Description	Tags	Events
HasFunction	Bool	String, ExpressionState	Returns true if the context has the specified function (passed in as a string)	chain_global

string

Name	Return Type	Arguments	Description	Tags
ParseTextReplacement	UniString	ExpressionState, UniString, ArgumentPack	Returns parsed text replacement tags in the given string and uses the list of overrides in priority order to retrieve the correct string	string
IsStringEmpty	Bool	UniString	Returns true if the string is empty	string, deprecated
FormatPercentage	UniString	Float	Returns a formatted percentage using ICU library.	string
ParseFactionTextReplacement	UniString	ExpressionState, UniString, CcoFactionRecord	Returns parsed text replacement tags in the given string and uses the faction record to retrieve the correct string	string
FormatPercentageCustom	UniString	Float, Int	Returns a formatted percentage using ICU library with the specified numebr of decimal places.	string
FormatNumberCustom	UniString	Float, Float	Returns a formatted number using ICU library.	string
FormatNumber	UniString	Float	Returns a formatted number using ICU library.	string
StringSubString	String	String, Int, Int (optional)	Returns a substring between the given start position and optional length	string, deprecated
StringLength	Int	String	Returns the length of the given string	string, deprecated
StringReplace	UniString	ExpressionState, UniString, UniString, UniString	Takes a source string as the first parameter, then replaces all instances of the second string param with the third string parameter	string, deprecated
Format	UniString	ExpressionState, UniString, ArgumentPack	Format the given string based on the argument list	string
StringEndsWith	Bool	ExpressionState, UniString, UniString	Returns true if the first string ends with the second string	string, deprecated
IsStringEmpty	Bool	String	Returns true if the string is empty	string, deprecated
StringContains	Bool	ExpressionState, UniString, UniString	Returns true if the first string contains the second string	string, deprecated
StringStartsWith	Bool	ExpressionState, UniString, UniString	Returns true if the first string starts with the second string	string, deprecated
ParseTextReplacements	UniString	ExpressionState, UniString	Returns a string that has had text replacements parsed (any text replacement tags will be replaced with actual text)	string, deprecated

debug

Name	Return Type	Arguments	Description	Tags
RunCLIMultiplayer	Void	String	Ssame as RunCLI but if mp campaign runs the command on all players games at the same time	debug
SearchContext	ContextList	String, String	Returns list of matching search result context objects, given the type and a search term which is used to check against object id and Name functions of object ids of this type. Used for dev tools search functionality to look for particular matching contexts with search text inputs for example	debug
RunCLI	Void	String	Runs console command supplied, but not in final release to avoid calling commands not meant to	debug
FindContext	Context	ExpressionState, String, String, Bool (optional)	Returns context given the type and object ids. Can also specify false as 3rd parameter to suppress errors if fail to find (otherwise defaults to error). Handy for debugging in context expression tester and creating own debug layouts, but NOT ADVISED use in layouts as ids can change and break layouts!	debug
Measure	String	ExpressionState, Expression	Used to wrap an expression and will return a string containing the number of milliseconds that execution took (the real return value is lost)	debug
Breakpoint	ArgumentPack	ExpressionState, Expression, Expression (optional)	Used to wrap an expression and will break in debugger before evaluation	debug

prefs

Name	Return Type	Arguments	Description	Tags
SetPrefAsBool	Void	String, Bool	Sets the specified boolean environment setting	prefs
SetPrefAsUniString	Void	String, UniString	Sets the specified unistring environment setting	prefs
SetPrefAsFloat	Void	String, Float	Sets the specified float environment setting	prefs
TogglePrefBool	Void	String	Toggles the specified boolean environment setting	prefs
PrefAsFloat	Float	String	Retrieve the specified environment setting as a float	prefs
PrefAsUniString	UniString	String	Retrieve the specified environment setting as a unistring	prefs
PrefAsInt	Int	String	Retrieve the specified environment setting as an int	prefs
SetPrefAsInt	Void	String, Int	Sets the specified int environment setting	prefs
PrefAsBool	Bool	String	Retrieve the specified environment setting as a bool	prefs

deprecated

Name	Return Type	Arguments	Description	Tags
FloatToPercent	Float	Float	Returns value *100...	math, deprecated
IsStringEmpty	Bool	UniString	Returns true if the string is empty	string, deprecated
StringSubString	String	String, Int, Int (optional)	Returns a substring between the given start position and optional length	string, deprecated
StringLength	Int	String	Returns the length of the given string	string, deprecated
StringReplace	UniString	ExpressionState, UniString, UniString, UniString	Takes a source string as the first parameter, then replaces all instances of the second string param with the third string parameter	string, deprecated
StringEndsWith	Bool	ExpressionState, UniString, UniString	Returns true if the first string ends with the second string	string, deprecated
IsStringEmpty	Bool	String	Returns true if the string is empty	string, deprecated
StringContains	Bool	ExpressionState, UniString, UniString	Returns true if the first string contains the second string	string, deprecated
StringStartsWith	Bool	ExpressionState, UniString, UniString	Returns true if the first string starts with the second string	string, deprecated
ParseTextReplacements	UniString	ExpressionState, UniString	Returns a string that has had text replacements parsed (any text replacement tags will be replaced with actual text)	string, deprecated

database

Name	Return Type	Arguments	Description	Tags
DatabaseRecordsForKeys	ContextList	String, ArgumentPack	Takes a database record wrapper context type id as the first parameter, then any number of keys to retrieve (CONTEXT_LIST DatabaseRecordsForKeys(String object_type, String db_key...))	database
DefaultDatabaseRecord	Context	String	Takes a database record wrapper context type id and returns the default record for this type.	database
DatabaseRecordContext	Context	ExpressionState, String, String	Takes a database record wrapper context type id and a db key, and returns the wrapper for that record	database
DatabaseRecords	ContextList	ExpressionState, String	Takes a database record wrapper context type id and returns a list of all the wrappers of this type.	database

context

Name	Return Type	Arguments	Description	Tags
IsCurrentContext	Bool	Context, ExpressionState	Returns true if supplied context is the top context on the stack (for things like when iterating through a list to check the current iterator basically)	context
StoredContextFromParentRequired	Context	ExpressionState, String	Returns the stored context of specified type from the specified parent, and will assert on failure	context
Generate	ContextList	ExpressionState, Int, Expression (optional)	Returns a list with the given context repeated N amount of times.	context
StoredContextFromParent	Context	ExpressionState, String	Returns the stored context of specified type from the specified parent	context
Join	ContextList	ExpressionState, ArgumentPack	Returns a context list of all the contexts of the functions passed as arguments	context
StoredContextRequired	Context	ExpressionState, String, String (optional), String (optional)	Returns the stored context specified by type id, from this component by default or by a target if specify target/parent ids, and will assert on failure	context
StoreList	CcoContextList	ContextList, String	Stores a context list with an id so you can easily retrieve it	context
EvaluateExpression	ArgumentPack	String, ExpressionState	Evaluates specified expression	context
StoredContext	Context	ExpressionState, String, String (optional), String (optional)	Returns the stored context specified by type id, from this component by default or by a target if specify target/parent ids	context
IsContextValid	Bool	Context	Returns true if specified context is not null	context
IsValidContext	Bool	ExpressionState	Returns true if we currently have a root context that isnt empty (our context has been set)	context

Misc

Name	Return Type	Arguments	Description
StopVfx	Void	Void
IsAnyHUDPanelOpen	Bool	Void	Returns true if any HUD panel is open
RegionRecordContextAtPosition	CcoRegionRecord	Vector4	Returns the CcoRegionRecord at the given position
AbilityApplyIntensity	Float	ExpressionState, Float	Returns the value of an effect multiplied by the current intensity (calculated from CcoBattleAbility stored in parent)
test_get_1	Context	Void
DevGetEntryOffset	Vector4	CcoComponent
EventFeedContext	CcoCampaignEventFeed	Void	Return the event feed context
Pause	Void	Void
SelectionManagingComponentContext	CcoComponent	Void
SetComponentDockPoint	Void	String
IsSkinActive	Bool	String	Returns whether the specified skin is currently being used
HasAnySavedGames	Bool	Void	Returns true if player has any saved games (for continue campaign functionality for example)
LogicalToDisplayPos	Vector4	Vector4, Bool (optional)	Converts a logical position to a display position for campaign
test_get_2	Context	Void
PlayFullscreenMovie	Void	String	Plays a fullscreen movie with supplied path, once movie finishes the movie player trashes itself
AddDefaultSkinPath	String	String	Adds default skin path to beginning of supplied image name (ui/skins/default/). Actually skinning handled internally so dont need to worry about that.
TestArgPack_Int	Int	ArgumentPack
OpenAcademy	Void	ExpressionState	Opens up the TW academy in the browser supplying the component clicked on so can open a relevant page
ShowBuildingBrowser	Void	CcoBuildingLevelRecord (optional)	Opens the building browser and passes the context of the building level if any has been provided
InPendingBattle	Bool	Void	Returns whether there is a pending battle going on
ToggleComponent	Void	ExpressionState, String	Similar to CreateComponent above, but if component already exists it will trash it. Added mainly to simplify dev ui creation.
test_get_3	Context	Void
LocalisedCommaWithSpace	UniString (list)	Void	Returns a localised comma: fullwidth in Chinese or halfwidth + space in other languages.
Distinct	ContextList	ContextList, ExpressionState, Expression (optional)	Returns the distinct elements of the list.
Pin	Void	Void
IsUnitPartOfSet	Bool	CcoCampaignUnit
SetVfxSpawnSpeed	Void	Float
PendingBattleEnemyFaction	CcoCampaignFaction	Void	Returns the current enemy faction to player in prebattle screen
StartAnimation	Void	Void
ContextObjectId	String	Context	Returns the unique name of the supplied context object within a type (such as the unique id of a particular CcoBattleUnit or a record key). Useful for script
SetExpanded	Void	Bool
Resume	Void	Void
CampaignRadarPosition	Vector4	Vector4	Converts a world position to a radar position (0-1 percent used for ContextRadarIcon)
OpenOverlayToUrl	Void	ExpressionState, String, Bool	Opens given url in overlay if available, if not in external browser
IsExpanded	Bool	Void
SelectContext	Void	Context
UpgradingUnitsContextList	CcoCampaignUnit (list)	Void
CloseSpellBrowser	Void	Void	Specific to WH3, Closes the spell/unit browser
GetValueAllocatedLower	Int	Void
ToggleHUDPanel	Void	String	Toggles the specified HUD panel
IsPlaying	Bool	Void
FreeFunction	Int	Int
test_get_0	Context	Void
InPostBattle	Bool	Void	Returns whether the current battle phase is post battle
LocalisedColonWithSpace	UniString (list)	Void	Returns a localised colon: fullwidth in Chinese or halfwidth + space in other languages.
SelectedSettlement	CcoCampaignSettlement	Void	Return the selected settlement if any
MainThemeBackgroundColour	Colour	ExpressionState	Returns the background theme colour, used in fullscreen panels, of the main theme skin
IsCameraHeightTransitioning	Bool	Void	Returns true if camera currently doing a height transition between tacmap and normal mode (camera locked to the height transition)
SortCombinedStringValueList	CcoStringValue (list)	ContextList	Sorts supplied string value list. Used for sorting combined string value lists (shouldnt need to use on normal lists as they should have it in the functions themselves)
ContextCacheId	String	Context	Returns the combination of ContextTypeId + ContextObjectId, which is used by script get_context_value to retrieve values so useful to be able to query.
IsTacticalMap	Bool	Void	Returns true if currently in tacmap view
OpenWarCoordinationPanel	Void	CcoCampaignFaction (optional)	Opens the war-coordination panel with faction pre-selected if given one.
SummedValueList	ContextList	ContextList, ExpressionState, Expression, Expression	Returns a list that has combined similar contexts.
ExportMetadata	Void	Void
SelectDropdownItem	Void	Context
HasPlayedMovie	Bool	Void
CameraPosition	Vector4	Void	Gets the position of the campaign camera
VramUsage	String	Void	Returns the current VRAM memory used (requested for GSAT autotest script for storing information for benchmarks)
SelectFirstVisible	Void	Void
GetText	UniString	Void
TargetSettlementContext	CcoCampaignSettlement	Void
PlayersFaction	CcoCampaignFaction	Void	Return the players faction context
Ten	Int	Void
SetValueAllocatedUpper	Void	Int, Bool (optional)
IsMultiplayerLobbyActive	Bool	Void	Returns true if a multiplayer lobby currently active, handy for checking if current game is multiplayer in frontend, battle or loading screens
RestartEmitter	Void	Void
KislevFollowersPercentage	Float	ExpressionState, CcoCampaignPooledResource	Specific function for kislev_winter panel, put in code as way too complicated/confusing to do as an expression. Takes pooled resource, and gets percentage compared the the campaign_group numeric ranges up to wh3_main_ksl_followers_tresholds_5
AvailableSkinList	CcoString (list)	Void	Returns list of available skins the game uses assuming that all skins have a folder in the skins/ folder
SelectAndShowDetailsForCharacter	Void	CcoCampaignCharacter, Bool (optional), Bool (optional)	Selects the passed in character and opens character details panel. Optional bool specifies whether to select the skill tab
GetEffectsList	ContextList	Void
ShouldShowShadowyDealingsInfo	Bool	Void	Returns true if should show shadowy dealings info, specific to some skaven factions in WH3
ShowCustomPrompt	Void	ExpressionState, String, String, UniString, UniString, Expression, Expression (optional), UniString (optional), UniString (optional), Context (optional)	Shows a prompt with two buttons.
Component	CcoComponent	String, String (optional), ExpressionState
Any	Bool	ContextList, ExpressionState, Expression	Returns true if at least one object of the list satisfies the given expression.
PlayVfx	Void	Void
BattleIsDisplayingAllUI	Bool	Void	Returns true if holding space shortcut to force display all UI
CampaignRoot	CcoCampaignRoot	Void	Return the root campaign context in campaign
SetValue	Void	Float
CampaignVariableIntValue	Int	String	Return an int value of the campaign variable passed in, if such variable exists
IsPlayingMovie	Bool	Void
IsOfType	Bool	Context, ArgumentPack	Returns true if the type of the given context is the one specified in the argument list.
CurrentSelectedComponents	CcoComponent (list)	Void
CameraTargetPosition	Vector4	Void	Gets the target position of the campaign camera
CanUseUiFeature	Bool	String, Context (optional)	returns true if faction has access to a UI Feature, don't use to block access to feature since players can then get around the DLC check
SelectContext	Bool	Context
HasTargetSelected	Bool	Void
IsContentLocked	Bool	String	Check if content is locked. WARNING - DO NOT RELY ON THIS AS ONLY MEANS OF LOCKING ACCESS TO CONTENT SINCE EASY TO MOD!
IsSimultaneousTurns	Bool	Void	Returns true if simultaneous turns mode
ShowEscapeMenu	Void	Void	Shows the Escape menu in battle/campaign
ApplyUiSkin	Void	String	Applies the supplied ui skin to the game
JoinString	UniString	ContextList, ExpressionState, Expression, UniString	Returns a string with each of the elements combined into a string with the given separator between each element.
GiftUnits	Void	Int (optional)
SetValueAllocatedLower	Void	Int, Bool (optional)
TooltipParent	CcoComponent	Void
ShouldShowWarCoordinationPendingRequest	Bool	Context	Used to determine when to show icons indicating there is a pending war coordination request for this target (target being the supplied force or settlement). Currently returns true if the target is a request from the faction talking to in diplomacy)
FreeContext	Context	Void
All	Bool	ContextList, ExpressionState, Expression	Returns true if all objects of the list satisfy the given expression.
IsLocChinese	Bool	Void	Returns true if using chinese
YearSeasonFormat	UniString	Int, UniString	Takes a year then season string, and puts in right order based on language (asian languages have other way around)
PassContext	Context	Context
ContextTypeId	String	Context	Returns the type name of the supplied context object (the class name, such as CcoBattleUnit). Useful for script
IsLoadingScreenActive	Bool	Void	Returns true if currently in the loading screen
OpenPanel	Void	String, ArgumentPack	Will open a specified panel with the given context list passed to the component. Can also optionally pass a bool before each context to specify if they should propagate or not
BattleRadarPosition	Vector4	Vector4	Converts world space position to 2d radar position percentage
QuitCampaign	Void	Void	Quits the current campaign
DeselectContext	Void	Context
InterpolateColours	Colour	Colour, Colour, Float	Returns the interpolation of two colours using specified colours and percent
IsLocalPlayersTurn	Bool	Void	Returns whether it is the local players turn
GameCoreContext	CcoGameCore	Void	Returns the game core context
RitualCastTimeLeft	Int	Void
GetContextObjectId	String	Context	Returns the object id of the given cco.
MinContext	Context	ContextList, ExpressionState, Expression	Returns the context with the smallest evaluated value (for example if MinContext(CeoList, RarityLevel) would return ceo context with smallest rarity level)
OpenCaravanRecruitmentPanel	Void	CcoCampaignSettlement	Opens the caravan recruitment panel
LoadSave	Void	String	Loads the specified save file
FormatTime	UniString	Float	Given a number in seconds, formats into minutes and seconds
SetValue	Void	Int, Bool (optional)
IsWarCoordinationOpen	Bool	Void	Returns true if war coordination panel open
MainThemeColour	Colour	ExpressionState	Returns the colour of the main theme skin
ShowPrompt	Void	ExpressionState, UniString, UniString, Expression, Expression (optional), UniString (optional), UniString (optional), Context (optional), String (optional)	Shows a prompt with two buttons.
FilterProfanity	UniString	UniString	Given some text, returns a filtered version of text replacing any profanity with *
IsUnitSelected	Bool	Void	Returns true if any unit is currently selected
InitialiseCamera	Void	Void
CentreOverTargetContext	Void	Float, Float, Float (optional), Float (optional), Bool (optional)	Centres the map 'camera' over the given world position. Can also pass a pixel offset and whether the transition is instant
SaveCampaign	Void	UniString	Saves game with specified name (used by script for example)
Kill	Void	Void
RitualCastTimePercentage	Float	Void
CanGiftUnitsToPlayer	Bool	Int
IsRefreshing	Bool	Void
QuitToMainMenu	Void	Void	Quits to frontend main menu from battle or campaign
MultiplayerRootContext	CcoMultiplayerRoot	Void	Returns the CcoMultiplayerRoot context, useful for getting information on current mp setup
SetMinSliderValue	Void	Int
IsSelected	Bool	Void
BattleCursorContext	CcoBattleCursorContext	Void	Gets the battle cursor context (mouseover info)
CompileExpression	ArgumentPack	String	Returns the list of symbols associated with the given cco.
IsTimeOfLegendsCampaign	Bool	Void	Returns true if currently playing a multiplayer time of legends campaign
IsHumanPlayersTurn	Bool	Void	Returns whether it is any human players turn (local player or another human in mpc)
OpenShadowyDealingPanelForCurrentTarget	Void	Void	Opens the shadowy dealings with the current selection as a target
CurrentSkin	String	Void	Returns the current UI skin
IsCampaignOverlayShowing	Bool	Void	Returns true if campaign overlay showing (when hold space)
Filter	ContextList	ContextList, ExpressionState, Expression	Returns a list with all the elements of the given list that satisfy the condition.
SkipReveal	Void	Void	Skips the reveal of text, shows all the text
MaxContext	Context	ContextList, ExpressionState, Expression	Returns the context with the largest evaluated value (for example if MaxContext(CeoList, RarityLevel) would return ceo context with largest rarity level)
StringExists	Bool	String	Returns true if supplied string key exists. Will search all tables (key is in format tablename_fieldname_recordkey)
GetValue	Float	Void
ToUpperCase	UniString	UniString	Convert string to an uppercase string
ZoomToDefaultCameraHeight	Void	Void	Zooms the camera to the default camera height
IsMultiplayer	Bool	Void	Returns true if current game mode is multiplayer (in battle or campaign)
ClosePanel	Void	String, Bool (optional)	Will close a specified panel
DiplomacyLoc	UniString	ArgumentPack	Returns a localised string in the diplomacy_strings table given key
SetMaxSliderValue	Void	Int
InitialiseIntriguePanel	Void	Void
CurrentSelection	CcoContextSelection	Void
GetColour	Colour	String	Returns the colour of the given key from the ui_colours table
BattleSelectionContext	CcoBattleSelection	Void	Gets the battle selection context (info on what is selected, commands to select, etc)
IsChildOfAnySearchResult	Bool	ExpressionState, CcoComponent
ChangeCursorSize	Void	Int	Sets the cursor scaling setting. 0-default, 1-2k, 2-4k
RetrieveSymbolsList	ContextList	Context	Compiles the given expression and returns it as a CcoContextExpression. If it fails to compile, it will return a list of CcoContextExpressionCompilationError instead.
MinValue	Float	ContextList, ExpressionState, Expression	Returns the smallest evaluated value (for example if MinValue(CeoList, RarityLevel) would return smallest rarity level)
ResetReveal	Void	Void	Resets the text reveal, starts from beginning again
LocLanguage	UniString	Void	Returns the localisation language the game is using
DirectoryFileList	CcoString (list)	String, String, Bool	Returns list of files in specified directory
CloseDiplomacyPanel	Void	Void	Closes the diplomacy panel if it's currently open
CloseAllPanels	Void	Void	Closes all open panels
IsParchmentOnlyCameraHeight	Bool	Void	Returns true if the current camera height is the parchement only height
LocalisedDateFormat	String	Void	Returns the localised date format
IsTutorial	Bool	Void	Returns true if current game mode is part of the prologue/tutorial (in battle or campaign)
ClearSelectionForParent	Void	String, String
SetEnabled	Void	Bool
CampaignKey	String	Void	Returns the campaign key
IsDemoUIEnabled	Bool	Void	Returns true if demo ifdef enabled for bespoke demos
IsShrouded	Bool	Vector4	Returns true if the specified display/real position is covered under the shroud
IsWaaaghActive	Bool	Void
CurrentColour	Colour	Void
MaxValue	Float	ContextList, ExpressionState, Expression	Returns the largest evaluated value (for example if MaxValue(CeoList, RarityLevel) would return largest rarity level)
Value	Int	Void
TooltipParent	CcoComponent	Void	Returns the component that created this ContextLayoutTooltip
CloseUnitRecruitmentPanel	Void	Void	Closes the unit recruitment panel if it's currently open
SetVfxPosition	Void	Float, Float, Float
PlayerArmy	CcoBattleArmy	Void	Gets the players army context in battle
Loc	UniString	String, ArgumentPack	Returns a localised string for supplied key. In campaign will check campaign_localisation_strings first. After that will use random_localisation_strings table
IsCellUnlocked	Bool	Void
ShortcutKeyList	CcoString (list)	String	Returns keys involved for primary shortcut as separate string values so can show keys (modifier and shortcut) as separate entries (so look like keyboard keys)
ZoomToTacticalView	Void	Void	Zooms the camera to the tactical view
TargettingContext	Context	Void	Returns the context of the current targetting interface if there is one(for example if targetting war coordination might return the CcoCampaignFactionInteraction currently targetting this
IsSearchActive	Bool	Void
Value	Int	Void
SetSelected	Void	Bool, Bool (optional)
NameOfCampaignLocation	UniString	Vector4	Gets the region or sea region name at specified location
IsPanelOpen	Bool	String (optional), Bool (optional)	Returns true if specified panel is open, or if any are open if none specified
BattleAiStatsModifierFromDifficulty	Float	Int	Returns a float with the battle ai stats modifier converted from the passed in difficulty
LockCursor	Void	String	Locks cursor to specified type
ClearSelection	Void	Bool (optional)
PlayOneShotAnimation	Void	Void
RefreshValues	Void	String
Skip	ContextList	ContextList, Int	Skip the first x elements of the list.
CloseUnitInfoPanel	Void	Void	Closes the Unit info panel type.
ClearSearchResults	Void	Void
SetVfxScale	Void	Float
CurrentNegotiatingFactionContext	CcoCampaignFaction	Void	Returns the faction currently negotiating with in diplomacy
ColourProfile	String	Void	Returns the current colour profile setting
StringGet	UniString	String	Returns a string for supplied key. Will search all tables (key is in format tablename_fieldname_recordkey)
LookUpTechnology	CcoCampaignTechnology	CcoTechnologyRecord	Returns a CcoCampaignTechnology given a provided CcoTechnologyRecord.
ZoomToMaxCameraHeight	Void	Void	Zooms the camera to the max height
ValueMax	Int	Void
SetVfxVelocity	Void	Float, Float, Float
ScrollByValue	Void	Int, Bool (optional)
PlayerAlliance	CcoBattleAlliance	Void	Gets the players alliance context in battle
UnlockCursor	Void	Void	Unlocks the cursor
Sum	ArgumentPack	ContextList, ExpressionState, Expression	Returns the numerical sum of the transformed elements.
IndexOfEntry	Int	Context
IsInSearchResults	Bool	ExpressionState, CcoComponent
Partition	ContextList	ContextList, ExpressionState, Expression	Reorders the elements in such a way that all elements for which the predicate returns true precede the elements for which predicate p returns false.
IsBenchmark	Bool	Void	Returns true if current game mode is a benchmark (in battle or campaign)
DiplomacySelectedFactionContext	CcoCampaignFaction	Void	Returns the faction currently selected in diplomacy
SetSelectedState	Void	Bool
SelectionParentContext	CcoComponent	Void
CloseCurrentHUDPanel	Void	Void	Closes the currently opened HUD panel
FrontendRoot	CcoFrontendRoot	Void	Gets the frontend root context in frontend (handy starting point for all things frontend related)
DoesGUIDExist	Bool	String, ExpressionState	Returns true if a component with the given GUID exists.
CloseAllContextLayoutTooltips	Void	Void	Closes any open ContextLayoutTooltips anywhere in the UI
SetVfxOrientation	Void	Float, Float, Float
ShowTechTree	Void	CcoTechnologyRecord (optional)	Opens the tech tree. Opens to specified tech if optionally provided
UiMsgCampaignCommand	Void	String	Similar to UiMsg in that it broadcasts the specified string as a UI_UPDATE_MSG to allow anything to react to it, but sends the message through the command system so can use to say perform a command and send a message for things to react once that command has been processed since order guaranteed!
SetValue	Void	Int, Bool (optional)
ScriptLockList	String	Void	Returns a list of all script locks that are currently active, in case want to check a few and save typing in IsScriptLockActive for them all
PooledResourceTransferContext	CcoPooledResourceTransfer	String	Returns a Cco holding the state of the current pooled resource transfer
ZoomToPoint	Void	Vector4	Zoom to the specified location
ScriptObjectContext	CcoScriptObject	String	This is a way to lookup a CcoScriptObject context via id for use in expression. Consider using ContextInitScriptObject if want automatic updates and trivial function
CopyStringToClipboard	Void	UniString	Copies the supplied text to the clipboard for pasting
DevGetEntryTierPos	Vector4	CcoComponent
OpenUnitInfoPanel	Void	Context	Opens the unit info panel.
UiMsg	Void	String	Triggers the specified UI_UPDATE_MSG event
CurrentSearchResults	CcoComponent (list)	Void
ShortcutKey	UniString	String	Returns current key as string for the specified shortcut
RemovePin	Void	Void
CampaignBattleContext	CcoCampaignBattle	Void	Returns the CcoCampaignBattle singleton if we are in a pending battle
EnemyAlliance	CcoBattleAlliance	Void	Gets the enemy alliance context in battle
ExprToJSON	String	String
FindCharactersOfUnit	CcoCampaignCharacter (list)	CcoMainUnitRecord, Bool (optional)	Tries to find characters with the given main unit record, returns a list of any found. Can optionally just get the first one found
RegionSlotFromBuildingChain	CcoCampaignBuildingSlot	CcoBuildingChainRecord	Returns the slot that contains a building from the given chain
SelectedComponents	CcoComponent (list)	Void
SettlementAtPoint	CcoCampaignSettlement	Vector4	Returns the settlement context at the specified position
Take	ContextList	ContextList, Int	Returns the first n elements of the list.
WorldSpaceToScreenSpace	Vector4	Vector4, Bool, Bool	Returns the screen space position for specified world position
Double	Int	Int
TriggerScriptEvent	Void	String	Sends a UITrigger event with the specified key to script for script to handle (useful for contexts interacting with script). In campaign will go via command queue.
FreeSecond	Context	Void
GetPaddingDimensions	Vector2	Void
CloseInfoPanel	Void	String	Closes the specified info panel type.
NumberOfCookedRecipes	Int	Void
PasteStringFromClipboard	UniString	Void	Returns the text currently in the clipboard
SearchForComponentWithPredicate	Void	ExpressionState, String
ScrollToComponent	Void	CcoComponent, Bool (optional)
IsSelected	Bool	Void
ForceContainsUpgradableUnits	Bool	Void
FactorBreakdown	CcoFactorBreakdown	ContextList, String, String	Returns a CcoFactorBreakdown created with context_lists passed as arguments.
TrueRandomInRange	Int	Int, Int	Returns a true random number (different each game session) in the given range
HandleEquip	Void	Void
SetVfxColourAlpha	Void	Float
BattleRoot	CcoBattleRoot	Void	Gets the battle root context in battle (handy starting point for all things battle related)
IsAnyTeleportHUDPanelOpen	Bool	Void	Returns true if any teleport HUD panel is open
GetList	ContextList	Void
ShapeshiftFormsThisCampaignList	CcoShapeshiftForm (list)	Void	Returns a list of CcoShapeshiftForms in this campaign
CampaignModelRoot	CcoCampaignModelRoot	Void	Return the root campaign model context in campaign
Select	Void	Void
SelectedComponent	CcoComponent	Void
ScrollToValue	Void	Int, Bool (optional)
FreeCcoSymbolTest	Context	Void
SetScriptLock	Void	String, Bool	Sets episodic script override flag to be enabled / disabled specified by key
DevAdjustTierPos	Void	CcoComponent, Int, Int
ShowEncyclopedia	Void	String	Opens the encyclopedia.
RetrieveSelectedItemList	ContextList	ExpressionState, String, String (optional)	Returns the list of selected items from the ContextSelectionManager provided.
Skeleton	CcoSpineSkeleton	Void
SelectedCharacter	CcoCampaignCharacter	Void	Return the selected character if any
test_get_lists	Context	Void
CurrentInspectedContext	Context	Void
ResetUnitCardStates	Void	Void
SetMaxRangeValue	Void	Int, Bool (optional)
OpenUnitBrowser	Void	CcoFactionRecord	Specific to WH3, opens unit browser, and if a CcoCultureRecord is specified selects that culture to view units for
IsComponentCloseToCursor	Bool	ExpressionState, Int	Returns if the Component's centre is within the distance given in the args
SelectButton	Bool	CcoComponent
TestReturnAny	ArgumentPack	Void
Transform	ContextList	ContextList, ExpressionState, Expression	Transforms the list into a new one where each element is produced by the given expression (like the map function).
EltharionChallengeRecipeNumber	Int	Void
rule_test	Bool	Void
DistanceToCamera	Float	Vector4	Returns distance of specified position from camera
IntensitySettingContext	CcoSpecialAbilityIntensitySettingRecord	ExpressionState	Returns the ability intensity setting context (from either the CcoBattleAbility or CcoBattleUnitEffect stored in the parent
SetVfxSpawnRateScaleFactor	Void	Float
SelectedOrContainedCharacter	CcoCampaignCharacter	Void	Returns either the contained character(agent) if exists, or the selected character if any
JadeDatabaseContext	CcoJadeDatabase	Void	Returns the CcoJadeDatabase
CalculateUnitsInUnitSet	CcoMainUnitRecord (list)	String, String (optional)	Returns a list of units contained in the given unit set. This is an expensive query for dev use, do not use it in panel contexts
ForEach	Void	ContextList, ExpressionState, Expression	Performs expression on each context in list (for giving commands to multiple contexts)
ClearStoredTechRecords	Void	Void
SelectedContexts	ContextList	Void
test_get_4	Context	Void
ScrollToComponent	Void	CcoComponent
ClearPin	Void	Void
StorePlatformId	String	Void	Returns the id of the platform currently playing on (e.g. steam, epic, microsoft)
AnimationState	CcoSpineAnimationState	Void
PlayMovie	Void	Void
ColourTextForCurrentSkin	UniString	UniString	Replaces colour tags with dark colour versions if the current skin is not wh3.
UnitAbilityContextFromString	CcoUnitAbility	String	Creates CcoUnitAbility for ability with specified key
test_get_5	Context	Void
TestReturnAnyTypes	ArgumentPack	Int
AnySelected	Bool	Void
IsHUDPanelOpen	Bool	String	Returns true is the specified HUD panel is open
PanelContext	CcoComponent	String	Returns the CcoComponent context of the specified panel if it's open
SetVfxColourTint	Void	Colour
SaveRadarImage	Void	Void
test_get_6	Context	Void
ShowBattleObjective	Void	UniString, Int	Shows a battle objective (handy for testing out show_objective script func and historical_objective_panel layout). Takes a message to display and a duration in ms for how long to show for
Close	Void	Void
SetMinRangeValue	Void	Int, Bool (optional)
UnitUpgradeManagerContext	CcoCampaignUnitUpgradeManager	Void	Returns the CcoCampaignUnitUpgradesManager.
ShouldShowMission	Bool	CcoCampaignMission
LoadMetadata	Void	Void
CampaignMinimapZoomScale	Float	Void	Returns the current zoom scale for the minimap
IsWorldPositionOnScreen	Bool	Vector4, Vector2 (optional), Bool (optional), Float (optional)	Returns true if the given world position is on screen. If required, can extend screen size by a given amount, take into account camera fading and offset the distance that objects are faded out.
HasRecipeBeenCooked	Bool	CcoCookingRecipeRecord
CustomBattleShapeshiftFormsList	CcoShapeshiftForm (list)	Void	Returns a list of forms avaialable for custom battle as CcoMainUnitRecords
CurrentSelectedContext	Context	Void
TryEnsureUpgradableUnitsSelected	CcoCampaignUnit	Void
IsShowingExpandedUnitInfo	Bool	ExpressionState	Specific to WH3, added to ensure multiple places that use keep in sync. Returns true if in custom battle and 1080p or above res, determines when to show abilities at same time as stats on unit info panel
StopMovie	Void	Void
SelectedProvince	CcoCampaignProvince	Void	Return the selected province if any
DevAdjustOffset	Void	CcoComponent, Int, Int
GetValueAllocatedUpper	Int	Void
InputSetText	Void	UniString
IsScriptLockActive	Bool	String	Returns true if specified script ui override is currently set to locked by script
TestArgPack_String	String	ArgumentPack
IsFullscreenPanelOpen	Bool	Void	Returns true if a fullscreen panel is open
ClearSelection	Void	Void
ExpectedSymbol	String	String, String
CanShowEvents	Bool	Void	Returns true if can currently show events

sound

Name	Return Type	Arguments	Description	Tags
StopLoadingScreenMusic	Void	Void	Stop playing loading screen music	sound
StopLoadingScreenSound	Void	Void	Stops a specified sound in loading screen	sound
StopLoadingScreenVoiceover	Void	Void	Stop playing loading screen voiceover	sound
PlayLoadingScreenSound	Void	String	Plays a specified sound in loading screen	sound

math

Name	Return Type	Arguments	Description	Tags
FloatToPercent	Float	Float	Returns value *100...	math, deprecated
Clamp	Float	Float, Float, Float	Clamps a float between two values	math
Abs	Float	Float	Returns the absolute of the value passed in	math
Cos	Float	Float	Computes cosine of number	math
Ceiling	Int	Float	Ceilings a float and returns it as an int	math
Floor	Int	Float	Floors a float and returns it as an int	math
RoundFloat	Int	Float	Rounds a float to nearest int	math
Mod	Int	Int, Int	Modulus operation. Takes the number and the value to mod by	math
Trunc	Int	Float	Looses the fractional part of the number	math
RadiansToDegrees	Float	Float	Converts radians to degrees	math
MidPoint	Vector4	Vector4, Vector4	Returns vector3 middle point between two vector3 points (takes vector4s but ignores the w	math
DegreesToRadians	Float	Float	Converts degrees to radians	math
ArcTan	Float	Float	Computes arc tangent of number	math
ArcTan2	Float	Float, Float	Computes the arc tangent of y / x using the signs of arguments to determine the correct quadrant	math
Sin	Float	Float	Computes sine of number	math
MaxNumericValue	Float	Float, Float	Takes 2 numbers and returns max value (called this instead of Max to not conflict with existing member functions which is an issue in runtime objects currently)	math
ArcCos	Float	Float	Computes arc cosine of number	math
IntMax	Int	Void	Returns maximum integer value	math
MinNumericValue	Float	Float, Float	Takes 2 numbers and returns min value (called this instead of Min to not conflict with existing member functions which is an issue in runtime objects currently)	math
Tan	Float	Float	Computes tangent of number	math
Percentage	Float	Float, Float	Returns percentage of first value number against second value which is total (with guard against divide by zero	math
ArcSin	Float	Float	Computes arc sine of number	math

registry

Name	Return Type	Arguments	Description	Tags
SharedStateWriteBool	Void	String, Bool	Takes a String id, and writes supplied bool value to shared state with that key (void SharedStateWriteBool(String key, bool value))	registry
RegistryReadInt	Int	String	Takes a String id, and returns stored integer value in registry with that key (int RegistryReadInt(String key)). Value will be -1 if doesnt exist in registry.	registry
RegistryWriteString	Void	String, String	Takes a String id, and writes supplied String value to registry with that key (void RegistryWriteInt(String key, String value))	registry
IsFirstTime	Bool	String	Takes a String id, checks if this value is in registry and if not returns true. Then sets value in registry. Use for showing components or setting states for first time in panels, etc	registry
RegistryWriteInt	Void	String, Int	Takes a String id, and writes supplied integer value to registry with that key (void RegistryWriteInt(String key, int value))	registry
SharedStateValueExists	Bool	String	Takes a String id, and returns if there's any state stored with that id (bool SharedStateReadBool(String key)).	registry
SharedStateReadFloat	Float	String	Takes a String id, and returns stored float value in shared state with that key (int SharedStateReadFloat(String key)). Value will be -1 if doesnt exist in registry.	registry
SharedStateReadBool	Bool	String	Takes a String id, and returns stored bool value in shared state with that key (bool SharedStateReadBool(String key)). Value will be false if doesnt exist in registry.	registry
ScriptedValueRegistryReadBool	Bool	String	Takes a String id, and returns the stored Bool value in the registry for that key (Bool RegistryReadInt(String key))	registry
SharedStateWriteFloat	Void	String, Float	Takes a String id, and writes supplied float value to shared state with that key (void SharedStateWriteFloat(String key, float value))	registry
RegistryReadString	String	String	Takes a String id, and returns stored String value in registry with that key (String RegistryReadInt(String key)). Value will be String::empty_string() if doesnt exist in registry.	registry

flow

Name	Return Type	Arguments	Description	Tags
GetIfElse	ArgumentPack	ExpressionState, Expression, Expression, Expression	If the conditional expression is true it will get value of the second expression otherwise the value of the third.	flow
GetIf	ArgumentPack	ExpressionState, Expression, Expression	Will return the value of the expression only if the condition is true.	flow
DoIf	Void	ExpressionState, Expression, ArgumentPack	Runs the given expressions only if the condition is true	flow
DoIfElse	Void	ExpressionState, Expression, Expression, Expression	Evaluates condition (1st param), calls first expression (2nd param) if true, second expression (3rd param) if false	flow
Do	Void	ArgumentPack	Simple way to join multiple commands in a single expression	flow

convert

Name	Return Type	Arguments	Description	Tags
MakePair	CcoPair	ExpressionState, Expression, Expression	Creates a CcoPair from the two parameters passed in	convert
ToVector	Vector4	ArgumentPack	Convert set of numbers to a vector (up to 4)	convert
ToNumber	Float	String	Convert a string to a floating point number	convert
ToVector4	Vector4	Float, Float, Float, Float	Convert set of numbers to a vector4 (up to 4)	convert
MakePie	CcoPieData	ExpressionState, ContextList, Expression, Expression, Expression	Creates a CcoPieData from function	convert
ToVector2	Vector2	Float, Float	Convert set of numbers to a vector2 (up to 2)	convert
ToVector3	Vector3	Float, Float, Float	Convert set of numbers to a vector3 (up to 3)	convert
CreateSelectionList	CcoContextSelection	ContextList	Creates a CcoContextSelection from a CONTEXT_LIST	convert
ToColour	Colour	Int, Int, Int, Int (optional)	Convert a set of numbers (0-255) to a colour (rgba, a is optional and defaults to 255 if not specified)	convert

component

Name	Return Type	Arguments	Description	Tags
CreateComponent	Void	ExpressionState, String, CcoComponent, ArgumentPack	Creates a component from specified layout, with specified parent as second param (use RootComponent for this param to just create as child of root); and will pass any number of optional contexts to the created layout, handy for testing out layouts without having to go through repro steps (can use CcoComponent::SetContext to then give context to fully test)	component
CurrentMouseOverComponentContext	CcoComponent	Void	Returns current component mouseover	component
RootComponent	CcoComponent	Void	Returns context of the root component	component
CurrentDisabledMouseOverComponentContext	CcoComponent	Void	Returns current disabled component mouse over	component

tweakers

Name	Return Type	Arguments	Description	Tags
TweakerAsInt	Int	String	Retrieve the specified tweaker as an int	tweakers
TweakerAsBool	Bool	String	Retrieve the specified tweaker as an bool	tweakers
TweakerAsFloat	Float	String	Retrieve the specified tweaker as an float	tweakers

Battle

CcoBattleAbility

Component context wrapper for a battle ability (EMPIREBATTLE::ABILITY_DETAILS) which has live information for an ability like cooldown time, etc. exposes all information available to UiEd

Functions

Name	Return Type	Arguments	Description
ActivePhaseList	CcoPair (list)	Void	Returns list of CcoPair; the active phases for each target essentially
IsRechargeEnabled	Bool	Void	Returns true if all recharge contexts for this ability are true (eg engaged in melee)
IsPhaseActive	Bool	CcoSpecialAbilityPhaseRecord	Returns true if supplied CcoSpecialAbilityPhaseRecord is active in any of abilities phase trees
IntensityCanDecay	Bool	Void	Returns true if ability's intensity can decay
IsActive	Bool	Void	Returns true if this abiltiy is currently active and applying its effects
TimeUntilIntensityDecay	Int	Void	Returns amount of time (in seconds) until intensity decay starts
IsTargettedAbility	Bool	Void	Returns true if this is an ability that you have to select a target for
IsReignOfChaosReward	Bool	Void	Returns true if this is an amry ability that can be rewarded as a reign of chaos outcome
EffectRange	Float	Void	Returns the range in metres that this ability will affect from the cast point
DefaultIntensity	Float	Void	Returns the starting/default intensity that modifiable stats of this ability will be multiplied by
HasLimitedUses	Bool	Void	Returns true if the ability has a limited number of uses (queried by RemainingUses)
MaxIntensity	Float	Void	Returns the maximum intensity that modifiable stats of this ability will be multiplied by
RemainingUses	Int	Void	Returns the number of remaining uses, -1 if unlimited
CanBePurchased	Bool	Void	Returns true if this ability can currently be afforded based on any required currencies (see CurrencyCosts)
CurrentState	String	Void	Returns a String representing the current state (active/passive/selected/inactive
IsCurrentlyTargetting	Bool	Void	Returns true if this ability is currently being targetted by the player
Intensity	Float	Void	Returns the intensity that modifiable stats of this ability will be multiplied by
WindUpTimeRemainingSecs	Float	Void	Returns the wind up time remaining in seconds. Wind up is the casting time essentially.
WindUpPercent	Float	Void	Returns the wind up percentage (0-1), 0 being not in windup and 1 being at the point where casts the spell. Wind up is the casting time essentially.
RechargeDisabledReasonsText	UniString	Void	Returns joined localised string of disabled reasons for this ability, if any (in melee, etc)
CurrencyCosts	CcoPair (list)	Void	Returns a list of CcoPair representing the costs required to activate this ability
RechargeTimeRemainingSecs	Float	Void	Returns the cooldown time remaining seconds if ability is in cooldown
MiscastChance	Float	Void	Returns 0-1 value representing how likely to miscast when activate. A miscast will have negative impacts on the caster and the ability will fail to activate.
RechargePercent	Float	Void	Returns the cooldown percentage if in cooldown (0-1), 0 if not in cooldown
ManaUsed	Int	Void	Returns how much mana is used when activating this ability
LeftClickText	UniString	Void	Returns some localised text that explains what left clicking on a button for this ability would currently do (activate, toggle targetting, toggle overcharge, etc)
IntensityDecayTimerStarted	Bool	Void	Returns true if the timer for the intensity decay has started
ActiveTimeRemainingSecs	Float	Void
FillPercent	Float	Void	This is used for circular fills on 3k, where when ability active we unfill the ring (anti-clockwise), then when in cooldown we fill the ring (clockwise), and show the ring full while ability available (so transitions between cooldown being over and ring staying there)
ActivePercent	Float	Void	Returns the percent (0-1) the ability is through its active duration (progression until ability finishes), 0 if ability is not currently active
CanCurrentlyPerform	Bool	Void	Returns true if abiltiy can currently be activated
PerformAbilityForOwner	Void	Void	Activates the ability for the owner (unit/army)
IntensityDecayIsActive	Bool	Void	Returns true if intensity decay is active for the ability
SetupAbilityContext	CcoUnitAbility	Void	Returns the CcoUnitAbility setup for this ability (fixed information that doesnt change during the battle)

CcoBattleAlliance

Component context wrapper for a battle alliance, exposes all information available to UiEd

Functions

Name	Return Type	Arguments	Description	Tags
IsDefender	Bool	Void	Returns true if this faction is the defender in the battle
NumEntitiesInitial	Int	Void	Returns the number of entitie this alliance started the battle with
NumUnits	Int	Void	Returns the number of units in this alliance
NumEntities	Int	Void	Returns the number of entities in this alliance
CpKillScore	Int	Void	Returns the score for this alliance, the higher the better the alliance performed (earned by unit experience and capturing capture points)
NumArmies	Int	Void	Returns the number of armies in this alliance
TicketsIncomePerSecond	Int	Void	Returns the total capture point tickets income rate, per second.
StartingTickets	Int	Void	Returns the capture point tickets started the battle with
Id	Int	Void	Returns the index of this alliance
TicketsRemaining	Int	Void	Returns the capture point tickets remaining (when 0 lose if defending)
DevWinBattle	Void	Void	For dev purposes, forces win for this alliance by killing all units on other alliances in battle	hide_in_uied, debug
ArmyList	CcoBattleArmy (list)	Void	Returns the list of armies in this alliance
IsPlayersAlliance	Bool	Void	Returns true if this is the player controlled alliance
DoesKeepScore	Bool	Void	Returns true if we are keeping scores (CpKillScore)
WillWinOnTimeout	Bool	Void	Returns true if this alliance will win if timer runs out (usually the defender)

CcoBattleArmy

Component context wrapper for a battle army, exposes all information available to UiEd

Functions

Name	Return Type	Arguments	Description	Tags
FactionFlagLarge	String	Void	Returns the faction flag large image filepath - prefer to use FactionFlagDir instead	deprecated, hide_in_uied
IsAlive	Bool	Void	Returns true if currently alive (has some controllable units still)
AbilityGodName	String	String	Returns the key for the daemon god that the ability associates with
Score	Int	Void	Returns the cp score for this army
FactionFlagDir	String	Void	Returns directory for faction flag icons - append image name including extension for use in setting images
ArmyAbilityIndex	Int	String	Returns the index (ordered by cost) of the army ability specified by given key
ArmyIndex	Int	Void	Returns the index of this army in this alliance
GodWeighting	Float	String	Returns the Reign of Chaos weighting towards a particular god when rolling for abilities
FactionFlagMedium	String	Void	Returns the faction flag medium image filepath - prefer to use FactionFlagDir instead	deprecated, hide_in_uied
IsHuman	Bool	Void	Returns true if controlled by a human
NumMenDied	Int	Void	Returns the number of men who have died
IsLocalPlayer	Bool	Void	Returns true if controlled by local player
IsAbilityWithCost	Bool	String	Returns if the specified ability key requires currency to activate
MaxUnitsCanControl	Int	Void	Returns the maximum number of units allowed at once on the battlefield at any one time
ArmyAbilityIndexCost	Float	Int	Returns the cost of the ability at the given by index
FactionContext	CcoFactionRecord	Void	Returns the faction context for this army
CurrentWaaaghThreshold	Int	Void	Returns the current Waaagh threshold. Need to hit this to trigger a Waaagh
AllianceIndex	Int	Void	Returns the index of the alliance
FactionFlagSmall	String	Void	Returns the faction flag small image filepath - prefer to use FactionFlagDir instead	deprecated, hide_in_uied
HasReignOfChaos	Bool	Void	Returns true if the faction has the reign of chaos feature (Daemon prince only)
CurrentWaaaghPercent	Float	Void	Returns the current Waaagh percent
NumUnits	Int	Void	Returns the number of units currently alive
NumEntities	Int	Void	Returns the number of entities currently alive
AllianceContext	CcoBattleAlliance	Void	Returns the CcoBattleAlliance for this army
CanPerformCataclysmAbility	Bool	Void	Returns whether the current cataclysm ability (if it exists) can be used or performed
RealmOfSoulsThreshold	Int	Int	Returns the value require to achieve realms of souls effect
NumEntitiesInitial	Int	Void	Returns the number of entities started the battle with
WindsOfMagicPoolContext	CcoBattleWindsOfMagicPool	Void	Returns the CcoBattleWindsOfMagicPool for this army, controls how much magic has for spell casting
CurrentPercentToArmyAbility	Float	Int	Returns the percentage of points you currently have towards ability given by index
CurrentWaaaghPoints	Int	Void	Returns the current Waaagh points
NumReinforcements	Int	Void	Returns the number of units in the reinforcements pool
ArmyAbilitiesList	CcoUnitAbility (list)	Void	Returns the list of abilities available to this army
IsArmyAbilityUnlocked	Bool	Int	Returns true of the ability specified by given index is unlocked
AiStatsModifier	Float	Void	Returns a float with the ai stats modifier
NumTotalUnits	Int	Void	Returns the total units alive and reinforcements available
CommandingUnitContext	CcoBattleUnit	Void	Returns the CcoBattleUnit of the commanding/general unit
RealmOfSoulsPercent	Float	Void	Returns the percent complete to activate realm of souls effect
MurderousProwessThresh	Int	Void	Returns the amount of murderous prowess score need to achieve to activate effect
ArmyWideEffects	CcoBattleAbility (list)	Void	Returns a vector of CcoBattleAbilities that have an army-wide effect
FormationList	CcoFormationRecord (list)	Void	Returns the list of formation records available to this army
MurderousProwessPercent	Float	Void	Returns the percent of score vs thresh for murderous prowess
HasDaemonFeature	Bool	Void	Returns true if the daemon feature is available
MurderousProwessShouldDeactivate	Bool	ExpressionState	Returns true when murderous prowess ability should deactivate
ArmyAbilityCurrency	Int	Void	Returns the army ability currency for this army
AllianceColour	Colour	Void	Returns the alliance colour for this army (as in colour based on player/ally/enemy/neutral)
MurderousProwessScore	Int	Void	Returns the murderous prowess score
PrimaryColour	Colour	Void	Returns the primary faction colour of this army
UnitList	CcoBattleUnit (list)	Void	Returns the list of units in this army
HasWaaagh	Bool	Void	Returns true if Waaagh feature is available
HasRealmOfSouls	Bool	Void	Returns true if Realm of Souls feature available
GlobalScore	Int	Void	Returns the tickets remaining for this armies alliance
ArmyName	UniString	Void	Returns the localised name of this army
HasMurderousProwess	Bool	Void	Returns true if Murderous Prowess feature available
GlobalCurrency	Int	Void	Returns the supplies currency for this army
FactionName	UniString	Void	Returns the localised name of this army's faction
CurrentArmyAbilityThreshold	Int	Void	Returns the threshold to the next unlockable ability (or the maximum if all are unlocked)
PlayerName	UniString	Void	Returns the name of the player controlling tis army
UniqueID	Int	Void	Returns the unique id for this army (unique across all armies)

CcoBattleBuilding

Functions

Name	Return Type	Arguments	Description	Tags
CaptureLocationContext	CcoBattleCapturePoint	Void
MaxHitpoints	Float	Void
IsUnbreachableWall	Bool	Void
GateMaxHitpoints	Float	Void
ZoomTo	Void	Void	Zooms the battle camera to this building
Select	Void	Void	Selects this building in the card manager
GateCurrentHitpoints	Float	Void
BreakForDebugging	Void	Void		debug, hide_in_uied
HoldingArmyContext	CcoBattleArmy	Void
IsToggleable	Bool	Void
IsFlammable	Bool	Void
GateDamagePercent	Float	Void
HoldingAllianceContext	CcoBattleAlliance	Void
IsDestroyed	Bool	Void
HasMissileWeapon	Bool	Void
Position	Vector4	Void
IsDestructable	Bool	Void
MissileWeaponContext	CcoMissileWeaponRecord	Void
CentralPosition	Vector4	Void
CategoryIconPath	String	Void
ShowTime	Float	Void
IsSelectable	Bool	Void
CategoryType	String	Void	Returns the category type name for this type of building.
HideTime	Float	Void
IsSelected	Bool	Void
GlobalEffectText	UniString	Void	Returns the description string of the global effects that the building applies
SpecialAbilitiesListWithArmy	CcoBattleAbility (list)	CcoBattleArmy	Returns the list of CcoBattleAbility's that this building owns in context of the specified army
IsBridge	Bool	Void
CanUpdateAbilities	Bool	Void	Are the linked key building abilities enabled?
RadarIcon	String	Void
IsGate	Bool	Void
IsOnFire	Bool	Void
HasOwner	Bool	Void	Does the building have a valid owning army associated with it?
Name	UniString	Void
LocalEffectText	UniString	Void	Returns the description string of the local effects that the building applies
SpecialAbilitiesList	CcoBattleAbility (list)	Void	Returns the list of CcoBattleAbility's that this building owns in context of the owning army
IsIncidental	Bool	Void
CurrentHitpoints	Float	Void
IsEnabled	Bool	Void
PercentOnFire	Float	Void
DamagePercent	Float	Void

CcoBattleCaptureLocationsManager

Functions

Name	Return Type	Arguments	Description
TimeUntilAllCapturePointsAvailable	Float	Void	Returns how long it will be until all capture points are available, in seconds
SummaryListForTicketsSources	CcoSummedValueContext	Int	Returns list of owned capture points, showing how many tickets they are scoring per second. Returns CcoSummedValueContext populated with CcoPair compposed of curency source record cco and amount value
TicketsGoal	Int	Void	Returns the number of capture tickets that must be earned to fulfil the tickets victory condition

CcoBattleCapturePoint

Functions

Name	Return Type	Arguments	Description	Tags
Position	Vector4	Void	Returns a position in world space in VECTOR_4
IsMouseOver	Bool	Void	Returns true if the capture point is currently being moused over.
IsLocked	Bool	Void
CurrentHolderAlliance	Int	Void	The alliance id of the alliance that currently holds this capture point
FlagPosition	Vector4	Void	Returns the flag position in world space in VECTOR_4
LinkedParentCapturePointContext	CcoBattleCapturePoint	Void	Returns the linked parent capture point that needs to be captured first before unlocking this one, if it exists
IsContested	Bool	Void
ContestingFactorForAlliance	Float	Int
IsEnabled	Bool	Void
LinkedChildCapturePointsList	CcoBattleCapturePoint (list)	Void	Returns the linked children capture point that would get unlocked after capturing this point, if any
ToggleableSlotsList	ContextList	Void
ColourBase	Colour	Void
Description	UniString	Void
ColourFill	Colour	Void
TypeRecordContext	CcoCapturePointTypeRecord	Void
IsNeutral	Bool	Void
ToggleableSlotTowersList	ContextList	Void
SetHighlight	Void	Bool	Enables or disables a pulsing highlight effect on the capture location
FillPercent	Float	Void
ToggleableSlotBarricadesList	ContextList	Void
IsLinkedBuildingDestroyed	Bool	Void
ColourForHolder	Colour	Void
ContestingProportionForAlliance	Float	Int
HasMoraleEffects	Bool	Void
HasCaptureBuilding	Bool	Void	Does this capture location have an associated building
UnitsForAlliance	ContextList	Int
ZoomTo	Void	Void
CapturePercent	Float	Void
DisplayName	UniString	Void	Returns the displayable name for this capture point i.e. the header for the capture point tooltip
CapturePointScore	Float	Void
DevCaptureForArmy	Void	CcoBattleArmy	For dev purposes, captures the capture point immediately for supplied army	debug, hide_in_uied
ContestingArmycontext	CcoBattleArmy	Void
Name	UniString	Void	Returns the string name for this capture point type
CapturePointScoreNormalised	Float	Int
Key	String	Void
CaptureBuilding	CcoBattleBuilding	Void
ContestingUnitList	ContextList	Void
IsNearingReLock	Bool	Void	Returns whether this capture point is about to be relocked because its parent is being captured
BuildingList	ContextList	Void
IconPath	String	Void
IsChildNearingReLock	Bool	Void	Returns whether the child of this capture point is about to be relocked because this point is being captured
SetStickyTooltipActive	Void	Bool	Sets the `sticky_tooltip_active` value to true or false based on the passed argument.
HoldingArmyContext	CcoBattleArmy	Void
IsLockedForAlliance	Bool	Int	Returns true if the capture point is locked for the passed in alliance
IsTimeBased	Bool	Void
ContributesToVictory	Bool	Void
IsStickyTooltipActive	Bool	Void	Returns true if the capture point currently has a sticky tooltip open for it.
HoldingUnitList	ContextList	Void
IsPointBased	Bool	Void
SetMouseOver	Void	Bool	Sets the `mouse_over` value to true or false based on the passed argument.
Radius	Float	Void
CanCurrentOwnerBuild	Bool	Void	Returns if the current owner of the capture point is allowed to build
ScriptId	String	Void
OriginalOwnerAlliance	Int	Void	The original alliance id for this capture point

CcoBattleCurrencyManager

Functions

Name	Return Type	Arguments	Description
PurchaseArmyAbility	Void	String, Int, Context	Takes db key of ability, int32 for the currency item type enum and CcoBattleArmy and purchases the ability
SummaryListForCurrencySources	CcoSummedValueContext	String, Int	Takes db key and army unique id and returns CcoSummedValueContext populated with CcoPair compposed of curency source record cco and amount value
CurrencyTypeStringToEnum	Int	String	Takes db key of the currency type and returns int32 of the currency type enum
CurrencyItemTypeStringToEnum	Int	String	Takes db key of the currency item type and returns int32 of the currency type enum
CanAffordItem	Bool	String, Int, Context	Takes db key of the item, int32 for the currency item type enum and CcoBattleArmy and returns boolean indicating whther the item can be afforded
PurchaseItem	Void	String, Int, Context	Takes db key of the item, int32 for the currency item type enum and CcoBattleArmy and purchases the item
GetCostForItem	Float	String, Int, Context	Takes db key of the item, int32 for the currency item type enum and CcoBattleArmy and returns the cost for that item
GetArmyCurrencyForType	Float	CcoBattleArmy, String	Takes db key of the currency and returns the amount of that currency for the players army

CcoBattleCursorContext

Component context wrapper for BATTLE_UI_CURSOR_OVER_CONTEXT, so can get context information about current 3d mouseover

Functions

Name	Return Type	Arguments	Description
IsAttackCursor	Bool	Void	Returns true if showing attack cursor
FirstIntersectPosition	Vector4	Void	Returns first intersection position
IsContextSelectable	Bool	Void	Returns true if current mouseover can be selected
IsMoveCursor	Bool	Void	Returns true if showing move cursor
CurrentCursorKey	String	Void	Returns the current cursor_record key of the cursor being used
HasIntersections	Bool	Void	Returns if currently intersecting 3d world
GroundTypeRecordContext	CcoGroundTypeRecord	Void	Returns the ground type record currently mousing over
ToggleableSlotContext	CcoBattleToggleableSlot	Void	Returns the toggleable slot currently mousing over
BuildingContext	CcoBattleBuilding	Void	Returns the building currently mousing over
VehicleContext	CcoBattleVehicle	Void	Returns the vehicle currently mousing over
UnitContext	CcoBattleUnit	Void	Returns the unit currently mousing over
EntityContext	CcoBattleEntity	Void	Returns the entity currently mousing over
GroundIntersectPosition	Vector4	Void	Returns first intersection position with ground
ContextPosition	Vector4	Void	Returns the position of whatever context we are over (unit/building/etc)

CcoBattleEntity

Component context wrapper for a battle entity, exposes all information available to UiEd

Functions

Name	Return Type	Arguments	Description	Tags
DevSetCollisionHeight	Void	Float	Dev command to set collision height on entity	debug, hide_in_uied
ZoomTo	Void	Void	Zooms camera to look at this entity
DevSetCollisionRadius	Void	Float	Dev command to set radius of collision on entity	debug, hide_in_uied
IsMan	Bool	Void	Returns true if this is a man entity
IsEngine	Bool	Void	Returns true if this is an engine entity
IsAlive	Bool	Void	Returns true if entity still alive
IsReloading	Bool	Void	Returns true if currently reloading
DevSetArticulationMaxAngle	Void	Float	Dev command to set articulation radius of given node, if this is an articulated unit	debug, hide_in_uied
ReloadRemainingTime	Float	Void	Returns the remaining reload time in seconds
DevSetArticulationHeadOffset	Void	Float	Dev command to set articulation radius of given node, if this is an articulated unit	debug, hide_in_uied
ReloadPercent	Float	Void	Returns the percentage of how close to being reloaded
EntityRecordContext	CcoBattleEntityRecord	Void	Returns the CcoBattleEntityRecord context
Key	String	Void	Returns the BATTLE_ENTITY_RECORD key
DevSetArticulationRadius	Void	Int, Float	Dev command to set articulation radius of given node, if this is an articulated unit	debug, hide_in_uied
Position	Vector4	Void	Returns the current position
DevSetCollisionShape	Void	String	Dev command to set collision shape. Valid shapes are circle, ellipse, capsule and lens	debug, hide_in_uied
UnitContext	CcoBattleUnit	Void	Returns the CcoBattleUnit context
DevSetArticulationOffset	Void	Int, Float	Dev command to set articulation offset of given node, if this is an articulated unit	debug, hide_in_uied
DevSetCollisionZOffset	Void	Float	Dev command to set collision z offset on entity	debug, hide_in_uied
DevSetCollisionRadii	Void	Float	Dev command to set radii ratio of collision on entity	debug, hide_in_uied

CcoBattleGroup

Functions

Name	Return Type	Arguments
IsLocked	Void	Void
NumEntities	Void	Void
IsCreated	Void	Void
CurrentState	Void	Void
UnitList	Void	Void
NumUnits	Void	Void
GroupId	Void	Void
CanLock	Void	Void
IsTakingDamage	Void	Void
ChangeFormation	Void	Void
FormationContext	Void	Void
ToggleLock	Void	Void
SelectGroup	Void	Void
CreateGroup	Void	Void
DestroyGroup	Void	Void
IsSelected	Void	Void

CcoBattleLaboratoryInfo

Wrapper for the lab settings of a battle.

Functions

Name	Return Type	Arguments	Description
IsWindsOfMagicLimitless	Bool	Void	Returns true of winds of magic is set to limitless
ImpactForceMultiplier	Float	Void	Returns the impact force multiplier value
SetValueForLabSetting	Void	CcoLabSettingRecord, Float	Sets the value for the passed in lab setting to the one passed in
SetAbilityEffectRadiusMultiplier	Void	Float	Sets the ability effect radius multiplier value to the one passed in
ValueForLabSetting	Float	CcoLabSettingRecord	Returns the value for the passed in lab setting
BloodMultiplier	Float	Void	Returns the blood multiplier value
SetAbilityCooldownMultiplier	Void	Float	Sets the ability cooldown multiplier value to the one passed in
UnitSize	Float	Void	Returns the unit size multiplier value
SetGravityMultiplier	Void	Float	Sets the gravity multiplier value to the one passed in
ChargeBonusMultiplier	Float	Void	Returns the charge bonus multiplier value
SingleEntityScaleMultiplier	Float	Void	Returns the single entity scale multiplier value
SetAmmunitionMultiplier	Void	Float	Sets the ammunition multiplier value to the one passed in
AbilityEffectRadiusMultiplier	Float	Void	Returns the ability effect radius multiplier value
SetProjectilePenetrationMultiplier	Void	Float	Sets the projectile penetration multiplier value to the one passed in
AbilityCooldownMultiplier	Float	Void	Returns the ability cooldown multiplier value
ProjectilePenetrationMultiplier	Float	Void	Returns the projectile penetration multiplier value
SetFatigueMultiplier	Void	Float	Sets the fatigue multiplier value to the one passed in
GravityMultiplier	Float	Void	Returns the gravity multiplier value
SetReloadTimeMultiplier	Void	Float	Sets the reload time multiplier value to the one passed in
SetWindsOfMagicMultiplier	Void	Float	Sets the winds of magic multiplier value to the one passed in
ReloadTimeMultiplier	Float	Void	Returns the reload time multiplier value
SetExplosionRadiusMultiplier	Void	Float	Sets the explosion radius multiplier value to the one passed in
AmmunitionMultiplier	Float	Void	Returns the ammunition multiplier value
ExplosionRadiusMultiplier	Float	Void	Returns the explosion radius multiplier value
SetImpactForceMultiplier	Void	Float	Sets the impact force multiplier value to the one passed in
SetUnitSize	Void	Float	Sets the unit size multiplier value to the one passed in
FatigueMultiplier	Float	Void	Returns the fatigue multiplier value
SetMoraleMultiplier	Void	Float	Sets the morale multiplier value to the one passed in
ToggleWindsOfMagicLimitless	Void	Void	Toggles the winds of magic limitless setting
MoraleMultiplier	Float	Void	Returns the morale multiplier value
SetSingleEntityScaleMultiplier	Void	Float	Sets the single entity scale multiplier value to the one passed in
SetDamageMultiplier	Void	Float	Sets the damage multiplier value to the one passed in
WindsOfMagicMultiplier	Float	Void	Returns the winds of magic multiplier value
SetBloodMultiplier	Void	Float	Sets the blood multiplier value to the one passed in
SetChargeBonusMultiplier	Void	Float	Sets the charge bonus multiplier value to the one passed in
DamageMultiplier	Float	Void	Returns the damage multiplier value

CcoBattlePurchasableArmyAbility

A purchasable ability or upgrade that can be applied to specific armys

Functions

Name	Return Type	Arguments	Description
PurchaseUpgrade	Void	CcoBattleArmy	Purchases the army ability upgrade
CanAfford	Bool	CcoBattleArmy	Returns if can afford to purchase the item
SoundType	String	Void	Returns the sound type used for this purchase group
IsAvailableInGroup	Bool	CcoBattleArmy	Returns true if the item is available
ArmySpecialAbilityRecordContext	CcoArmySpecialAbilityRecord	Void	Returns the army ability record context
GetCostForThisAction	Float	CcoBattleArmy	Returns the cost of this action

CcoBattlePurchasableUnit

Functions

Name	Return Type	Arguments	Description
CostPerUnit	Float	Int	Returns price of the unit, takes in int32 army id
CanAffordUnit	Bool	Int	Returns whetehr the unit can be afforded, takes in int32 army id
UnitContext	CcoBattleUnit	Void	Returns CcoBattleUnit context

CcoBattlePurchasableUnitAbility

A purchasable ability or upgrade that can be applied to specific units

Functions

Name	Return Type	Arguments	Description
UnitSpecialAbilityRecordContext	CcoUnitSpecialAbilityRecord	Void
GetCostForThisAction	Float	Int
UnitAbilityContext	CcoUnitAbility	Void
SoundType	String	Void
CanAfford	Bool	ContextList, Int	(UnitList, ArmyID) Can the army afford to purchase the ability for all of the units (who can get the ability) in the UnitList
PurchaseForCurrentSelection	Void	ContextList, CcoBattleArmy, Bool	(UnitList, CcoBattleArmy) Purchase the ability for the units in the list for the specific army
GetCostForSelection	Float	ContextList, Int	(UnitList, ArmyID) Get the cost to apply this upgrade to all of the listed units for the specific army id
IsAvailableInGroup	Bool	ContextList	(UnitList) Is the ability available to any of the units in the list
FilterSelectionCanBeCast	CcoBattleUnit (list)	ContextList, Bool	(UnitList, CanCastIfAlreadyInProgress) Filter a unit list to only those who will be affected by this ability, and who don't have the ability in progress already
FilterSelectionToApplicable	CcoBattleUnit (list)	ContextList	(UnitList) Filter a unit list to only those who will be affected by this ability

CcoBattleReinforcementArmy

Component context wrapper for a BATTLE_UI_REINFORCEMENT_ARMY, exposes all information available to UiEd

Functions

Name	Return Type	Arguments	Description
IsDeployedUsingTimer	Bool	Void	Is this reinforcement army's spawn based on a timer/countdown?
TimeUntilDeploySecs	Float	Void	How long (in seconds) until the reinforcement army is deployed
IsDeployed	Bool	Void	Has the reinforcement army been deployed into the battlefield yet?
Position	Vector4	Void	Returns a VECTOR4 specifying the world position of the reinforcement army's spawn zone/deployment location
UnitList	CcoBattleUnit (list)	Void	Returns the list of CcoBattleUnits that make up this reinforcing army.
NumUnitsRemaining	Int	Void	How many more units are left to be deployed, as not all units are deployed at the same time
TargetArmyContext	CcoBattleArmy	Void	Returns the CcoBattleArmy that this army's units will join after entering the field.

CcoBattleReinforcementDebugUnits

Functions

Name	Return Type	Arguments	Description	Tags	Events
DeployUnits	Void	ContextList, CcoBattleArmy	Deploys units
Units	CcoBattleUnit (list)	Void	Lists units

CcoBattleReinforcementPool

Functions

Name	Return Type	Arguments	Description
CanUseSpawnZone	Bool	CcoBattleArmy, Int	Return whether the specific spawn zone can be used
CanUseUnit	Bool	CcoBattleUnit	Return whether a specific unit is available to deploy (even if it cannot be deployed currently)
NumSpawnZonesAvailableToArmy	Int	CcoBattleArmy, ContextList	Returns how many of the listed spawn zones are currently available to the specified army
UnitsMatchingUnitCategoryForArmy	CcoBattlePurchasableUnit (list)	CcoBattleArmy, CcoBattlePurchasableUnit, Int	Return vector of units in the matching category to the supplied unit, available to an army
CostForUnits	Float	ContextList, Int	Returns cost for list of units for an army
GetHealthPercentageForUnit	Float	CcoBattlePurchasableUnit	Gets health percentage of a unit in replenishment pool, returns 0 if unit is not found
UnitsUnlockedFromCapturePoint	CcoBattleUnit (list)	CcoBattleArmy, CcoBattleCapturePoint	Return vector of units that are unlocked on a specific capture point
UnitsCategorisedForArmy	CcoGroupList (list)	CcoBattleArmy, Int	Return vector of units available to an army
PurchaseUnits	Void	ContextList, CcoBattleArmy, Int	Purchases the list of units for an army at a spawn zone
UnitsForArmy	CcoBattlePurchasableUnit (list)	CcoBattleArmy, Int	Return vector of units available to an army
PurchaseUnit	Void	CcoBattlePurchasableUnit, CcoBattleArmy, Int	Purchases a single unit for an army at a spawn zone
HaveAnyUnitsBeenOnBattlefield	Bool	ContextList	Have any of the units been on the battlefield during this battle?
CanPurchaseUnit	Bool	CcoBattlePurchasableUnit, CcoBattleArmy, Int	Return whether a specific unit is affordable to an army
CanPurchaseUnits	Bool	ContextList, CcoBattleArmy, Int	Return whether list of units is affordable to an army
CanUseSpawnZoneReason	String (list)	CcoBattleArmy, Int	Returns the reason/state name of whether a spawn zone can be used or not
UnitsMatchCategory	Bool	CcoBattlePurchasableUnit, CcoBattlePurchasableUnit	Do the supplied purchasable units match the same unit category?

CcoBattleRoot

The root for battle that gives access to anything battle related

Functions

Name	Return Type	Arguments	Description	Tags
SettlementContext	CcoBattleSettlement	Void	Returns the CcoBattleSettlement context if in a settlement/siege battle
MapBarrierToggleableSlotList	CcoBattleToggleableSlot (list)	CcoBattleArmy	Returns list of map barrier toggleable slots in the battle
OpposingToPlayerAllianceContext	CcoBattleAlliance	Void	Get the opposing to player alliance
DevCycleArmy	Void	Void	Cycles between armies, used for dev functionality	debug
IsToggleSlotListVisible	Bool	Void	Returns true if the toggle slots can be shown
DoesHaveUnitReplenishments	Bool	Void	Returns true if unit replenishments are enabled for this battle
VictoryPointContributionSummaryForAlliance	CcoSummedValueContext	Int, Bool	Get CcoSummedValueContext for summary of ticket score contribution by different types of capture points
AllianceList	CcoBattleAlliance (list)	Void	Returns list of all alliances in the battle
ZoomToPosition	Void	Vector4	Zoom the camera to an abitrary position
SeasonRecordContext	CcoSeasonRecord	Void	Returns the CcoSeasonRecord context for the current battle
NumberOfCores	Int	Void	Returns the number of physical CPU cores (this probably should be a global function instead!)
BattleTypeCheatSheetList	CcoBattleTypeCheatSheetEntryRecord (list)	Int	Gets a list of CcoBattleTypeCheatSheetEntryRecords, ordered by their priority indices, and that live in the specified column index.
ToggleCinematicMode	Void	Void	Toggles the cinematic mode UI
IsLegendaryMode	Bool	Void	Returns true if the current battle has legendary mode enabled
PlayerArmyContext	CcoBattleArmy	Void	Returns the CcoBattleArmy for the player
ToggleableSlotList	CcoBattleToggleableSlot (list)	CcoBattleArmy	Returns list of all toggleable slots in the battle
Year	Int	Void	Returns the year number for the current battle
CaptureLocationManagerContext	CcoBattleCaptureLocationsManager	Void	Returns capture location manager context
DoesHaveReinforcementPurchasing	Bool	Void	Returns true if reinforcement purchasing is enabled for this battle
ShowEscapeMenu	Void	Void	Toggles the escape menu in battle
IsTrial	Bool	Void	Returns true if current battle is a trial battle
DefendingAllianceContext	CcoBattleAlliance	Void	Returns the CcoBattleAlliance for the defending alliance
BattleReinforcementPoolContext	CcoBattleReinforcementPool	Void	Returns the battle reinforcement pool context
IsDomination	Bool	Void	Returns true if current battle is a domination battle
HasAmbushWithdrawArea	Bool	Void	Returns true if the current battle has an ambush withdraw area
BattleReinforcementDebugUnitsContext	CcoBattleReinforcementDebugUnits	Void	Returns the battle reinforcement debug units context
PlayerAllianceContext	CcoBattleAlliance	Void	Returns the CcoBattleAlliance for the player
IsConquest	Bool	Void	Returns true if current battle is a conquest battle
IsTeleportWithdrawAvailable	Bool	Void	Returns true if the battle allows the use of `Teleport Withdraw`.
TimeoutWinningAllianceIndex	Int	Void	Returns the index of the alliance who will win when the timer runs out
BuildingsList	CcoBattleBuilding (list)	Void	Returns list of all buildings in the battle
IsSpectator	Bool	Void	Returns true if local player is current spectating
BattleCurrencyManagerContext	CcoBattleCurrencyManager	Void	Returns the currency manager context
CanDismantleBuildings	Bool	Void	Returns true if buildings can be dismantled in the current battle
HasArmyAbilityFillCurrency	Bool	Void	Returns true if army ability fill is used in this battle
AttackingAllianceContext	CcoBattleAlliance	Void	Returns the CcoBattleAlliance for the attacking alliance
StormOfMagicContext	CcoBattleStormOfMagic	Void	Returns the storm of magic context
IsRealismModeEnabled	Bool	Void	Returns true if the current battle has realism mode enabled
IsSurvival	Bool	Void	Returns true if current battle is a survival battle
IsMultiplayer	Bool	Void	Returns true if current battle is multiplayer
ResultContext	CcoBattleResult	Void	Returns the battle result context for the current battle
IsLabMode	Bool	Void	Returns true if current battle is a lab mode battle
SpawnZoneList	CcoBattleSpawnZone (list)	Void	Returns list of all spawn zones in the battle
HasSupplies	Bool	Void	Returns true if supplies currency is used in this battle
IsCampaignBattle	Bool	Void	Returns true if current battle was started from campaign
SetupContext	CcoBattleSetup	Void	Returnsthe battle setup context for the current battle
BattleHasToggleBuildings	Bool	Void	Returns true if the current battle has any toggleable buildings
GetHumanNetworkPlayersParticipatingInAllianceList	CcoNetworkPlayer (list)	Void	Returns list of human players participating in the battle
HasPrisoners	Bool	Void	Returns true if prisoner currency is used in this battle
IsTutorial	Bool	Void	Returns true if current battle is a tutorial
CursorContextContext	CcoBattleCursorContext	Void	Returns the cursor context for the battle to get information on what is currently under the mouse cursor
AmbushWithdrawAreaPosition	Vector4	Void	Returns the position of the ambush withdraw area (if there is one)
IsReplay	Bool	Void	Returns true if current battle is a replay
SelectionContext	CcoBattleSelection	Void	Returns the selection context to get information on what is currently selected in battle
IsCinematicModeEnabled	Bool	Void	Returns true if cinematic mode is currently enabled
BalanceOfPowerPercent	Float	Void	Returns floating point percent for players alliance to show how much they are winning the battle
VehicleList	CcoBattleVehicle (list)	Void	Returns list of all the vehicles in the battle
ReinforcementArmyList	CcoBattleReinforcementArmy (list)	Void	Returns list of all reinforcing armies for the battle
UnitSize	Float	Void	Returns the unit scale factor setting
IsSiege	Bool	Void	Returns true if current battle is a siege
ClimateWeatherDescriptionRecordContext	CcoBattleClimateWeatherDescriptionRecord	Void	Returns the climate weather description record for the current battle
BattleTypeState	String	Void	Returns the type of battle as an unlocalised string
CapturePointList	CcoBattleCapturePoint (list)	Void	Returns list of all the capture points in the battle
TimeControlContext	CcoBattleTimeControl	Void	Returns the time control context to query/interact with time controls in battle
IsResultsPhase	Bool	Void	Returns true if current phase in battle is results
QuestKey	String	Void	Returns the quest key of the current battle if it is a quest battle
VictoryCapturePointContextList	CcoBattleCapturePoint (list)	Bool	Returns list of all the victory capture points in the battle if passed true, if passed false will return just the victory capture points
DoesHaveUnitUpgrades	Bool	Void	Returns true if unit upgrades are enabled for this battle
IsDeploymentPhase	Bool	Void	Returns true if current phase in battle is deployment
RestartBattle	Void	Void	Restarts the current battle
WeatherRecordContext	CcoBattleWeatherTypeRecord	Void	Returns the weather record for the current battle
TimeRemainingString	UniString	Void	Returns the time remaining as a pre-formatted localised string
ArmyList	CcoBattleArmy (list)	Void	Returns list of all armies in the battle
UnitList	CcoBattleUnit (list)	Void	Returns list of all units in the battle
IsConflictPhase	Bool	Void	Returns true if current phase in battle is conflict
BattleNameText	UniString	Void	Returns the localised name of the battle
ClimateRecordContext	CcoClimateRecord	Void	Returns the climate record for the current battle
DoesHaveArmyAbilityUpgrades	Bool	Void	Returns true if army ability upgrades are enabled for this battle
GroupList	CcoBattleGroup (list)	Void	Returns list of all players unit groups
IsCapturePointListVisible	Bool	Void	Returns true if the capture points can be shown

CcoBattleSelection

Exposes the current selection in battle allowing to perform queries and commands on the current selected units for example

Functions

Name	Return Type	Arguments	Description
ToggleMelee	Void	Void	Toggles melee/ranged mode on the current selection
ChangeFormation	Void	ExpressionState	Changes the formation of the current selection to thet specified one
Withdraw	Void	Void	Issues a withdraw command to the current selection, making them withdraw from the battlefield
ToggleRun	Void	Void	Toggles run/walk speed on the current selection
FirstUnitContext	CcoBattleUnit	Void	Returns the first unit in the selection
Halt	Void	Void	Issues a halt command to current selection, cancelling any current orders
NumEntitiesSelected	Int	Void	Returns the number of entities currently selected
FormationName	String	Void	Returns the current formation key of selection
UnitList	CcoBattleUnit (list)	Void	Returns list of CcoBattleUnit that are currently selected
NumUngroupedUnits	Int	Void	Returns number of ungrouped units currently selected
NumUnitGroups	Int	Void	Returns number of unit groups currently selected
IsTakingDamage	Bool	Void	Returns true if the current selection is taking damage
NumUnits	Int	Void	Returns number of units currently selected
AnyUnitSelected	Bool	Void	Returns true if any controllable unit is selected
AnyUnitSelectedIncludingEnemy	Bool	Void	Returns true if any unit selected including the enemy
ToggleFlying	Void	Void	Toggles flying state of units that can fly in the current selection
IsOrderable	Bool	Void	Returns true if the current selection can be issued orders
DeselectAll	Void	Void	Deselects any currently selected units

CcoBattleSettlement

Functions

Name	Return Type	Arguments
DestructionEffectsList	Void	Void
MountedArtilleryLocationList	Void	Void
DestroyedPercent	Void	Void

CcoBattleSetup

Wrapper for a battle setup

Functions

Name	Return Type	Arguments	Description
BattleInfoContext	CcoBattleSetupInfo	Void	Returns the CcoBattleSetupInfo context
OtherPlayerAllianceContext	CcoBattleSetupAlliance	Void	Returns the other players alliance context
LocalPlayerAllianceContext	CcoBattleSetupAlliance	Void	Returns the local players CcoBattleSetupAlliance context
HideEnemyUnits	Bool	Void	Returns true is enemy units should be hidden
PlayerAllianceID	Int	Void	Returns the players alliance index
IsPlayerAttacker	Bool	Void	Returns true if the player is the attacker
HideAllUnits	Bool	Void	Returns true if all units should be hidden
IsBenchmark	Bool	Void	Returns true if this battle setup is a benchmark
IsTimeoutDraw	Bool	Void	Returns true if there was a timeout draw
PlayerArmyID	Int	Void	Returns the players army index

CcoBattleSetupAlliance

Wrapper for an alliance in a set battle, exposes army contexts to UiEd.

Functions

Name	Return Type	Arguments	Description	Tags	Events
ArmyList	CcoBattleSetupArmy (list)	Bool (optional)	Returns the list of all CcoBattleSetupArmy contexts involved in the battle.
ArmyContext	CcoBattleSetupArmy	Int	Returns the CcoBattleSetupArmy with the specified id.

CcoBattleSetupArmy

Contains initial setup data for the specified army

Functions

Name	Return Type	Arguments	Description
PlayerName	UniString	Void	Returns the name of the player if human or the localised string for cpu if AI
UnitList	CcoBattleSetupUnit (list)	Bool (optional)	Returns the list of units in this setup army, optional bool argument for whether hidden armies should be excluded
FlagDir	String	Void	Returns path to flags for the faction
BattleSetupFactionContext	CcoBattleSetupFaction	Void	Returns the CcoBattleSetupFaction for this setup army
AllianceColour	Colour	Void	Returns the associate alliance colour for the setup army (as in colour based on player/ally/enemy/neutral)

CcoBattleSetupFaction

Functions

Name	Return Type	Arguments
FlagDir	Void	Void
FactionRecordContext	Void	Void
Name	Void	Void

CcoBattleSetupInfo

Wrapper for the setup of a battle, exposing info like the region name and year of battle.

Functions

Name	Return Type	Arguments	Description	Tags
BattleTitle	UniString	Void	Returns the name of the battle.
BattleTypeString	UniString	Void	Returns the type of battle (e.g. land battle, chokepoint battle...)
RegionName	UniString	Void	Returns the name of the region that the battle took place in. Only applicable for campaign battles.
DevSetIsLabMode	Void	Bool	Sets the battle to be a lab mode battle	debug
AllianceContextFromIndex	CcoBattleSetupAlliance	Int	Returns the CcoBattleSetupAlliance corresponding to the alliance at the given index.
LaboratoryInfoContext	CcoBattleLaboratoryInfo	Void	Returns the CcoBattleLaboratoryInfo if this is a laboratory type battle
BattleYear	Int	Void	Returns the year that the battle took place in, as int32.

CcoBattleSetupUnit

Wrapper for a BATTLE_SETUP_UNIT

Functions

Name	Return Type	Arguments	Description
UnitDetailsContext	CcoUnitDetails	Void	Returns a CcoUnitDetails with the details of the unit
AppliedDishList	CcoCookingDish (list)	Void	Returns a list of CcoCookingDish with the dishes applied to this unit if any
CombatPotential	Int	Void	Returns an int with the combat potential of the unit
UnitRecordContext	CcoMainUnitRecord	Void	Returns a CcoMainUnitRecord with the main unit
ImagePath	String	Void	Returns a string with the image path of the unit
IsCommander	Bool	Void	Returns true if the unit is a commander
Name	UniString	Void	Returns a localised string with the name of the unit

CcoBattleSpawnZone

Functions

Name	Return Type	Arguments	Description
IsAvailableToAllianceForSupport	Bool	Int
Position	Vector4	Void
IsAvailableToAlliance	Bool	Int
UniqueID	Int	Void
OnMouseOver	Void	Bool
GetAllianceColour	Colour	Int
IsVanguardOnly	Bool	Void	Is the spawn zone only available for use by vanguard units or not

CcoBattleStormOfMagic

Cco wrapper for querying and controlling the Storm Of Magic manager

Functions

Name	Return Type	Arguments	Description
DisplayFluxValue	Int	Void	Displayable value of current lore progress, which includes discharge value when amgic transition occurs
FluxCapacity	Int	Void	Max/Target value of current lore progress
FluxPercentPreview	Float	Void	Shows the new %age of the flux charge based on the current moused over spell
FluxValue	Int	Void	Real value of current lore progress
IsFluxTransitioning	Bool	Void	Is there a magical flux transition in progress?
DevTriggerRandomAscendancy	Void	Void	DEV - Trigger a random ascendancy change to a new lore
FluxPercent	Float	Void	Current %age progress through the current lore until the next lore transition is triggered
ApplyAscendancy	Void	CcoSpecialAbilityGroupRecord	Request to apply a specific lore, in response to a manual lore selection notification
AvailableLoreList	CcoSpecialAbilityGroupRecord (list)	Void	Get the list of all of the available lores (Supports only 8 max currently)
SelectableLoreList	CcoSpecialAbilityGroupRecord (list)	Void	Get the list of the currently selectable lores (Supports only 8 max currently)
DevChangeAscendancy	Void	CcoSpecialAbilityGroupRecord	DEV - Trigger an ascendancy change to a specific lore (using the CcoSpecialAbilityRecord of the target lore)
TriggerAscendancyChange	Void	Void	Trigger a Storm of Magic Ascendancy Change message
CurrentAscendancyLoreContext	CcoSpecialAbilityGroupRecord	Void	Get the CcoSpecialAbilityGroupRecord for the currently ascendant lore
CanArmySelectAscendancyAtBattleStart	Bool	CcoBattleArmy	Whether the specified army select the Storm of Magic ascendancy at battle start
CurrentAscendancyIndex	Int	Void	Get the Index for the currently ascendant lore
IsEnabled	Bool	Void	Is the Storm Of Magic manager enabled?
IsMagicalChargeTransitionInProgress	Bool	Void	Is a Storm of Magic ascendancy transition in progress?
MagicalChargeTransitionTimeRemaining	Float	Void	Gets the time remaining for the magical transition in seconds
MagicalChargeTransitionProgress	Float	Void	Gets the fractional progress of the magical transition
AscendancyTransitionTimeRemaining	Float	Void	Gets the time remaining for the magical transition in seconds
IsAscendancyTransitionInProgress	Bool	Void	Is a Storm of Magic ascendancy transition in progress?

CcoBattleSurvivalWave

Component context wrapper for a survival wave, detailing wave Id and units involved in the wave and other wave info

Functions

Name	Return Type	Arguments	Description
CategorisedWaveUnitsList	CcoGroupList (list)	Void	Returns a list of Grouped CcoBattleUnits that represent the units in this wave, but in a categorised manner
WaveId	Int	Void	Returns the associated Wave ID
WaveUnitsList	CcoBattleUnit (list)	Void	Returns a list of CcoBattleUnits that represent the units in this wave
IsFinalWave	Bool	Void	Returns if the wave is the final/boss wave

CcoBattleTimeControl

Component context wrapper for battle time controls, contains all interface for querying and interacting with time state of battle

Functions

Name	Return Type	Arguments	Description
CycleSpeed	Void	Bool, Bool	Cycles the speed between pause,slowmo,play,fwd,ffwd either in the direction specified (true=forwards,false=backwards)
ToggleSpeed	Void	Float	Toggles between specified speed and pause
TogglePause	Void	Void	Toggles between current speed and puase
SetCanChangeTime	Void	Bool	Allows to disable ability to change the time
SetSpeed	Void	Float	Sets time to a specified float multiplier speed
ShouldShowPausePanel	Bool	Void	Returns true if we should currently be showing the paused panel
CanCycleSpeed	Bool	Bool	Returns true if can cycle in the direction specified (true=forwards,false=backwards). This assumes non-wrapping functionality (for 3k)
IsSlowMoEnabled	Bool	Void	Returns true if can set speed to slow motion. This is disabled in realism mode for example
NumMpVotesForSpeed	Int	Float	Returns the number of votes in multiplayer for a particular speed
CanChangeTime	Bool	Void	Returns true if can currently change the time
CurrentSpeed	Float	Void	Returns the current speed as a float multiplier value (e.g. 1 for play, 0 for pause, 0.4 for slowmo...)
StateForSpeed	String	ExpressionState, Float	Returns button state to use for the specified speed
CurrentSpeedName	String	Void	Returns the UNLOCALISED name of the current speed

CcoBattleToggleableSlot

A slot that can contain a unit, barrier or building; that may be toggled from an off state to one of a pool of options

Functions

Name	Return Type	Arguments	Description
ParentCapturePointContext	CcoBattleCapturePoint	Void	Get the CcoBattleCapturePoint that is the parent of this toggleable slot
IconBlendablePathForIndex	String (list)	CcoBattleArmy, Int	Retrieve the white/blendable icon asset path for the associated slot buildable index
IsUnit	Bool	Void	Does the slot represent a toggleable unit?
IsActive	Bool	Void	Is the slot radial visible?
IconMinimapPathForIndex	String (list)	CcoBattleArmy, Int	Retrieve the minimap icon asset path for the associated slot buildable index
SetActive	Void	Bool	Set if the slot radial visible
IsDestroyed	Bool	Void	Returns true if this slot has been destroyed and cannot be rebuilt
CurrentBuildableOwner	CcoBattleArmy	Void	Get the CcoBattleArmy of the owner of the currently enabled buildable. Falls back to the capture point owner if this fails
ConstructionTimeRemainingSeconds	Float	Void	How long is left in the current construction timer
IsConstructionInProgress	Bool	Void	Is there anything being constructed or a toggle switch being deferred?
ShowPreviewForIndex	Void	Int	Shows the ghost preview for the buildable on the associated slot
IsDestructionInProgress	Bool	Void	Is there anything being destructed or a toggle switch being deferred?
CurrentIndex	Int	Void	Get the enabled index of the buildable on the associated slot (-1 for nothing)
HidePreviewForIndex	Void	Int	Hides the ghost preview for the buildable on the associated slot
CanOwnerInteract	Bool	Void	Can the slot be interacted with by the army that owns it?
IconPathForIndex	String	CcoBattleArmy, Int	Retrieve the icon asset path for the associated slot buildable index
HasArtilleryMountLocation	Bool	Void	Does the slot support an artillery mount?
CanInteract	Bool	CcoBattleArmy	Can the slot be interacted with?
WorldPosition	Vector4	Void	Returns a Vector3 of the world position of the slot origin
ZoomTo	Void	Void	Zooms the camera to the position of this toggleable slot
IsMapBarrier	Bool	Void	Does the slot represent a toggleable barrier?
IsAnyEnabled	Bool	Void	Are any of the buildables associated with this slot, enabled?
IsFreeRotationAllowed	Bool	Void	Can the slot be rotated?
EnabledIndex	Int	Void	Which of the buildables is currently enabled? -1 for none
TypeString	String (list)	Void	Returns the type of the slot as an unlocalised string
IsBuilding	Bool	Void	Does the slot represent a toggleable building?
BuildablesList	CcoBattleToggleableSlotBuildable (list)	Void	Get the list of buildables associated with the slot (slot buildable indices associated with index-related functions in Toggleable Ccos)

CcoBattleToggleableSlotBuildable

Functions

Name	Return Type	Arguments	Description
Index	Int	Void	Return the index that this buildable represents in the associated slot
IsDestroyed	Bool	Void	Has the buildable been destroyed/taken maximum damage
IconPath	String	CcoBattleArmy	Retrieve the icon asset path for the buildable on the associated slot
CanRefund	Bool	CcoBattleArmy	Can the buildable be refunded
RefundValue	Float	Void	Get the currency refund value for this buildable in its current state
CanAfford	Bool	Context	Can the buildable be afforded
ParentContext	CcoBattleToggleableSlot	Void	Get the containing toggleable slot Cco for this buildable
Cost	Float	Int	Get the currency cost for this buildable for the army specified
CurrentState	String	CcoBattleArmy, Int	Get the visual state for the slot
ShowToolTip	Void	Void	Show the building tooltip for the buildable on the associated slot
HideToolTip	Void	Void	Hide the building tooltip for the buildable on the associated slot
PrimaryAction	Void	Void	Trigger the primary action for the slot
SecondaryAction	Void	Void	Trigger the secondary action for the slot
MapBarrierName	String	Void	Get the name if the map barrier is valid
HidePreview	Void	Void	Hides the ghost preview for the buildable on the associated slot
MapBarrierIsAvailable	Bool	Context	- Is this a map barrier that is available to the associated army
ShowPreview	Void	Void	Shows the ghost preview for the buildable on the associated slot

CcoBattleUnit

Component context wrapper for a battle unit, exposes all information available to UiEd

Functions

Name	Return Type	Arguments	Description	Tags
ZoomTo	Void	Void	Zooms camera to look at this unit
IsAwaitingOrderAfterRally	Bool	Void	Returns true if this unit recently rallied from routing and hasnt been given a command since, to highlight to player there are units not being taken advantage of
IsPartOfWave	Bool	Void	Returns true if this unit is currently routing (running away due to low morale, but might recover and come back)
DelayedBarrierHpPercent	Float	Void	Returns the units delayed barrier HP percent if any (barrier is a kind of rechargable shield)
ManList	CcoBattleEntity (list)	Void	Returns the list of CcoBattleEntity just for man entities
Position	Vector4	Void	Returns the current position
FatigueState	Int	Void	Returns the current fatigue state as an int (mirrors enum in code)
IsUnderAIControl	Bool	Void	Returns true if the unit is currently under AI control (instead of script or player)
IsCharacter	Bool	Void	Returns true if this unit is a character (general or agent basically)
BarrierHpPercent	Float	Void	Returns the units barrier HP percent if any (barrier is a kind of rechargable shield)
OriginalOwningNetworkPlayerContext	CcoNetworkPlayer	Void	Returns the CcoNetworkPlayer that originally had control of this unit (if unit gifted for example)
IsOutOfControl	Bool	Void	Returns true if this unit is currently out of control (meaning player has no control over them and they just attack the nearest unit)
Select	Void	Void	Selects this unit to control
StatusList	CcoUiUnitStatusRecord (list)	Void	Returns a list of CcoUiUnitStatusRecord that are currently active sorted in order of importance
IsInMelee	Bool	Void	Returns true if this unit is currently in melee combat
UniqueUiId	Int	Void	Returns the unique ui id of the unit as an int, unique amongst all units in the battle
IsUnderAIControlOriginally	Bool	Void	Returns true if the unit started the battle under AI control
RadarPosition	Vector4	Void	Returns the radar position (0-1, 0-1) as a percentage to be used with ContextRadarIcon
DevSetForceRampage	Void	Bool	Forces a unit to do rampage bool	debug, hide_in_uied
IsWavering	Bool	Void	Returns true if this unit is currently in wavering morale state (brink of routing)
BarrierReplenishDelay	Float	Void	Returns the barrier replenish delay (Time between taking damage and your barrier replenishing)
CanBeExecutedByNearbyEnemy	Bool	Void	Returns true if this unit is below the execute threshold health of a nearby enemy executioner
IsOriginallyOwnedByLocalPlayer	Bool	Void	Returns whether the local player originally owned this unit i.e. if it is gifted but still belongs to this player
EngineList	CcoBattleEntity (list)	Void	Returns the list of CcoBattleEntity just for engine entities
ThreatPercentOfUnitMouseover	Float	Void	Returns the threat of the unit currently mousing over (used on tooltips). -1 is invalid, 1 is high threat, 0 is low threat
AllianceColour	Colour	Void	Returns the colour based on alliance (player/friendly/enemy/neutral)
ExperienceLevel	Int	Void	Returns the current experience level
IsInvincible	Bool	Void	Returns true if the unit is invincible and cant take damage
ArmyContext	CcoBattleArmy	Void	Returns the CcoBattleArmy this unit belongs to
IsChangelingTransformation	Bool	Void	Returns true if this unit is currently transformed in a changeling form
DevToggleControl	Void	Void	Toggles control between player and UI, useful for taking control of enemy units for example	debug, hide_in_uied
CanToggleFlying	Bool	Void	Returns true if this unit can currently choose to toggle its flying state (taking into account interruptions, etc)
IsUnspottable	Bool	Void	Returns true if this unit has unspottable unit behaviour
IsSelected	Bool	Void	Returns true if this unit is currently selected
ThreatPercentOfUnit	Float	CcoBattleUnit	Returns the threat of the specified unit. -1 is invalid, 1 is high threat, 0 is low threat
MoraleState	Int	Void	Returns morale state as an int (mirrors enum in code)
DevSetHealAmount	Void	Int, Bool	Sets the heal amount to the specified percentage value [0-100]	debug, hide_in_uied
StatusColour	Colour	Void	Returns the colour for the current status, used for things like when in combat to identify if winning for example, or for when capturing capture point
IsHidden	Bool	Void	Returns true if this unit is currently hidden (using terrain types, etc)
IsForceRampage	Bool	Void	Returns true if the unit has a forced rampage
OwningNetworkPlayerContext	CcoNetworkPlayer	Void	Returns the CcoNetworkPlayer that is currently in control of this unit, for mp battles where unit sharing possible
IsVisible	Bool	Void	Returns true if this unit is currently visible to player (taking into account hidden state and line of sight
ToggleFlyingCooldownTimer	Float	Void	Returns the time (in seconds) remaining on the toggle flying cooldown timer
MountList	CcoBattleEntity (list)	Void	Returns the list of CcoBattleEntity just for mount entities
HealthReplenishRateBase	Float	Void	Returns the base rate at which health is being replenished by abilities
NumEntities	Int	Void	Returns the current number of entities
ActiveHarmonyEffectState	String	Bool (optional)	Returns a string representing the state of the current harmony effect (yin/yang), or an empty string if there is no active harmony effect. Optional argument specificies if harmony base type of the unit should count towards the effect, defaults to true
IsSelectable	Bool	Void	Returns true if this unit can be selected
IsBuffedByHarmony	Bool	Void	Returns true if the unit is currently receiving a battle harmony buff
CanAlwaysFlying	Bool	Void	Returns true if this unit has the ability to be always flying
StatusSubsetMostImportant	CcoUiUnitStatusRecord	Void	Same as StatusMostImportant BUT ignores certain statuses, as Fabian on 3k wanted to only show certain statuses on unit card as some statuses were shown in a different manner
HasStatus	Bool	Void	Returns true if unit has any CcoUiUnitStatusRecord currently
BattleAbilityList	CcoBattleAbility (list)	Void	Returns the list of abilities this unit can use as a list of CcoBattleAbility - these have current state information on abilities unlike CcoUnitAbility
DevSetInvincible	Void	Bool	Sets the unit invincible based on the supplied bool	debug, hide_in_uied
HealingPower	Float	Void	Returns this unit's modifier for healing
EntityList	CcoBattleEntity (list)	Void	Returns the list of CcoBattleEntity in the unit
NumEntitiesInitial	Int	Void	Returns the number of entities the unit entered the battle with
MoraleColour	Colour	Void	Returns the colour that represents the current MoraleState
DevRout	Void	Void	Will rout the unit	debug, hide_in_uied
IsOrderable	Bool	Void	Returns true if this can be given orders
BattleHarmonyEffectContext	CcoBattleUnitEffect	Void	Return a context to the currently active battle harmony effect, if there is one
IsHighlighted	Bool	Void	Returns true if the unit is currently highlighted
IsFlying	Bool	Void	Returns true if this unit is currently flying
PercentCasualtiesRecently	Float	Void	Returns the percentage of men lost in the last 4 seconds
UnlockedAbilities	CcoUnitSpecialAbilityRecord (list)	ContextList	); Returns a list of the unlocked abilities from the list of groups supplied
DevSetAmmoAmount	Void	Int, Bool	Sets the ammo amount to the specified value	debug, hide_in_uied
IsFiringAtWill	Bool	Void	Returns true if this unit has fire at will enabled
HasArtilleryDroppedEngines	Bool	Void	Returns true if artillery unit that has dropped their engines
IsPlayerUnit	Bool	Void	Returns true if this unit belongs to the player
BuildingContext	CcoBattleBuilding	Void	Returns the CcoBattleBuilding this unit is currently on/in
HealthValue	Int	Void	Returns the raw health value
MaxHealthPercentCanReplenish	Float	Void	Returns the max health percent that can be replenished by abilities
IconPath	String	Void	Returns the icon path used for unit cards, etc
CanFly	Bool	Void	Returns true if this unit has the ability to fly
IsRenown	Bool	Void	Returns true if a unit of renown (special limited units that have certain perks and we highlight in the UI)
IsEnemyUnit	Bool	Void	Returns true if this unit belongs to the enemy alliance
HealthMax	Int	Void	Returns the max health
SecondsLeftToTeleport	Int	Void	Returns number of seconds left in teleporting to withdraw process
StatusMostImportant	CcoUiUnitStatusRecord	Void	Returns the current most important CcoUiUnitStatusRecord that is active
AbilityList	CcoUnitAbility (list)	Void	Returns the list of abilities this unit can use as a list of CcoUnitAbility
ReloadPercentMax	Float	Void	Returns highest reload percent in entity (so closest entity to firing), with idea being requested by Attila so know when unit will next be able to shoot to stop players wondering why unit not attacking
IsIdle	Bool	Void	Returns true if this unit has no orders currently and is standing still
DevRespawn	Void	Void	Will respawn the unit	debug, hide_in_uied
UnitRecordContext	CcoMainUnitRecord	Void	Returns the CcoMainUnitRecord for this unit
UnitDetailsContext	CcoUnitDetails	Void	Returns the CcoUnitDetails for this unit, used for unit info panel that shows unit information from various sources
FatigueName	UniString	Void	Returns the localised name of the current FatigueState
IsWalking	Bool	Void	Returns true if this unit is currently moving at walking pace
ShouldShowAmmo	Bool	Void	Returns true if we should show ammo UI for this unit
CooldownPassiveAbilityList	CcoBattleAbility (list)	Void	Returns a list of passive battle abilities current on cooldown
IsUndead	Bool	Void	Returns true if unit is undead or construct (different morale rules apply to these, have crumbling and unstable states)
CanGuerrillaDeployCurrently	Bool	Void	Returns true if the unit CanGuerrillaDeploy and can do this currently (has extra checks like not in a vehicle, etc)
PercentHpLostRecently	Float	Void	Returns the percentage of HP lost in the last 4 seconds
CopyMemoryAddressToClipboard	Void	Void	Copies the memory address of this models actual unit to the clipboard which is handy for creating conditional breakpoints	debug, hide_in_uied
SetupUnitContext	CcoBattleSetupUnit	Void	Returns the CcoBattleSetupContext which wraps BATTLE_SETUP_UNIT for this unit (setup info came into battle with)
IsRunning	Bool	Void	Returns true if this unit is currently moving at running pace
BreakForDebugging	Void	Void	Breaks in to attached IDE to inspect model UNIT in greater detail	debug, hide_in_uied
IsSpawnedUnit	Bool	Void	Returns true if a spawned unit (came from an ability for example during the battle)
ActiveEffectState	String	Bool (optional)	Returns a string representing state of active effects (positive/negative/both) if any, optional bool can be provided which when true will only consider non-passive effects as counting
IsGeneral	Bool	Void	Returns true if this unit is a commanding general unit
HasHarmonyEffect	Bool	Void	Returns true if the unit is tagged as a Yin or Yang battle harmony unit
DevResetAbilityUses	Void	Void	Reset ability uses	debug, hide_in_uied
MoraleGreatestEffect	UniString	Void	Returns the localised name of the effect that is having the greatest effect on morale currently
IsWithdrawing	Bool	Void	Returns true if this unit is withdrawing from the map (running to edge of map to retire from battle)
BannerHolderEntityContext	CcoBattleEntity	Void	Returns the CcoBattleEntity for the entity currently holding the unit banner (entity who UI baner floats above)
ExperiencePercent	Float	Void	Returns the experience percentage of progress to next level
DevKill	Void	Void	Will kill the unit	debug, hide_in_uied
IsBarrierCharging	Bool	Void	Returns true if the unit has a barrier and it is currently recharging (barrier is a kind of rechargable shield)
HasInfinitePrimaryAmmo	Bool	Void	Returns true if has infinite primary ammo
LargestNearbyEnemyExecuteThreshold	Float	Void	Returns the largest execution threshold of nearby enemies (Either from the executor attribute or ability phases)
IsTeleportWithdrawing	Bool	Void	Returns whether unit is currently teleporting to withdraw
IsInLastStand	Bool	Void	Returns true if unit is currently in last stand, this is when they have no where to escape to and so will fight to last man
DamageInflictedRecently	Int	Void	Returns the amount of damage inflicted in the last 4 seconds
MoralePercent	Float	Void	Returns the current morale as a percentage of best morale could be
DevResetAbilityManager	Void	Void	Reset ability manager	debug, hide_in_uied
ToggleFlying	Void	Void	Toggles a unit between flying in the air and moving on the ground (for units that CanFly)
IsCapturing	Bool	Void	Returns true if this unit is currently capturing a capture point
MoraleNameWithGreatestEffect	UniString	Void	Returns a combination of MoraleName and MoraleGreatestEffect. No longer needed since can add strings with expressions	deprecated
IsReadyToExtract	Bool	Void	Returns true if an ambush battle with an extraction location and they are in the extraction zone ready to safely recover
HasInfiniteSecondaryAmmo	Bool	Void	Returns true if has infinite secondary ammo
ActiveFactionSpecificEffectList	CcoEffect (list)	Void	(Returns a list of the CcoEffects that are being applied to the unit from Storm of Magic ascendancies
CapturePower	Float	Bool (optional)	Returns the current capture power of this unit. Scaled by the unit's remaining men. Returns 0.0 when not on a map with capture points
CanGuerrillaDeploy	Bool	Void	Returns true if the unit has the ability to guerilla deploy (deploy outside deployment zone)
IsWounded	Bool	Void	Returns true if this unit currently has the specific wounded ability provided by Gary as wants to indicate this on health bars as special case
DevResetAbilityRecharge	Void	Void	Reset ability recharge	debug, hide_in_uied
IsShattered	Bool	Void	Returns true if this unit is shattered (morale so low that they will no longer recover and are essentially lost)
CustomName	UniString	Void	Returns any custom name given to this unit
ActiveProjectileContext	CcoProjectileRecord	Void	Returns the current CcoProjectileRecord context the unit is using for ranged attacks
GiftToOriginalOwner	Void	Void	Gifts the unit back to their original owning player when the unit is currently a shared unit
PrimaryAmmoPercent	Float	Void	Returns the percentage of primary ammo remaining (0-1)
BarrierHp	Int	Void	Returns the units barrier HP if any (barrier is a kind of rechargable shield)
IsUnderPlayerControl	Bool	Void	Returns true if this unit is currently under the players control
BarrierCapPercent	Float	Void	Returns the units barrier percentage the current max is against the initial max, which is essentially the health percentage of a unit at the minute (barrier is a kind of rechargable shield)
MoraleName	UniString	Void	Returns the localised name of the current MoraleState
OfficerEntityContext	CcoBattleEntity	Void	Returns the CcoBattleEntity for the current officer entity (entity leading this unit)
ActiveEffectList	CcoBattleUnitEffect (list)	Bool (optional), String (optional)	( Only Non-Passive Effects, Filter by source ability type); Returns a list of the active effects on the unit from abilities, etc
IsFiringMissiles	Bool	Void	Returns true if this unit is currently firing missilees
SecondaryAmmoPercent	Float	Void	Returns the percentage of secondary ammo remaining(0 - 1)
DevSetArmy	Void	Int	Gives control of the unit to a given army	debug, hide_in_uied
IsAffectedByStormOfMagic	Bool	Void	Returns true if affected by storm if there is a storm active, and we have an ability that uses the lore that is currently ascendant
BarrierMaxHp	Int	Void	Returns the units barrier max HP if any (barrier is a kind of rechargable shield)
IsTerrified	Bool	Void	Returns true if unit is currently in a terrified state which seriously affects their morale (comes from units that have terrifying unit behaviour)
Highlight	Void	Bool	Highlights on the 3d battlefield in same way script can (flashes entity markers and unit ids for example)
BarrierSecsUntilRecharge	Float	Void	Returns the number of seconds until the barrier will start recharging if the unit has a barrier and it has depleted (barrier is a kind of rechargable shield)
ToggleHighlight	Void	Void	Toggles the highlight shown with Highlight command
PurchasedEffectsList	CcoUnitPurchasableEffectRecord (list)	Void	Returns a list of CcoUiUnitStatusRecord that are currently active sorted in order of importance
IsUnderMissileAttack	Bool	Void	Returns true if this unit is currently being fired upon
DevTeleport	Void	String, String	Teleports a unit	debug, hide_in_uied
IsUnderMyControl	Bool	Void	Returns true if the unit is under the player control
HealthPercent	Float	Void	Returns the health of the unit as a percentage (0-1)
NumKills	Int	Void	Returns the number of kills this unit has performed in this battle
IsTakingDamage	Bool	Void	Returns true if this unit is currently taking damage
CanNearlyBeExecutedByNearbyEnemy	Bool	Void	Returns true if this unit is nearing the execute threshold health of a nearby enemy executioner ('nearing' value defined in the kv_ui_tweakers table)
BarrierReplenishRate	Float	Void	Returns the barrier replenish rate as a percentage of the barrier's total hp
BattleResultUnitContext	CcoBattleResultUnit	Void	Returns the CcoBattleResultUnit for the current unit
IsRouting	Bool	Void	Returns true if this unit is currently routing (running away due to low morale, but might recover and come back)
Name	UniString	Void	Returns the localised name of the unit
VehicleContext	CcoBattleVehicle	Void	Returns the current CcoBattleVehicle this unit is using if any
IsGifted	Bool	Void	Returns true if this unit has been gifted so the original owner isnt currently controlling
DelayedHealthPercent	Float	Void	Returns the delayed health of the unit as a percentage (0-1)
HasCharacterRank	Bool	Void	Returns whether the unit supports having a rank or not
DevTakeControl	Void	Void	Gives control of the unit to the player	debug, hide_in_uied
CharacterRank	Int	Void	Returns the rank of the character this unit is for if any
IsAlive	Bool	Void	Returns true if this unit is still alive

CcoBattleUnitEffect

Wrapper for a battle unit effect

Functions

Name	Return Type	Arguments	Description
StartTimeSeconds	Int	Void	Return the start time in seconds for this effect
TotalDurationSeconds	Float	Void	Returns the total duration of this effect
TimeRemainingSeconds	Int	Void	Return the time in seconds remaining for this effect
AbilityContext	CcoUnitAbility	Void	Return the setup ability for this effect
IconPathSmall	String (list)	Void	Returns the small icon path for the effect
BattleAbilityContext	CcoBattleAbility	Void	Return the battle ability for this effect
TooltipLayout	String (list)	Void	Returns the tooltip layout that should be used for this effect
PhaseRecordContext	CcoSpecialAbilityPhaseRecord	Void	Return the activating phase record for this effect
Name	UniString (list)	Void	Returns the name of the effect
IconPath	String (list)	Void	Returns the icon path for the effect
Intensity	Float	Void	Returns the intensity that that the effect is being multiplied by, or 1.0f if there is no intensity amount
HasIntensity	Bool	Void	Returns true if this effect is modified by an intensity value greater than 1.0f
PercentComplete	Float	Void	Returns the percentage of the effect that has completed

CcoBattleVehicle

Functions

Name	Return Type	Arguments
UnitContext	Void	Void
CategoryName	Void	Void
Description	Void	Void
IconPath	Void	Void
Position	Void	Void
Name	Void	Void
HealthPercent	Void	Void
PercentOnFire	Void	Void
IsDestroyed	Void	Void
ArmyContext	Void	Void

CcoBattleWindsOfMagicPool

Functions

Name	Return Type	Arguments
RechargeModifierPhaseList	Void	Void
DepletionModifierPhaseList	Void	Void
IsWindsOfMagicGamblerOpen	Void	Void
SpellPreviewRemainingMana	Void	Void
RechargeRateString	Void	Void
CurrentRechargePerSecond	Void	Void
RechargeRatePercentage	Void	Void
CurrentWind	Void	Void
ReserveWind	Void	Void
MaxWind	Void	Void
IsEnabled	Void	Void
HasUnlimitedWind	Void	Void

CcoReinforcementArmy

Functions

Name	Return Type	Arguments	Description	Tags	Events
Delay	Void	Void
EntryPosition	Void	Void

Misc

CcoContextExpression

Functions

Name	Return Type	Arguments	Description	Tags	Events
TextRepresentation	String	Void
EvaluateExpression	ArgumentPack	Context, ArgumentPack

CcoContextExpressionCompilationError

Functions

Name	Return Type	Arguments	Description	Tags	Events
Description	String	Void

CcoContextExpressionResult

Functions

Name	Return Type	Arguments
ResultType	CcoContextObjectType	Void
HasStringRepresentation	Bool	Void
Value	ArgumentPack	Void

CcoContextExpressionRuntimeError

Functions

Name	Return Type	Arguments	Description	Tags	Events
Description	String	Void

CcoContextList

Functions

Name	Return Type	Arguments	Description
Take	ContextList	Int	Returns the first N elements of the list
Size	Int	Void	Returns the number of elements in the list
Reverse	ContextList	Void	Returns the list in the opposite order
Skip	ContextList	Int	Skip the first x elements of the list
IsEmpty	Bool	Void	Returns true if the list is empty
Sort	ContextList	ExpressionState, Expression, Bool (optional)	Returns the list sorted by the given expression, pass true for second parameter to sort in ascending order (defaults to descending)
SummedValueList	ContextList	ExpressionState, Expression, Expression	Returns a list of CcoSummedValueContext, where the first expression supplied is to determine what groups two contexts, and the second expression is used to calculate the value for each context for summing the values
BSort	ContextList	ExpressionState, Expression	Sort based on a function that expects left and right and returns true if their relative position is correct and false if they need to swap places
Contains	Bool	Context	Returns true if supplied context exists in the list
Filter	ContextList	ExpressionState, Expression	Returns a list with all the elements of the given list that satisfy the condition.
PadRight	ContextList	ExpressionState, Int, Expression (optional)	Returns a list with at least N number of elements. If the original list had less than N elements, the new elements will be either CcoEmptyObject or the object returned by the given expression.
Distinct	ContextList	ExpressionState, Expression (optional)	Returns the distinct elements of the list
All	Bool	ExpressionState, Expression	Returns true if all the contexts return true for the given expression
Count	Int	ExpressionState, Expression	Returns the number of elements that satisfy the given expression
Any	Bool	ExpressionState, Expression	Returns true if any of the contexts return true for the given expression
Append	ContextList	ExpressionState, ArgumentPack	Returns a list new list, containing the current list's elements + any elements passed in as an argument (the argument must be a context expression, and must return either a single context object or another context object list).
MinValue	Float	ExpressionState, Expression	Returns the smallest value evaluated for each context in the list using expression
CompareSort	ContextList	CcoContextList, ExpressionState, Expression
ForEach	Void	ExpressionState, Expression	Performs the supplied expression on each context
MaxValue	Float	ExpressionState, Expression	Returns the largest value evaluated for each context in the list using expression
At	Context	Int	Returns the context at the specified index
NextContext	Context	Context	Given a context that exists in the list, returns the next context if one exists, will also wrap around the end of the list. If list only has one element will return the one element
MinContext	Context	ExpressionState, Expression	Returns the context with the smallest value evaluated for each context in the list using expression
Transform	ContextList	ExpressionState, Expression	Transforms the list into a new one where each element is produced by the given expression
MaxContext	Context	ExpressionState, Expression	Returns the context with the largest value evaluated for each context in the list using expression
IndexForFirstContext	Int	ExpressionState, Expression	Returns the index of the first context that returns true for the supplied expression
JoinString	UniString	ExpressionState, Expression, UniString	Returns a combined string using the first expression to determine how to get the string for each context, and splitting each entry with the supplied separator
FindIf	Context	ExpressionState, Expression
PreviousContext	Context	Context	Given a context that exists in the list, returns the previous context if one exists, will also wrap around the beginning of the list. If list only has one element will return the one element
LastContext	Context	ExpressionState, Expression (optional)	Returns the last context by default, if supply an expression as a parameter it will return the last context that returns true for the condition and otherwise return null
Partition	ContextList	ExpressionState, Expression	Returns the subset of the list at the point where the first context matches the given expression
Sum	ArgumentPack	ExpressionState, Expression	Accumulates the values returns by each contexts expression (for adding up totals)
List	ContextList	Void	Returns internal list of contexts
FirstContext	Context	ExpressionState, Expression (optional)	Returns the first context by default, if supply an expression as a parameter it will return the first context that returns true for the condition and otherwise return null
Reduce	ArgumentPack	ExpressionState, Expression, Expression (optional)	Reduces the list based on given predicate starting at optional initialiser value
Find	Context	Context

CcoContextObjectType

Functions

Name	Return Type	Arguments
IsArithmetic	Bool	Void
IsList	Bool	Void
Name	String	Void
HasStringRepresentation	Bool	Void
SymbolsList	ContextList	Void

CcoContextSymbol

Functions

Name	Return Type	Arguments
IsCommand	Bool	Void
EvaluateSymbol	ArgumentPack	Context, ArgumentPack
TypeContext	CcoContextObjectType	Void
Documentation	String	Void
Name	String	Void
Tags	String	Void

CcoFindResult

Functions

Name	Return Type	Arguments	Description	Tags	Events
Index	Int	Void
Context	Context	Void

CcoGroupList

Functions

Name	Return Type	Arguments	Description	Tags	Events
GroupedList	ContextList	Void
CategoryObject	Context	Void

CcoPair

Functions

Name	Return Type	Arguments	Description	Tags	Events
First	ArgumentPack	Void	First member of the pair
Second	ArgumentPack	Void	Second member of the pair

CcoRuntimeObject

Functions

Name	Return Type	Arguments	Description	Tags	Events
Internal	Context	Void

CcoString

Wrapper for string type, for dealing with text (localised and unlocalised, we abstract the difference between wide/narrow for simplicity of context system users)

Functions

Name	Return Type	Arguments	Description
RemoveLeadingWhitespace	UniString	Void	Returns a copy of this string with leading whitespace removed
Length	Int	Void	Returns the length of this string
Substr	UniString	Int, Int (optional)	Returns a sub-section of this string as specified by the starting index and optional length (if no length will return from start index to end of string)
RFind	Int	CcoString, ExpressionState, UniString, Int (optional)	Returns the first index of the specified string, searching from the back. Returns -1 if none found. Can specify a starting position to search from as second parameter, this defaults to 0 if none specified
IsEmpty	Bool	Void	Returns true if this string is empty/blank
Replace	UniString	CcoString, ExpressionState, UniString, UniString	Returns a copy of this string where all instances of the first string supplied are replaced with the second string supplied
Contains	Bool	CcoString, ExpressionState, UniString	Returns true if this string contains the specified string
Value	UniString	Void	Returns the string value represented by this string
Find	Int	CcoString, ExpressionState, UniString, Int (optional)	Returns the first index of the specified string, searching from the front. Returns -1 if none found. Can specify a starting position to search from as second parameter, this defaults to 0 if none specified
ExtractColourFromText	UniString	Void	Returns the colour tag from the specified text
StartsWith	Bool	CcoString, ExpressionState, UniString	Returns true if this string starts with the specified string
Hash	Int	Void	Returns hash of the string
EndsWith	Bool	CcoString, ExpressionState, UniString	Returns true if this string ends with the specified string
ParseTextReplacements	UniString	CcoString, ExpressionState	Returns a copy of this string where any text tags are parsed and replaced in with the actual text
ExtractImageIconFromText	UniString	Void	Returns the image path inside the image tag in the specified text
ToLowerLocalised	UniString	CcoString, ExpressionState	Returns a copy of this string where all letters are lowercase, this uses current locale so the string will use special characters and might not be same as English lowercase
RemoveFilepathDirectory	UniString	Void	Returns a copy of this string with the parent directory removed, assuming this string is a filepath
RemoveFilepathExtension	UniString	Void	Returns a copy of this string with the file extension removed, assuming this string is a filepath
ToLowerUnlocalised	UniString	CcoString	Returns a copy of this string where all letters are lowercase, this uses default string lowercase and will not take localisation into account
RemoveTextTags	UniString	Void	Returns a copy of this string with all text tags removed
ToUpperLocalised	UniString	CcoString, ExpressionState	Returns a copy of this string where all letters are uppercase, this uses current locale so the string will use special characters and might not be same as English uppercase
ToUpperUnlocalised	UniString	CcoString	Returns a copy of this string where all letters are uppercase, this uses default string uppercase and will not take localisation into account

CcoSummedValueContext

Functions

Name	Return Type	Arguments
SummedList	ContextList	Void
OriginalContext	Context	Void
SummedValue	Float	Void

CcoVector2

Functions

Name	Return Type	Arguments
Modulus	Float	Void
Distance	Float	Vector2
x	Float	Void
y	Float	Void
Value	Vector2	Void

CcoVector3

Functions

Name	Return Type	Arguments
Distance	Float	Vector3
y	Float	Void
z	Float	Void
Modulus	Float	Void
Value	Vector3	Void
x	Float	Void

CcoVector4

Functions

Name	Return Type	Arguments
Modulus	Float	Void
Distance	Float	Vector4
z	Float	Void
w	Float	Void
x	Float	Void
y	Float	Void
Value	Vector4	Void

Callbacks

UI Update Messages

UI Symbols Documentation

Contexts

Campaign

CcoCampaignAncillary

CcoCampaignAreaOfInterest

CcoCampaignArmoryItemVariant

CcoCampaignArmyPlague

CcoCampaignBasePlague

CcoCampaignBattle

CcoCampaignBuilding

CcoCampaignBuildingLifecycleState

CcoCampaignBuildingSlot

CcoCampaignBuildingVariant

CcoCampaignCaravan

CcoCampaignCaravanRecruitmentItem

CcoCampaignCharacter

CcoCampaignCharacterAutoManagement

CcoCampaignCharacterLoyalty

CcoCampaignCharacterSkill

CcoCampaignCharacterSkillLevelDetails

CcoCampaignCharacterTeleportationInteraction

CcoCampaignCharacterTeleportationSystem

CcoCampaignCharacterTrainingGroup

CcoCampaignCharacterTrainingSlot

CcoCampaignConstructionItem

CcoCampaignCorruptionCounter

CcoCampaignCursorContext

CcoCampaignDiplomacyManager

CcoCampaignDiplomacyManipulationInfo

CcoCampaignDiplomacyManipulationInteraction

CcoCampaignElectorSeat

CcoCampaignEventAgentTargetsCharacter

CcoCampaignEventAgentTargetsSettlement

CcoCampaignEventAncillaryOrTrait

CcoCampaignEventArmoryItem

CcoCampaignEventBattleResult

CcoCampaignEventBuildingConstructed

CcoCampaignEventDilemma

CcoCampaignEventDiplomacy

CcoCampaignEventFaction

CcoCampaignEventFeed

CcoCampaignEventFeedCustomMission

CcoCampaignEventFeedFilter

CcoCampaignEventFeedGroup

CcoCampaignEventFeedMessageDetails

CcoCampaignEventFeedOpenEvent

CcoCampaignEventFeedRecords

CcoCampaignEventFeedRound

CcoCampaignEventFeedSummary

CcoCampaignEventFeedYear

CcoCampaignEventHostileAction

CcoCampaignEventIncident

CcoCampaignEventMercenaryUnitUnlock

CcoCampaignEventTechnologyResearched

CcoCampaignEventTrainingDilemmaAvailable

CcoCampaignEventUnitRecruitment

CcoCampaignFaction

CcoCampaignFactionAlliedBuildings

CcoCampaignFactionCaravans

CcoCampaignFactionGovernorship

CcoCampaignFactionInteraction

CcoCampaignFactionProvinceManager

CcoCampaignFactionWarContracts

CcoCampaignFactionWomCompass

CcoCampaignGovernorshipInteraction

CcoCampaignInitiative

CcoCampaignInitiativeManager

CcoCampaignInitiativeSet

CcoCampaignMilitaryForce

CcoCampaignMilitaryForceHorde

CcoCampaignMilitaryForceMorale

CcoCampaignMilitaryForceStance

CcoCampaignMilitaryForceWarTargetting

CcoCampaignMission

CcoCampaignMissionDefinition

CcoCampaignMissionObjective

CcoCampaignMissionObjectiveRequirements

CcoCampaignNegotiation

CcoCampaignPayloadInfo

CcoCampaignPayloadInfoEntry

CcoCampaignPendingAction

CcoCampaignPendingActionNotification

CcoCampaignPendingActionNotificationQueue

CcoCampaignPlagueComposition

CcoCampaignPlagueCompositionEffectList

CcoCampaignPlagueInfection

CcoCampaignPlagueIngredient

CcoCampaignPlaguesCompositionSystem

CcoCampaignPooledResource

CcoCampaignPooledResourceDistributor

CcoCampaignPooledResourceManager

CcoCampaignPooledResourceMilitaryForceBreakdown

CcoCampaignPooledResourceProvinceBreakdown

CcoCampaignPooledResourceSettlementBreakdown

CcoCampaignPooledResourceTransaction

CcoCampaignProvince

CcoCampaignProvinceAutoManagement

CcoCampaignProvinceGovernorship

CcoCampaignPublicOrder

CcoCampaignResourceTransaction

CcoCampaignRitual

CcoCampaignRitualChain

CcoCampaignRitualInteraction

CcoCampaignRitualManager

CcoCampaignRoot

CcoCampaignRouteNode

CcoCampaignRouteSegment

CcoCampaignSettlement

CcoCampaignSkavenCorruptionOverlay

CcoCampaignSlaves

CcoCampaignTechnology

CcoCampaignTechnologyManager

CcoCampaignTreasuryTransaction

CcoCampaignUnit

CcoCampaignUnitGroupUpgrade

CcoCampaignUnitPurchasableEffectCost

CcoCampaignUnitUpgradeManager

CcoCampaignUnitUpgradesBuildingRequirement

CcoCampaignUnitUpgradesTechRequirement

CcoCampaignWarContract

CcoCampaignWarCoordinationRequest

CcoCampaignWinStreak

CcoCampaignWindsOfMagicArea

CcoCampaignWindsOfMagicSystem

CcoCampaignWomCompassDirection

CcoCampaignWomCompassPowerLevelRange

CcoCookingDish

CcoCookingSystem

CcoDiplomacyThreatLevel

CcoEpisodicOverride

CcoFloatingTextAgentActionEvent

CcoFloatingTextBattleEvent

CcoFloatingTextStanceEvent

CcoJadeMissionElement

CcoMalakaiOathsQuestChain

CcoPooledResourceTransfer

CcoPreBattleAIAvailableGenerals

CcoPreBattleFactionVote

CcoPreBattleVotingSystem

CcoPrisonSystem

CcoSaveGameHeader

CcoTempleOfTheOldOnes

CcoBattleCaptureLocationsManager

CcoBattleCapturePoint

CcoBattleCurrencyManager

CcoBattleCursorContext

CcoBattleEntity

CcoBattleGroup

CcoBattleLaboratoryInfo

CcoBattlePurchasableArmyAbility

CcoBattlePurchasableUnit

CcoBattlePurchasableUnitAbility

CcoBattleReinforcementArmy

CcoBattleReinforcementDebugUnits

CcoBattleReinforcementPool

CcoBattleSetupAlliance

CcoBattleSetupArmy

CcoBattleSetupFaction

CcoBattleSetupInfo

CcoBattleSetupUnit

CcoBattleSpawnZone

CcoBattleStormOfMagic

CcoBattleSurvivalWave

CcoBattleTimeControl

CcoBattleToggleableSlot

CcoBattleToggleableSlotBuildable

CcoBattleUnit

CcoBattleUnitEffect

CcoBattleVehicle

CcoBattleWindsOfMagicPool

CcoReinforcementArmy

Common

CcoAdvisor

CcoAgentSubtypeAgentPair

CcoBattleResult

CcoBattleResultAlliance

CcoBattleResultArmy

CcoBattleResultUnit

CcoCallbackExpressionStore

CcoCampaignEffectGroup

CcoCampaignFactionMercenaryPool

CcoCampaignMercenaryPoolUnit

CcoCampaignModelBuilding

CcoCampaignModelFaction

CcoCampaignModelInitiative

CcoCampaignModelInitiativeManager

CcoCampaignModelInitiativeSet

CcoCampaignModelMilitaryForce

CcoCampaignModelPooledResource

CcoCampaignModelProvince

CcoCampaignModelRegion

CcoCampaignModelRoot

CcoCampaignModelUnit

CcoCampaignProvinceMercenaryPool

CcoCampaignStartInfo

CcoCharacterSpecialUnitAvailability

CcoClickHoldContext

CcoComponent

CcoComponentModelView

CcoContextHistoryObject

CcoContextSelection

CcoCustomBattleArmyPreset

CcoCustomBattleArmyPresetFileHandler

CcoCustomBattleLobby

CcoCustomBattleMap

CcoCustomBattlePlayerSlot

CcoCustomBattleSettings

CcoCustomBattleTeam

CcoCustomBattleUnit

CcoCustomBattleUnitUpgrade

CcoEffect

CcoEffectBundle

CcoFactionSavedCharacters

CcoFactorBreakdown

CcoFrontendFactionLeader

CcoFrontendRoot

CcoGameCore

CcoIngameMessaging

CcoIngameMessagingItem

CcoMPCampaignSettings

CcoOwnershipProductRequirement

CcoPieData

CcoPieSlice

CcoRangeWithContext

CcoSavedCharacterInfo

CcoSliderValueContext

CcoSpineAnimationState

CcoTreeLinkWithContexts

CcoURI

CcoUiWarning

CcoUnitAbility

CcoUnitAbilityDetails

CcoAbilityCollectionRecord

CcoAbilityRecord

CcoActionResultRecord

CcoAdviceLevelRecord

CcoAgentActionRecord

CcoAgentCultureDetailRecord

CcoAgentRecord

CcoAgentSubtypeRecord

CcoAncillariesCategoryRecord

CcoAncillariesSubcategoryRecord

CcoAncillaryRecord

CcoAncillarySetRecord

CcoAncillaryTypeRecord

CcoAncillaryUniquenessGroupingRecord

CcoArmoryItemRecord

CcoArmoryItemSetRecord

CcoArmoryItemUiTypeRecord

CcoArmoryItemVariantRecord

CcoArmorySlotTypeRecord

CcoArmySpecialAbilityRecord

CcoBannerRecord

CcoBattleClimateWeatherDescriptionRecord

CcoBattleCurrencyArmySpecialAbilitiesCostValueRecord

CcoBattleCurrencyUnitAbilitiesCostValueRecord

CcoBattleEntityRecord

CcoBattlePurchasableGroupRecord

CcoBattlePurchasableItemsJunctionRecord

CcoBattlePurchasableItemsUiCategoryRecord

CcoBattleRecord

CcoBattleResultTypeRecord

CcoBattleSecondaryCurrencySourceTypeRecord

CcoBattleSecondaryCurrencyTypeRecord

CcoBattleSetPieceArmiesCharacterRecord

CcoBattleSetPieceArmiesCharactersItemRecord

CcoBattleSetPieceArmiesCharactersSkillRecord

CcoBattleSetPieceArmiesUnitRecord

CcoBattleSetPieceArmyRecord

CcoBattleSetPieceFrontendGroupRecord

CcoBattleSetPieceFrontendGroupsToCharacterRecord

CcoBattleSetPieceRecord

CcoBattleTypeCheatSheetEntryRecord

CcoBattleTypeRecord

CcoBattleVortexRecord

CcoBattleWeatherTypeRecord

CcoBattlefieldEngineRecord

CcoBattlefieldSiegeVehicleRecord

CcoBattlefieldSiegeVehiclesCustomBattleRecord

CcoBuildingChainRecord

CcoBuildingCultureVariantRecord

CcoBuildingLevelRecord

CcoBuildingSetRecord

CcoBuildingSuperchainRecord

CcoBulletPoint

CcoCampaignBattlePresetRecord

CcoCampaignDecisionChoiceRecord

CcoCampaignDecisionRecord

CcoCampaignEffectListRecord

CcoCampaignEffectScopeRecord

CcoCampaignFactionCheatSheetEntryRecord

CcoCampaignGroupRecord

CcoCampaignMapPlayableAreaRecord

CcoCampaignMapWindsOfMagicAreaRecord

CcoCampaignMapWindsOfMagicStrengthRecord

CcoCampaignOperationSetRecord

CcoCampaignPayloadRecord

CcoCampaignPayloadResourceTransactionRecord

CcoCampaignPayloadUnitComponentRecord

CcoCampaignStormTypeRecord

CcoCampaignStreakEffectRecord

CcoCampaignStreakRecord

CcoCampaignVideoRecord

CcoCapturePointCategoryTypeRecord

CcoCapturePointTypeRecord

CcoCaravanContractRecord

CcoCdirEventsCategoryRecord

CcoCdirEventsDilemmaChoiceDetailRecord

CcoCharacterAncillaryQuestUiDetailRecord

CcoCharacterSkillRecord

CcoCharacterTrainingDilemmaChoiceRecord

CcoCharacterTrainingDilemmaRecord

CcoCharacterTraitLevelRecord

CcoCharacterTraitRecord

CcoClimateRecord

CcoCookingIngredientGroupRecord

CcoCookingIngredientRecord

CcoCookingRecipeRecord

CcoCorruptionCounterIntervalRecord

CcoCorruptionTypeRecord

CcoCultureRecord

CcoCustomBattleCorruptionType

CcoCustomBattleFactionRecord

CcoCustomBattleSettingRecord

CcoDaemonAbilityBarDescriptionRecord

CcoDeployableRecord

CcoDeployablesCustomBattleRecord

CcoDilemmaRecord

CcoDiplomaticStanceRecord

CcoElectorCountRecord

CcoEndTurnNotificationRecord

CcoEventFeedCategoryRecord

CcoFactionRecord

CcoFactionSetRecord

CcoFormationRecord

CcoFrontendFactionLeaderRecord

CcoGroundTypeRecord

CcoGroundTypeToStatEffectRecord

CcoGroupPooledResourceEffectRecord

CcoIncidentRecord

CcoInitiativeRecord

CcoInitiativeSetCategoryRecord

CcoInitiativeSetRecord

CcoInitiativeUnitSetRequirementsRecord

CcoLabSettingRecord

CcoLandUnitArticulatedVehicleRecord

CcoLandUnitsToExtraEngineRecord

CcoLoadingScreenQuotesRecord

CcoMainUnitRecord

CcoMeleeWeaponRecord

CcoMercenaryRecruitmentInfoRecord

CcoMissileWeaponRecord

CcoMissionIssuerRecord

CcoMissionRecord

CcoMortuaryCultCategoryRecord

CcoMountRecord

CcoMountableArtilleryUnitsCustomBattleRecord

CcoMultiplayerCampaignSettingRecord

CcoMultiplayerCampaignSettingsOptionRecord

CcoNarrativeViewerEntryRecord

CcoNarrativeViewerTabRecord

CcoNewContentPatchNoteRecord

CcoOwnershipProductRecord

CcoPlagueComponentUiDataRecord

CcoPlagueEffectList

CcoPlagueEffectRecord

CcoPlagueMutationUiDataRecord

CcoPlagueParameterRecord

CcoPlagueRecord

CcoPlagueSpecialCompositionRecord

CcoPooledResourceThresholdOperationSetRecord

CcoProjectileBombardmentRecord

CcoProjectileRecord

CcoProphecyOfSotekStageRecord

CcoProphecyOfSotekStagesToMissionRecord

CcoProvinceAutomanagementFocusRecord

CcoProvinceInitiativeRecord

CcoRegionGroupRecord

CcoRegionRecord

CcoReignOfChaosRecord

CcoResourceCostRecord

CcoResourceRecord

CcoRitualCategoryGroupRecord

CcoRitualCategoryRecord

CcoRitualChainRecord

CcoRitualPayloadAncillaryRecord

CcoRitualPayloadChangeAgentCapacityRecord

CcoRitualPayloadChangeUnitAllowanceCapacityRecord

CcoRitualPayloadChangeUnitCapacityRecord

CcoRitualPayloadDiplomaticAttitudeChangeRecord

CcoRitualPayloadRecord

CcoRitualPayloadSpawnAgentRecord

CcoRitualPayloadSpawnArmyRecord

CcoRitualPayloadSpawnMercenaryRecord

CcoRitualPayloadSpawnStormRecord

CcoRitualPayloadTeleportArmyRecord

CcoRitualPayloadTriggerDilemmaRecord

CcoRitualRecord

CcoSeasonRecord

CcoSettlementClimateTypeRecord

CcoSpawnableForceRecord

CcoSpawnableForceUnitJunctionRecord

CcoSpawnableForceUnitListJunctionRecord

CcoSpecialAbilityGroupRecord

CcoSpecialAbilityIntensitySettingRecord

CcoSpecialAbilityPhaseRecord

CcoSpecialAbilityPhaseStatEffectRecord

CcoSubcultureRecord

CcoTechnologyRecord

CcoTechnologyUiGroupRecord

CcoTechnologyUiTabRecord

CcoTeleportationNetworkNodeRecord

CcoTeleportationNodeTemplateRecord

CcoTimeOfLegendsCampaignRecord

CcoTreasureHuntExtraInformationRecord

CcoUiColourRecord

CcoUiMainThemeOptionRecord

CcoUiPurchasableEffectsToHexIdRecord

CcoUiUnitGroupParentRecord

CcoUiUnitGroupingRecord

CcoUiUnitStatRecord

CcoUiUnitStatusRecord

CcoUnitAbilitiesAdditionalUiEffectRecord

CcoUnitAbilityRecord

CcoUnitAbilityTypeRecord

CcoUnitAttributeRecord

CcoUnitLandRecord

CcoUnitListRecord

CcoUnitPortholeCameraSettingRecord

CcoUnitPurchasableEffectRecord

CcoUnitPurchasableEffectsCategoryRecord

CcoUnitSetRecord

CcoUnitSetToMpUnitCapRecord

CcoUnitSpecialAbilityRecord

CcoUnitsCustomBattleMountRecord

CcoUnitsCustomBattlePermissionRecord

CcoUnitsCustomBattleTypeCategoryRecord

CcoUnitsCustomBattleTypeRecord

CcoVictoryConditionRecord

CcoVideoRecord

Global Functions

Functions

Miscchain_globalcomponentcontextconvertdatabasedebugdeprecatedfileflowflow mathprefsrandomregistrysoundstringtweakers

Callbacks

UI Update Messages

Message	Additional Context
AdviceHistoryCleared
AgentActionPerformed
AncillaryAddedToPool
AncillaryFused
ArmyAbilityPurchased
ArmyAbilityUpgraded
AudioUiCategoriesReloaded
BattleCardsLayoutCalled
BattleConflictStarted
BattleCurrencyUpdate
BattleLocalPlayerChanged
BattleResultsCalculated
BattleSelectionChanged
BattleTimeSpeedChanged
Campaign::Events::DilemmaChoiceTaken
CampaignAreaOfInterestMouseOff	true
CampaignAreaOfInterestMouseOn	true
CampaignBattleFinished
CampaignBattleFullyCompleted
CampaignBattleStarted
CampaignBuildingStateChanged
CampaignCharacterAncillaryAssigned
CampaignCharacterArmorChange
CampaignCharacterSelectedAny
CampaignCinematicModeDisabled
CampaignCinematicModeEnabled
CampaignFactionStrengthRanksUpdated
CampaignFactionTurnEndChange
CampaignForceGrowthChanged
CampaignHUDVisibilityChanged
CampaignHumanFactionChangedToAI
CampaignLocalFactionChanged
CampaignMilitaryForceDetailsChanged
CampaignNegotiationChange
CampaignProvinceGrowthChanged
CampaignRitualLockStatusChanged
CampaignRitualLockStatusChangedSpecific	true
CampaignScriptLockChangedAny
CampaignScriptLockChanged_
CampaignSelectionChanged
CampaignSettlementSelectedAny
CampaignShroudUpdated
CampaignSlavesChanged
CampaignTechnologyResearchCancelled	true
CampaignTechnologyResearchComplete
CampaignTechnologyResearchComplete	true
CampaignTechnologyResearchStarted	true
CampaignTechnologyStateChangeAny
CampaignTreasuryChanged
CampaignTurnEnd
CampaignTurnStart
CampaignUnitRecruited
CampaignUnitRecruited	true
CapturePointMouseOverChanged
CapturePointStickyTooltipChanged
CaravanPathChanged
CaravanSpawned
CharacterApReplenished
CharacterContainerChanged
CharacterContainerChanged	true
CharacterConvalescenceChange	true
CharacterCreated	true
CharacterCreatedAny
CharacterDestroyed	true
CharacterDestroyedAny
CharacterDetailsUnitInfoUpdated
CharacterEnterLimbo
CharacterExitLimbo
CharacterInitiativeActivationChanged
CharacterMoveEnd	true
CharacterMoveEndAny
CharacterMoveStart	true
CharacterMoveStartAny
CharacterNameChanged	true
CharacterPostChanged
CharacterPromoted	true
CharacterRankUp	true
CharacterSkillsUpdate
CharacterSkillsUpdate	true
CharacterTrainingStateChanged
CharacterTraitGained
CharacterTraitLost
CloseUnitUpgradePanel
ClosedAllPanels
ColourProfileChanged
CompassActionTriggered
CompassDirectionChanged
ContextLayoutTooltipSettingsChanged
ContextViewerCurrentSelectedContextChanged
ContextViewerInspectedContextChanged
ContextViewerRightClickPressed
ControlsChanged
CookingDishApplied
CustomBattleAutogenAvailabilityChange
CustomBattleOnArmyPresetChanged
CustomBattleOnArmyPresetPinned
CustomBattleOnAutoReadyCountdownUpdate
CustomBattleOnDisconnect
CustomBattleOnFundsChanged
CustomBattleOnHostMigrated
CustomBattleOnLobbyCreated
CustomBattleOnMapFavouritesChanged
CustomBattleOnMapPinned
CustomBattleOnNetworkPlayerImageReady" + String::format("%d
CustomBattleOnPlayerArmyChanged
CustomBattleOnPlayerArmyChangedAny
CustomBattleOnPlayerFactionChanged
CustomBattleOnPlayerFactionChangedAny
CustomBattleOnPlayerFactionChangedLocalPlayer
CustomBattleOnPlayerFactionChangedPlayer
CustomBattleOnPlayerJoined
CustomBattleOnPlayerJoinedAny
CustomBattleOnPlayerLeft
CustomBattleOnPlayerLeftAny
CustomBattleOnPlayerNameChanged
CustomBattleOnPlayerReadyChanged
CustomBattleOnPlayerReadyChangedAny
CustomBattleOnPlayerSlotAdded
CustomBattleOnPlayerSlotAddedAny
CustomBattleOnPlayerSlotRemoved
CustomBattleOnPlayerSlotRemovedAny
CustomBattleOnPlayerTeamChanged
CustomBattleOnPlayersSwapped
CustomBattleOnReadyCountdownUpdate
CustomBattleOnSettingChangedAiStats
CustomBattleOnSettingChangedAny
CustomBattleOnSettingChangedAttackDirection
CustomBattleOnSettingChangedAttackingTeam
CustomBattleOnSettingChangedBattleType
CustomBattleOnSettingChangedCorruptionChanged
CustomBattleOnSettingChangedDifficulty
CustomBattleOnSettingChangedFunds
CustomBattleOnSettingChangedIsLoadingCharactersEnabled
CustomBattleOnSettingChangedIsStormOfMagicEnabled
CustomBattleOnSettingChangedIsUsingUnitCaps
CustomBattleOnSettingChangedLargeArmies
CustomBattleOnSettingChangedLimitlessWom
CustomBattleOnSettingChangedMap
CustomBattleOnSettingChangedMultipleLordsEnabled
CustomBattleOnSettingChangedRealismMode
CustomBattleOnSettingChangedSeason
CustomBattleOnSettingChangedSplitFunds
CustomBattleOnSettingChangedTicketLimit
CustomBattleOnSettingChangedTileUpgrade
CustomBattleOnSettingChangedTimeLimit
CustomBattleOnSettingChangedTimeOfDay
CustomBattleOnSettingChangedUnitScale
CustomBattleOnSettingChangedWeather
CustomBattleOnSpectatorJoined
CustomBattleOnTeamChanged
CustomBattleOnTeamChangedAny
CustomBattleOnTeamLeaderChanged
CustomBattleOnUnitsChanged
CustomBattleOnUnitsChangedAny
CustomBattleOnUserCreatedMapSync
CustomBattleRecruitmentModeChanged
DevoteesEffectsChanged
DiplomacyFactionSelectionChange
DiplomacyManipulationExecuted
DiplomacyManipulationTargetSelectionModeChanged
DiplomacyRequest
EffectsListUpdated
EnvironmentSettingChanged
EnvironmentSettingChangedincremental_autosave_enabled
EnvironmentSettingChangedsave_to_cloud
EventFeed::ClearWhiteList
EventFeed::InstantOpenFilterChanged
EventFeed::TryOpenNext
EventFeedAutoOpen
EventFeedFilterChanged
EventFeedRepopulate
FactionCapitalChanged	true
FactionContentSeen
FactionCookedDish
FactionCookedDishSpecific
FactionDeath	true
FactionDiplomacyChange	true
FactionDiplomacyChangeAny
FactionDiscoveredAny
FactionFeaturesChanged
FactionInitiativeActivationChanged
FactionMercenaryPoolUpdated
FavourPointsChanged
ForeignManagerCreated
ForeignSlotAdded
ForeignSlotRemoved
ForeignSlotRemovedUnique	true
FrontEndNameRandomised
FrontendGeneralNameChanged
InfoPanelClosed
InfoPanelOpened
IngameMessagingNextPage
IngameMessagingPreviousPage
IngredientUnlocked
InitiativeActivationChanged
ItemMarkedAsSeen
LabSettingsLoaded
LayoutFinished_
LevyMercenaryPoolUpdated
LoadingScreenUIDestroyed
MPLobbyOnBattleDifficultyChanged
MPLobbyOnBattleParamsChanged
MPLobbyOnBattleStatsModifierChanged
MPLobbyOnCampaignDifficultyChanged
MPLobbyOnCampaignParamsChanged
MPLobbyOnDisconnect
MPLobbyOnHostMigrated
MPLobbyOnLocalPlayerJoined
MPLobbyOnNetworkPlayerImageReady" + String::format("%d
MPLobbyOnPlayerArmyChanged
MPLobbyOnPlayerArmyChangedAny
MPLobbyOnPlayerCustomGeneralNameChanged
MPLobbyOnPlayerFactionChanged
MPLobbyOnPlayerFactionChangedAny
MPLobbyOnPlayerFactionFailed
MPLobbyOnPlayerFactionFailedAny
MPLobbyOnPlayerJoined
MPLobbyOnPlayerJoinedAny
MPLobbyOnPlayerLeft
MPLobbyOnPlayerLeftAny
MPLobbyOnPlayerNameChanged
MPLobbyOnPlayerNameChangedAny
MPLobbyOnPlayerReadyChanged
MPLobbyOnPlayerReadyChangedAny
MPLobbyOnPlayerSlotAdded
MPLobbyOnPlayerSlotAddedAny
MPLobbyOnPlayerSlotRemoved
MPLobbyOnPlayerSlotRemovedAny
MPLobbyOnPlayerTeamChanged
MPLobbyOnPlayerTeamChangedAny
MPLobbyOnPlayersSwapped
MPLobbyOnReadyCountdownUpdate
MPLobbyOnSpectatorJoined
MPLobbyOnTeamChanged
MPLobbyOnTeamLeaderChanged
MPLobbyOnUserCreatedMapSync
MapControllerZoomUpdated
MilitaryForceFactionChange	true
MilitaryForceFactionChangeAny
MilitaryForceMercenaryPoolUpdated
MilitaryForceStanceChanged
MissionEnded
MissionIssued
MissionMarkedAsSeenUpdated
MissionPinned
MissionTextChanged
MoviePlaybackFinished_
NotificationQueue::CurrentIndexChanged
NotificationQueue::Refresh::All
OnToggleableLclickDown	true
OnToggleableLclickNotOn
PanelClosed
PanelOpened
PendingMissionsChanged
PlagueSelectionChanged
PlayerDisconnected
PooledResourceEffectChanged
PooledResourceThresholdSetEvaluated
PooledResourceTransaction
PooledResourceTransactionSpecific	true
PreBattleVotingUpdate
PrisonCellRefreshed
PrisonStateChanged
ProvinceGovernorshipStateChanged
ProvinceMercenaryPoolUpdated
ReadStatusUpdated
RecipeUnlocked
RefreshUnitSelection
Reopen_
ResourceOverrideChanged
RitualComplete
RitualStarted
ScriptObjectValueUpdated
SelectionParentSelectionChanged
SelectionPropagatorMouseoverSelectionChanged
SettingsApplied
SettlementExposedAny
SettlementFactionChange	true
SettlementFactionChangeAny
SettlementNameChanged	true
SharedStateChanged
ShowCampaignBattleResults
SlavesTransferred
SliderValueChanged_
SlotItemDragEnd
SlotItemDragStart
StagedList::ListUpdated
StormOfMagicAscendancyChange
StormOfMagicAscendancyTransitionStart
StormOfMagicSelectLore
StormOfMagicSelectLoreCompleted
SurvivalWaveUnitsUpdated
TargettingInterfaceChanged
TargettingInterfaceTargetSet
TaxLevelChanged
TeleportNetworkPanelOpened
TextInputChanged
TextInputFocusLost_
ToggleNotifications
ToggleableBuildingDestroyed
ToggleableSlotActiveChanged	true
ToggleableSlotUpdate	true
TransformableAgentEquipped
TransformableAgentUnlocked
TreeCreated
TrespassWarningIssued
TriggerSelectNextSpawnZone
TriggerSelectPreviousSpawnZone
UIColourChanged
UiMainThemeReverted
UiRootSizeChanged
UiScaleChanged
UiSkinChanged
UiTextScaleSettingChanged
UnitAbilityActivationCancelled
UnitAbilityEffectAdded
UnitAbilityEffectRemoved
UnitAbilityIntensityChanged
UnitAbilityPurchased
UnitAddedToUI	true
UnitAddedToUIAny
UnitAllegianceChanged	true
UnitAllegianceChangedAny
UnitBannerChanged
UnitBehaviourChanged	true
UnitDisbanded
UnitEffectPurchased
UnitExperienceGain
UnitOrderDispatched	true
UnitPortholeCameraSettingsReloaded
UnitRemovedFromUI	true
UnitRemovedFromUIAny
UnitTransformed	true
UnitUpgradeGroupUiInfoReloaded
UnitUpgraded
UnitsCustomBattlePermissionsReloaded
UnitsCustomBattleTypesReloaded
UpdateAugmentsList
UpdateHexStates
UpgradeTrainUnitsRequested
UpgradeUnitsRequested
VampireMercenaryPoolUpdated
WaaaghDropDownUpdated
WarContractAccepted
WarContractCancelled
WarContractFailed
WarContractSuccess
WarCoordinationStateChanged
WarCoordinationTargetSet
WindsOfMagicGamblerVisibilityChanged
WindsOfMagicStrengthChanged
battle_purchasable
building_available_event
commandment_available
horde_upgrade_available
hostile_slot_available_event
negative_pooled_resource_event
negative_pooled_resource_event_
selection_changed_
siege_construction_available_event