Three Kingdoms Events & Interfaces
Events
- ActiveCharacterCreated
- AdviceClearedTrigger
- AdviceDismissedEvent
- AdviceFinishedTrigger
- AdviceNavigatedEvent
- AreaEntered
- AreaExited
- AttritionEffectsApplied
- BattleCompleted
- BattleCompletedCameraMove
- BuildingCardSelected
- BuildingCompleted
- BuildingConstructionIssuedByPlayer
- BuildingInfoPanelOpenedCampaign
- CampaignArmiesMerge
- CampaignBattleLoggedEvent
- CampaignBuildingDamaged
- CampaignCoastalAssaultOnCharacter
- CampaignCoastalAssaultOnGarrison
- CampaignModelScriptCallback
- CampaignSessionEnded
- CampaignTimeTriggerEvent
- CharacterAdopted
- CharacterAssignedToPost
- CharacterAttacksAlly
- CharacterBecomesFactionLeader
- CharacterBecomesPregnant
- CharacterBesiegesSettlement
- CharacterBlockadedPort
- CharacterBorn
- CharacterBrokePortBlockade
- CharacterBuildingCompleted
- CharacterCaptiveOptionApplied
- CharacterCeoAdded
- CharacterCeoChanged
- CharacterCeoEquipped
- CharacterCeoNodeChanged
- CharacterCeoRemoved
- CharacterCeoUnequipped
- CharacterCharacterTargetAction
- CharacterComesOfAge
- CharacterCompletedBattle
- CharacterDefectedEvent
- CharacterDeselected
- CharacterDied
- CharacterDiscovered
- CharacterDisembarksNavy
- CharacterEmbarksNavy
- CharacterEntersAttritionalArea
- CharacterEntersGarrison
- CharacterEvent
- CharacterFactionCompletesResearch
- CharacterFamilyRelationDied
- CharacterFinishedMovingEvent
- CharacterGarrisonTargetAction
- CharacterGarrisonTargetEvent
- CharacterLeavesFaction
- CharacterLeavesGarrison
- CharacterLifeGainedEvent
- CharacterMarried
- CharacterMilitaryForceTraditionPointAllocated
- CharacterMilitaryForceTraditionPointAvailable
- CharacterParticipatedAsSecondaryGeneralInBattle
- CharacterParticipatedAsSecondaryGeneralInBattle
- CharacterPerformsActionAgainstFriendlyTarget
- CharacterPerformsSettlementSiegeAction
- CharacterPostBattleEnslave
- CharacterPostBattleRelease
- CharacterPostBattleSlaughter
- CharacterPromoted
- CharacterRank
- CharacterRelationshipChangedEvent
- CharacterRelationshipCreatedEvent
- CharacterSelected
- CharacterSettlementBesieged
- CharacterSettlementBlockaded
- CharacterSkillPointAllocated
- CharacterSkillPointAvailable
- CharacterSkillsPinUpdate
- CharacterTargetEvent
- CharacterTurnEnd
- CharacterTurnStart
- CharacterUnassignedFromPost
- CharacterWaaaghOccurred
- CharacterWillPerformSettlementSiegeAction
- CharacterWoundHealedEvent
- CharacterWoundReceivedEvent
- CharacterWounded
- ClanBecomesVassal
- CliDebugEvent
- ClimatePhaseChange
- ComponentLClickUp
- ComponentLinkClicked
- ComponentLinkMouseOver
- ComponentMouseOn
- ComponentMouseOn
- ComponentMoved
- ContextScriptError
- DilemmaChoiceMadeEvent
- DilemmaEvent
- DilemmaIssuedEvent
- DilemmaOrIncidentStarted
- DiplomacyDealNegotiated
- DiplomacyNegotiationFinished
- DiplomacyNegotiationStarted
- DiplomacyNegotiationStarted
- EncylopediaEntryRequested
- EventMessageOpenedCampaign
- FactionAboutToDie
- FactionAboutToEndTurn
- FactionAwakensFromDeath
- FactionBecomesLiberationVassal
- FactionBecomesWorldLeader
- FactionBecomesWorldLeaderCaptureSettlement
- FactionBeginTurnPhaseNormal
- FactionCapturesWorldCapital
- FactionCeoAdded
- FactionCeoNodeChanged
- FactionCeoRemoved
- FactionCivilWarOccured
- FactionDied
- FactionEffectBundleAwarded
- FactionEffectBundleRemoved
- FactionEncountersOtherFaction
- FactionEvent
- FactionFameLevelUp
- FactionFameLevelUpReady
- FactionGovernmentTypeChanged
- FactionHordeStatusChange
- FactionJoinsConfederation
- FactionLeaderDeclaresWar
- FactionLeaderSignsPeaceTreaty
- FactionLiberated
- FactionNoLongerWorldLeader
- FactionOppositionPerformedPoliticalAction
- FactionRoundStart
- FactionSubjugatesOtherFaction
- FactionTurnEnd
- FactionTurnStart
- FirstTickAfterNewCampaignStarted
- FirstTickAfterWorldCreated
- ForceAdoptsStance
- GarrisonAttackedEvent
- GarrisonOccupiedEvent
- GarrisonResidenceEvent
- GovernorAssignedCharacterEvent
- GovernorshipTaxRateChanged
- HeroCharacterParticipatedInBattle
- HistoricalCharacters
- IncidentEvent
- IncidentOccuredEvent
- IncomingMessage
- LoadingGame
- LoadingScreenDismissed
- MapCharacterDeployed
- MilitaryForceBuildingCompleteEvent
- MilitaryForceCreated
- MilitaryForceDevelopmentPointChange
- MilitaryForceEvent
- MilitaryForceRetinueCreated
- MissionCancelled
- MissionEvent
- MissionFailed
- MissionGenerationFailed
- MissionIssued
- MissionStatusEvent
- MissionSucceeded
- ModelScriptNotificationEvent
- MovementPointsExhausted
- MultiTurnMove
- NewCampaignStarted
- NewCharacterEnteredRecruitmentPool
- NominalDifficultyLevelChangedEvent
- OnKeyPressed
- PanelAdviceRequestedCampaign
- PanelClosedCampaign
- PanelOpenedCampaign
- PendingBankruptcy
- PendingBattle
- PersistentRetinueSlotSnapshotCreated
- PersistentRetinueSlotSnapshotRestored
- PersistentRetinueSlotSnapshotsCleared
- PlayerCampaignFinished
- PooledResourceEffectChangedEvent
- PooledResourceEvent
- RecruitmentItemIssuedByPlayer
- RegionAbandonedWithBuildingEvent
- RegionEvent
- RegionGainedDevlopmentPoint
- RegionOwnershipChanged
- RegionRebels
- RegionSelected
- RegionSlotEvent
- RegionTurnEnd
- RegionTurnStart
- RegionWindsOfMagicChanged
- ResearchCompleted
- ResearchStarted
- SavingGame
- ScriptedAgentCreated
- ScriptedAgentCreationFailed
- ScriptedForceCreated
- SeaTradeRouteRaided
- SettlementAboutToBeCaptured
- SettlementCaptured
- SettlementDeselected
- SettlementEvent
- SettlementRazed
- SettlementSelected
- SharedStateChangedScriptEvent
- SharedStateCreatedScriptEvent
- SharedStateRemovedScriptEvent
- ShortcutPressed
- SlotRoundStart
- SlotSelected
- SlotTurnStart
- TechnologyInfoPanelOpenedCampaign
- TestEvent
- TooltipAdvice
- TradeNodeConnected
- TradeRouteEstablished
- TriggerPostBattleCeos
- UICreated
- UIDestroyed
- UndercoverCharacterActionCompleteEvent
- UndercoverCharacterAddedEvent
- UndercoverCharacterDiscoverResolvedEvent
- UndercoverCharacterSourceFactionActionCompleteEvent
- UndercoverCharacterTargetCharacterActionCompleteEvent
- UndercoverCharacterTargetFactionActionCompleteEvent
- UndercoverCharacterTargetGarrisonActionCompleteEvent
- UndercoverCharacterWillBeRemovedEvent
- UnitCreated
- UnitEvent
- UnitExperienceLevelGained
- UnitRecruitmentInitiated
- UnitSelectedCampaign
- UnitTrained
- ValidateCampaign
- WorldCreated
- WorldEndOfRoundEvent
- WorldLeaderRegionAdded
- WorldPowerTokenAvoidedCaptureEvent
- WorldPowerTokenCapturedEvent
- WorldPowerTokenEvent
- WorldPowerTokenGainedEvent
- WorldPowerTokenRemovedEvent
- WorldStartOfRoundEvent
- campaign_cinematic_trigger_event
- campaign_event
- campaign_ui_callback_enabled_event
- component_campaign_ui_event
- component_id_campaign_ui_event
Interfaces
- DATABASE_SCRIPT_INTERFACE
- FACTION_TABLE_SCRIPT_INTERFACE
- FACTION_RECORD_SCRIPT_INTERFACE
- FACTION_RECORD_LIST_SCRIPT_INTERFACE
- MAIN_UNITS_TABLE_SCRIPT_INTERFACE
- MAIN_UNIT_RECORD_SCRIPT_INTERFACE
- MAIN_UNIT_RECORD_LIST_SCRIPT_INTERFACE
- SUBCULTURES_TABLE_SCRIPT_INTERFACE
- SUBCULTURE_RECORD_SCRIPT_INTERFACE
- SUBCULTURE_RECORD_LIST_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_BATTLE_LOG_ENTRY_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_BATTLE_LOG_CHARACTER_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_BATTLE_LOG_CHARACTER_LIST_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_BATTLE_LOG_UNIT_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_BATTLE_LOG_UNIT_LIST_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_BATTLE_LOG_DUEL_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_BATTLE_LOG_DUEL_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_FOLLOWUP_NEGOTIATION_RECORD_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_FOLLOWUP_NEGOTIATION_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_REQUIRED_TREATY_RECORD_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_REQUIRED_TREATIES_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_COMPONENT_RECORD_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_COMPONENT_RECORD_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_DEAL_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_DEAL_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_PARAMETER_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_DEAL_COMPONENT_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_DEAL_COMPONENT_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_PARAMETER_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_NEGOTIATION_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_NEGOTIATED_DEAL_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_NEGOTIATED_DEAL_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_NEGOTIATED_DEALS_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_PROPOSED_COMPONENT_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_PROPOSED_COMPONENT_LIST_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_ALLIANCE_SCRIPT_INTERFACE
- QUERY_DIPLOMACY_ALLIANCE_LIST_SCRIPT_INTERFACE
- QUERY_EVENT_GENERATOR_SCRIPT_INTERFACE
- CUSTOM_EVENT_BUILDER_SCRIPT_INTERFACE
- CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE
- NULL_SCRIPT_INTERFACE
- MODIFY_EPISODIC_SCRIPTING_SCRIPT_INTERFACE
- MODIFY_WORLD_SCRIPT_INTERFACE
- MODIFY_MODEL_SCRIPT_INTERFACE
- MODIFY_FACTION_SCRIPT_INTERFACE
- MODIFY_CHARACTER_SCRIPT_INTERFACE
- MODIFY_REGION_MANAGER_SCRIPT_INTERFACE
- MODIFY_PROVINCE_SCRIPT_INTERFACE
- MODIFY_FACTION_PROVINCE_SCRIPT_INTERFACE
- MODIFY_REGION_SCRIPT_INTERFACE
- MODIFY_GARRISON_RESIDENCE_SCRIPT_INTERFACE
- MODIFY_SETTLEMENT_SCRIPT_INTERFACE
- MODIFY_SLOT_SCRIPT_INTERFACE
- MODIFY_BUILDING_SCRIPT_INTERFACE
- MODIFY_MILITARY_FORCE_SLOT_SCRIPT_INTERFACE
- MODIFY_MILITARY_FORCE_BUILDING_SCRIPT_INTERFACE
- MODIFY_MILITARY_FORCE_SCRIPT_INTERFACE
- MODIFY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE
- MODIFY_MILITARY_FORCE_HORDE_DETAILS_SCRIPT_INTERFACE
- MODIFY_UNIT_SCRIPT_INTERFACE
- MODIFY_PENDING_BATTLE_SCRIPT_INTERFACE
- MODIFY_CAMPAIGN_AI_SCRIPT_INTERFACE
- MODIFY_FAMILY_MEMBER_SCRIPT_INTERFACE
- MODIFY_CHARACTER_CEO_MANAGEMENT_SCRIPT_INTERFACE
- MODIFY_FACTION_CEO_MANAGEMENT_SCRIPT_INTERFACE
- MODIFY_POOLED_RESOURCE_SCRIPT_INTERFACE
- MODIFY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE
- MODIFY_MAP_PINS_HANDLER_SCRIPT_INTERFACE
- MODIFY_UNDERCOVER_CHARACTER_SCRIPT_INTERFACE
- MODIFY_FACTION_UNDERCOVER_CHARACTER_MANAGER_SCRIPT_INTERFACE
- MODIFY_CAMPAIGN_MISSION_SCRIPT_INTERFACE
- MODIFY_WORLD_POWER_TOKENS_SCRIPT_INTERFACE
- MODIFY_SHARED_STATES_MANAGER
- QUERY_EPISODIC_SCRIPTING_SCRIPT_INTERFACE
- QUERY_WORLD_SCRIPT_INTERFACE
- QUERY_MODEL_SCRIPT_INTERFACE
- QUERY_FACTION_SCRIPT_INTERFACE
- QUERY_FACTION_LIST_SCRIPT_INTERFACE
- QUERY_PERSISTENT_RETINUE_SCRIPT_INTERFACE
- QUERY_PERSISTENT_RETINUE_SLOT_SCRIPT_INTERFACE
- QUERY_PERSISTENT_RETINUE_SLOT_LIST_SCRIPT_INTERFACE
- QUERY_PERSISTENT_RETINUE_SLOT_RECRUITMENT_SCRIPT_INTERFACE
- QUERY_CHARACTER_SCRIPT_INTERFACE
- QUERY_CHARACTER_LIST_SCRIPT_INTERFACE
- QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE
- QUERY_REGION_MANAGER_SCRIPT_INTERFACE
- QUERY_PROVINCE_SCRIPT_INTERFACE
- QUERY_PROVINCE_LIST_SCRIPT_INTERFACE
- QUERY_FACTION_PROVINCE_SCRIPT_INTERFACE
- QUERY_FACTION_PROVINCE_LIST_SCRIPT_INTERFACE
- QUERY_REGION_SCRIPT_INTERFACE
- QUERY_REGION_LIST_SCRIPT_INTERFACE
- QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE
- QUERY_SETTLEMENT_SCRIPT_INTERFACE
- QUERY_SLOT_SCRIPT_INTERFACE
- QUERY_SLOT_LIST_SCRIPT_INTERFACE
- QUERY_BUILDING_SCRIPT_INTERFACE
- QUERY_BUILDING_LIST_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_SLOT_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_SLOT_LIST_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_BUILDING_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_BUILDING_LIST_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_LIST_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_RETINUE_LIST_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_RETINUE_SLOT_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_RETINUE_SLOT_LIST_SCRIPT_INTERFACE
- QUERY_MILITARY_FORCE_HORDE_DETAILS_SCRIPT_INTERFACE
- QUERY_UNIT_SCRIPT_INTERFACE
- QUERY_UNIT_LIST_SCRIPT_INTERFACE
- QUERY_PENDING_BATTLE_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_MISSION_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_AI_SCRIPT_INTERFACE
- QUERY_HISTORICAL_CHARACTER_MANAGER_SCRIPT_INTERFACE
- QUERY_HISTORICAL_CHARACTER_SCRIPT_INTERFACE
- QUERY_HISTORICAL_CHARACTER_LIST_SCRIPT_INTERFACE
- QUERY_CHARACTER_CEO_MANAGEMENT_SCRIPT_INTERFACE
- QUERY_FACTION_CEO_MANAGEMENT_SCRIPT_INTERFACE
- QUERY_CEO_SCRIPT_INTERFACE
- QUERY_CEO_LIST_SCRIPT_INTERFACE
- QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE
- QUERY_CEO_EQUIPMENT_SLOT_LIST_SCRIPT_INTERFACE
- QUERY_POOLED_RESOURCE_FACTOR_SCRIPT_INTERFACE
- QUERY_POOLED_RESOURCE_FACTOR_LIST_SCRIPT_INTERFACE
- QUERY_POOLED_RESOURCE_SCRIPT_INTERFACE
- QUERY_POOLED_RESOURCE_LIST_SCRIPT_INTERFACE
- QUERY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE
- QUERY_FACTION_UNDERCOVER_CHARACTER_MANAGER_SCRIPT_INTERFACE
- QUERY_UNDERCOVER_CHARACTER_SCRIPT_INTERFACE
- QUERY_UNDERCOVER_CHARACTER_LIST_SCRIPT_INTERFACE
- QUERY_CHARACTER_RELATIONSHIP_SCRIPT_INTERFACE
- QUERY_CHARACTER_RELATIONSHIP_LIST_SCRIPT_INTERFACE
- QUERY_CHARACTER_POST_SCRIPT_INTERFACE
- QUERY_CHARACTER_POST_LIST_SCRIPT_INTERFACE
- QUERY_CHARACTER_ASSIGNMENT_SCRIPT_INTERFACE
- QUERY_WORLD_POWER_TOKENS_SCRIPT_INTERFACE
- QUERY_CAMPAIGN_GAME_OPTIONS_INTERFACE
- QUERY_SHARED_STATES_MANAGER
Event Functions
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- area_trigger_name
- query_character
- modify_character
- modify_model
- query_model
- Function: area_trigger_name
- Description: The area trigger name. Returns a string.
- Parameters: ()
- Return: (String)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- area_trigger_name
- query_character
- modify_character
- modify_model
- query_model
- Function: area_trigger_name
- Description: The area trigger name. Returns a string.
- Parameters: ()
- Return: (String)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- military_force
- modify_model
- query_model
- Function: military_force
- Description: Access the military force in the event
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- building_key
- can_request_model_callback
- create_model_callback_request
- Function: building_key
- Description: Returns the building key string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- building
- garrison_residence
- modify_model
- query_model
- Function: building
- Description: Access the building in the event
- Parameters: ()
- Return: (RETURN_QUERY_BUILDING_SCRIPT_INTERFACE)
- Function: garrison_residence
- Description: Access the garrison residence in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- building_level_key
- garrison_residence
- modify_model
- query_model
- Function: building_level_key
- Description: Access the building level key, returns a string
- Parameters: ()
- Return: (String)
- Function: garrison_residence
- Description: Access the garrison residence in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- query_target_character
- query_character
- modify_character
- modify_model
- query_model
- Function: query_target_character
- Description: Access to the target query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- log_entry
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: log_entry
- Description: Returns the log entry interface
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_BATTLE_LOG_ENTRY_SCRIPT_INTERFACE)
-
- garrison_residence
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the garrison residence in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_target_character
- query_character
- modify_character
- modify_model
- query_model
- Function: query_target_character
- Description: Access to the target query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- context
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: context
- Description: Returns the callback script interface sent from the request
- Parameters: ()
- Return: (RETURN_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- id
- modify_model
- query_model
- Function: id
- Description: Access the id of the trigger
- Parameters: ()
- Return: (String)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- query_adopted_character
- modify_adopted_character
- query_new_parent_character
- modify_new_parent_character
- query_previous_father_character
- modify_previous_father_character
- query_previous_mother_character
- modify_previous_mother_character
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: query_adopted_character
- Description: Access to the query character interface of the adopted character
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_adopted_character
- Description: Access to the modify character interface of the adopted character
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_new_parent_character
- Description: Access to the query character interface of the new parent
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_new_parent_character
- Description: Access to the modify character interface of the new parent
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_previous_father_character
- Description: Access to the query character interface of the previous father if valid
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_previous_father_character
- Description: Access to the modify character interface of the previous father if valid
- Parameters: ()
- Return: (RETURN_OPTIONAL_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_previous_mother_character
- Description: Access to the query character interface of the previous mother if valid
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_previous_mother_character
- Description: Access to the modify character interface of the previous mother if valid
- Parameters: ()
- Return: (RETURN_OPTIONAL_MODIFY_CHARACTER_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- target_faction
- query_character
- modify_character
- modify_model
- query_model
- Function: target_faction
- Description: Returns the target faction
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_region
- query_character
- modify_character
- modify_model
- query_model
- Function: query_region
- Description: Access the region
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- building
- character
- garrison_residence
- modify_model
- query_model
- Function: building
- Description: Access the building in the event
- Parameters: ()
- Return: (RETURN_QUERY_BUILDING_SCRIPT_INTERFACE)
- Function: character
- Description: Access the character in the event
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: garrison_residence
- Description: Access the garrison residence in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- capturing_force
- captive_option_key
- captive_option_outcome
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: capturing_force
- Description: Capturing Force
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: captive_option_key
- Description: Captive Option Key
- Parameters: ()
- Return: (String)
- Function: captive_option_outcome
- Description: Captive Option Outcome
- Parameters: ()
- Return: (String)
-
- query_character
- modify_character
- modify_model
- query_model
- ceo
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo
- Description: Access the new ceo added
- Parameters: ()
- Return: (RETURN_QUERY_CEO_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- ceo_equipment_slot
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo_equipment_slot
- Description: Access the equipment slot
- Parameters: ()
- Return: (RETURN_QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- ceo_equipment_slot
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo_equipment_slot
- Description: Access the equipment slot
- Parameters: ()
- Return: (RETURN_QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- ceo
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo
- Description: Access the changed character ceo
- Parameters: ()
- Return: (RETURN_QUERY_CEO_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- ceo_data_key
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo_data_key
- Description: The key of the ceo data removed.
- Parameters: ()
- Return: (String)
-
- query_character
- modify_character
- modify_model
- query_model
- ceo_equipment_slot
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo_equipment_slot
- Description: Access the equipment slot
- Parameters: ()
- Return: (RETURN_QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE)
-
- mission_result_critial_success
- mission_result_success
- mission_result_opportune_failure
- mission_result_failure
- mission_result_critial_failure
- ability
- agent_action_key
- query_target_character
- query_character
- modify_character
- modify_model
- query_model
- Function: mission_result_critial_success
- Description: Was the mission a critical success? returns a bool
- Parameters: ()
- Return: (bool)
- Function: mission_result_success
- Description: Was the mission a success? returns a bool
- Parameters: ()
- Return: (bool)
- Function: mission_result_opportune_failure
- Description: Was the mission a opportune failure? returns a bool
- Parameters: ()
- Return: (bool)
- Function: mission_result_failure
- Description: Was the mission a failure? returns a bool
- Parameters: ()
- Return: (bool)
- Function: mission_result_critial_failure
- Description: Was the mission a critical failure? returns a bool
- Parameters: ()
- Return: (bool)
- Function: ability
- Description: String key for the ability used (from abilities table)
- Parameters: ()
- Return: (String)
- Function: agent_action_key
- Description: String key for the agent action
- Parameters: ()
- Return: (String)
- Function: query_target_character
- Description: Access to the target query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- from
- to
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: from
- Description: The faction the character is defecting *from*
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: to
- Description: The faction the character is defecting *to*
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- was_recruited_in_faction
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: was_recruited_in_faction
- Description: Whether the character was recruited in their faction.
- Parameters: ()
- Return: (bool)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_target_character
- query_character
- modify_character
- modify_model
- query_model
- Function: query_target_character
- Description: Access to the target query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- relationship_key
- query_character
- modify_character
- modify_model
- query_model
- Function: relationship_key
- Description: Returns the relationship string
- Parameters: ()
- Return: (String)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- was_flee
- query_character
- modify_character
- modify_model
- query_model
- Function: was_flee
- Description: Was the movement a result of fleeing?. Returns a bool.
- Parameters: ()
- Return: (bool)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- mission_result_critial_success
- mission_result_success
- mission_result_opportune_failure
- mission_result_failure
- mission_result_critial_failure
- ability
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- Function: mission_result_critial_success
- Description: Was the mission a critical success? returns a bool
- Parameters: ()
- Return: (bool)
- Function: mission_result_success
- Description: Was the mission a success? returns a bool
- Parameters: ()
- Return: (bool)
- Function: mission_result_opportune_failure
- Description: Was the mission a opportune failure? returns a bool
- Parameters: ()
- Return: (bool)
- Function: mission_result_failure
- Description: Was the mission a failure? returns a bool
- Parameters: ()
- Return: (bool)
- Function: mission_result_critial_failure
- Description: Was the mission a critical failure? returns a bool
- Parameters: ()
- Return: (bool)
- Function: ability
- Description: String key for the ability used (from abilities table)
- Parameters: ()
- Return: (String)
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- old_faction
- new_faction
- query_character
- modify_character
- modify_model
- query_model
- Function: old_faction
- Description: The faction transfered from
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: new_faction
- Description: The faction transfered to
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- query_proposer_character
- modify_proposer_character
- query_recipient_character
- modify_recipient_character
- is_diplomatic_marriage
- recipient_joins_proposer
- query_recipient_character_originating_faction
- query_proposer_character_originating_faction
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: query_proposer_character
- Description: Access to the query character interface of the proposer of marriage
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_proposer_character
- Description: Access to the modify character interface of the proposer of marriage
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_recipient_character
- Description: Access to the query character interface of the recipient of marriage
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_recipient_character
- Description: Access to the modify character interface of the recipient of marriage
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: is_diplomatic_marriage
- Description: If the proposer and recipient are in different factions
- Parameters: ()
- Return: (bool)
- Function: recipient_joins_proposer
- Description: If this is a diplomatic marriage, if the recipient joins the proposers faction, or the other way around
- Parameters: ()
- Return: (bool)
- Function: query_recipient_character_originating_faction
- Description: If this is a diplomatic marriage, gives access to the query faction interface of the recipient of marriage's originating faction
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: query_proposer_character_originating_faction
- Description: If this is a diplomatic marriage, gives access to the query faction interface of the proposer of marriage's originating faction
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_SCRIPT_INTERFACE)
-
- skill_key
- query_military_force
- query_character
- modify_character
- modify_model
- query_model
- Function: skill_key
- Description: Returns the skill key string
- Parameters: ()
- Return: (String)
- Function: query_military_force
- Description: Access the military force the tradition was assigned to
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_military_force
- query_character
- modify_character
- modify_model
- query_model
- Function: query_military_force
- Description: Access the military force
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- action_option_record_key
- option_outcome_enum_key
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: action_option_record_key
- Description: String key for the action option record used (from SETTLEMENT_SIEGE_ACTION_OPTIONS_TABLE)
- Parameters: ()
- Return: (String)
- Function: option_outcome_enum_key
- Description: String for the option outcome used (from SETTLEMENT_SIEGE_ACTION_OUTCOME enum)
- Parameters: ()
- Return: (String)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- relationship
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: relationship
- Description: Returns the relationship interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_RELATIONSHIP_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- relationship
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: relationship
- Description: Returns the relationship interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_RELATIONSHIP_SCRIPT_INTERFACE)
-
- character
- can_request_model_callback
- create_model_callback_request
- Function: character
- Description: Returns the character query interface.
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- garrison_residence
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the garrison residence in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the garrison residence in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- skill_key
- query_character
- modify_character
- modify_model
- query_model
- Function: skill_key
- Description: Returns the skill key string
- Parameters: ()
- Return: (String)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- modify_character
- query_character
- ceo_key
- pinned
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface of the owner of the skill
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface of the owner of the skill
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: ceo_key
- Description: The ceo that's being updated
- Parameters: ()
- Return: (String)
- Function: pinned
- Description: If this ceo is being pinned or unpinned
- Parameters: ()
- Return: (bool)
-
- query_target_character
- query_character
- modify_character
- modify_model
- query_model
- Function: query_target_character
- Description: Access to the target query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- current_assignment_key
- query_character
- modify_character
- modify_model
- query_model
- Function: current_assignment_key
- Description: Returns the current assignment key
- Parameters: ()
- Return: (String)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- action_option_record_key
- option_outcome_enum_key
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: action_option_record_key
- Description: String key for the action option record used (from SETTLEMENT_SIEGE_ACTION_OPTIONS_TABLE)
- Parameters: ()
- Return: (String)
- Function: option_outcome_enum_key
- Description: String for the option outcome used (from SETTLEMENT_SIEGE_ACTION_OUTCOME enum)
- Parameters: ()
- Return: (String)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- parameter
- modify_model
- query_model
- Function: parameter
- Description: A string parameter from the console. Scripters can do anything they like with it e.g. use it as a function name and param list.
- Parameters: ()
- Return: (String)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- choice
- dilemma
- faction
- modify_model
- query_model
- Function: choice
- Description: Access the choice made for the dilemma in the event
- Parameters: ()
- Return: (card32)
- Function: dilemma
- Description: Access the key of the dilemma in the event
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- dilemma
- faction
- modify_model
- query_model
- Function: dilemma
- Description: Access the key of the dilemma in the event
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- dilemma
- faction
- modify_model
- query_model
- Function: dilemma
- Description: Access the key of the dilemma in the event
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- modify_model
- query_model
- deals
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: deals
- Description: Returns the deals interface
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATED_DEALS_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- negotiation
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: negotiation
- Description: Returns the negotiation interface
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATION_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- negotiation
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: negotiation
- Description: Returns the negotiation interface
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATION_SCRIPT_INTERFACE)
-
- faction_name
- can_request_model_callback
- create_model_callback_request
- Function: faction_name
- Description: Returns the faction name string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- killer_or_confederator_faction_key
- confederated
- faction
- modify_model
- query_model
- Function: killer_or_confederator_faction_key
- Description: Access the killer (or confederator) faction record key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: confederated
- Description: Was the faction confederated?
- Parameters: ()
- Return: (bool)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- liberating_character
- faction
- modify_model
- query_model
- Function: liberating_character
- Description: Access the character involved in the liberation
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- ceo
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo
- Description: Access the new ceo added
- Parameters: ()
- Return: (RETURN_QUERY_CEO_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- ceo
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo
- Description: Access the changed faction ceo
- Parameters: ()
- Return: (RETURN_QUERY_CEO_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- ceo_data_key
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: ceo_data_key
- Description: The key of the ceo data removed.
- Parameters: ()
- Return: (String)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- killer_or_confederator_faction_key
- confederated
- faction
- modify_model
- query_model
- Function: killer_or_confederator_faction_key
- Description: Access the killer (or confederator) faction record key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: confederated
- Description: Was the faction confederated?
- Parameters: ()
- Return: (bool)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- effect_bundle_key
- faction
- modify_model
- query_model
- Function: effect_bundle_key
- Description: Access the effect bundle record key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- effect_bundle_key
- faction
- modify_model
- query_model
- Function: effect_bundle_key
- Description: Access the effect bundle record key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- other_faction
- faction
- modify_model
- query_model
- Function: other_faction
- Description: Access the other faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- confederation
- faction
- modify_model
- query_model
- Function: confederation
- Description: Access the confederations owning faction
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- liberating_character
- faction
- modify_model
- query_model
- Function: liberating_character
- Description: Access the character involved in the liberation
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- other_faction
- faction
- modify_model
- query_model
- Function: other_faction
- Description: Access the other faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- stance_adopted
- military_force
- modify_model
- query_model
- Function: stance_adopted
- Description: Access the stance adopted string
- Parameters: ()
- Return: (String)
- Function: military_force
- Description: Access the military force
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- query_character
- modify_character
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the target garrison in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- garrison_residence
- modify_model
- query_model
- Function: garrison_residence
- Description: Access the garrison residence in the event
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_region
- query_character
- modify_character
- modify_model
- query_model
- Function: query_region
- Description: Access the region in which the governor was assigned
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- historical_character_manager
- agent_type_key
- faction_key
- generate_historical_character
- faction
- modify_model
- query_model
- Function: historical_character_manager
- Description: Access the historical character manager.
- Parameters: ()
- Return: (RETURN_QUERY_HISTORICAL_CHARACTER_MANAGER_SCRIPT_INTERFACE)
- Function: agent_type_key
- Description: Access the agent type key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: faction_key
- Description: Access the faction record key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: generate_historical_character
- Description: Sets the selected historical character for the event to generate. Takes a string parameter. generate_historical_character( historical_character_record_key )
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- incident
- faction
- modify_model
- query_model
- Function: incident
- Description: Access the key of the incident in the event. Returns a string
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- incident
- faction
- modify_model
- query_model
- Function: incident
- Description: Access the key of the incident in the event. Returns a string
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- load_int
- load_bool
- load_string
- modify_model
- query_model
- Function: load_int
- Description: Loads a named int value for script. Provide the string name of the value. Returns an int. load_int( " value_name ")
- Parameters: (String value_name)
- Return: (int32)
- Function: load_bool
- Description: Loads a named bool value for script. Provide the string name of the value. Returns an bool. load_bool( " value_name ")
- Parameters: (String value_name)
- Return: (bool)
- Function: load_string
- Description: Loads a named string value for script. Provide the string name of the value. Returns an string. load_string( " value_name ")
- Parameters: (String value_name)
- Return: (String)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- building
- query_character
- modify_character
- modify_model
- query_model
- Function: building
- Description: Key of the building constructed. Returns a string.
- Parameters: ()
- Return: (String)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- military_force_created
- modify_model
- query_model
- Function: military_force_created
- Description: Access the military force created
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- military_force
- point_change
- query_character
- modify_character
- modify_model
- query_model
- Function: military_force
- Description: Access the military force that gained/lost the developement point
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: point_change
- Description: Access the points gained/lost
- Parameters: ()
- Return: (int32)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- military_force
- modify_model
- query_model
- Function: military_force
- Description: Access the military force in the event
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- military_force_retinue_created
- modify_model
- query_model
- Function: military_force_retinue_created
- Description: Access the military force retinue created
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- mission
- faction
- modify_model
- query_model
- Function: mission
- Description: Access the mission in the event
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_MISSION_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- mission
- faction
- modify_model
- query_model
- Function: mission
- Description: Access the mission in the event
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_MISSION_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- mission
- modify_model
- query_model
- Function: mission
- Description: Access the ID of the mission. Returns a string
- Parameters: ()
- Return: (String)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- mission
- faction
- modify_model
- query_model
- Function: mission
- Description: Access the mission in the event
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_MISSION_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- mission
- faction
- modify_model
- query_model
- Function: mission
- Description: Access the mission in the event
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_MISSION_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- mission
- faction
- modify_model
- query_model
- Function: mission
- Description: Access the mission in the event
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_MISSION_SCRIPT_INTERFACE)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- faction
- event_id
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: faction
- Description: Returns the faction interface
- Parameters: ()
- Return: (RETURN_MODIFY_FACTION_SCRIPT_INTERFACE)
- Function: event_id
- Description: String identifier of this event
- Parameters: ()
- Return: (String)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- character
- modify_model
- query_model
- Function: character
- Description: Access the character details in the event
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- key_name
- is_key_up_event
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
- Function: key_name
- Description: Name of the key pressed
- Parameters: ()
- Return: (String)
- Function: is_key_up_event
- Description: Is key event key_up?
- Parameters: ()
- Return: (bool)
-
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- cqi
- faction
- modify_model
- query_model
- Function: cqi
- Description: Access the cqi of the slot that was snapshotted
- Parameters: ()
- Return: (card32)
- Function: faction
- Description: Access the faction the slot belongs to, may be nil
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- cqi
- faction
- previous_unit_record
- modify_model
- query_model
- Function: cqi
- Description: Access the cqi of the slot that was restored
- Parameters: ()
- Return: (card32)
- Function: faction
- Description: Access the faction the slot belongs to, may be nil
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: previous_unit_record
- Description: Access to the unit record that was in the slot before it was restored
- Parameters: ()
- Return: (String)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- victory_type
- player_won
- faction
- modify_model
- query_model
- Function: victory_type
- Description: Access the victory type record key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: player_won
- Description: Did player win or lose the campaign? Returns a bool.
- Parameters: ()
- Return: (bool)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- resource
- old_effect
- new_effect
- effect_type
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: resource
- Description: Access pooled resource
- Parameters: ()
- Return: (RETURN_QUERY_POOLED_RESOURCE_SCRIPT_INTERFACE)
- Function: old_effect
- Description: Key of the previous effect. Empty if none
- Parameters: ()
- Return: (String)
- Function: new_effect
- Description: Key of the new effect. Empty if none
- Parameters: ()
- Return: (String)
- Function: effect_type
- Description: Effect type enum value
- Parameters: ()
- Return: (card32)
-
- modify_model
- query_model
- resource
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: resource
- Description: Access pooled resource
- Parameters: ()
- Return: (RETURN_QUERY_POOLED_RESOURCE_SCRIPT_INTERFACE)
-
- unit_record_key
- faction
- modify_model
- query_model
- Function: unit_record_key
- Description: The unit record key recuited. Returns a String.
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- abandoning_faction
- building
- region
- modify_model
- query_model
- Function: abandoning_faction
- Description: Access the faction that abandoned the region
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: building
- Description: Access the building left in the region
- Parameters: ()
- Return: (RETURN_QUERY_BUILDING_SCRIPT_INTERFACE)
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- region
- modify_model
- query_model
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- region
- modify_model
- query_model
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- new_owner
- previous_owner
- reason
- region
- modify_model
- query_model
- Function: new_owner
- Description: Access the new faction
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: previous_owner
- Description: Access the previous faction
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: reason
- Description: The reason the region was transfered
- Parameters: ()
- Return: (String)
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- region
- modify_model
- query_model
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- region
- can_request_model_callback
- create_model_callback_request
- Function: region
- Description: Returns the region query interface.
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- region_slot
- modify_model
- query_model
- Function: region_slot
- Description: Access the region slot in the event
- Parameters: ()
- Return: (RETURN_QUERY_SLOT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- region
- modify_model
- query_model
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- region
- modify_model
- query_model
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- strength
- region
- modify_model
- query_model
- Function: strength
- Description: Strength string
- Parameters: ()
- Return: (String)
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- technology_record_key
- faction
- modify_model
- query_model
- Function: technology_record_key
- Description: Access the technology record key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- technology_record_key
- faction
- modify_model
- query_model
- Function: technology_record_key
- Description: Access the technology record key. Returns a string.
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- save_int
- save_bool
- save_string
- Function: save_int
- Description: Saves named int value for script. Provide the string name of the value, and the int value to save. save_int( " value_name ", int_value)
- Parameters: (String value_name, int32 save_value)
- Return: ()
- Function: save_bool
- Description: Saves named bool value for script. Provide the string name of the value, and the bool value to save. save_bool( " value_name ", bool_value)
- Parameters: (String value_name, bool save_value)
- Return: ()
- Function: save_string
- Description: Saves named string value for script. Provide the string name of the value, and the string value to save. save_string( " value_name ", "string_value")
- Parameters: (String value_name, String save_value)
- Return: ()
-
- id
- modify_model
- query_model
- Function: id
- Description: Access to the id.Returns a string.
- Parameters: ()
- Return: (String)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- id
- modify_model
- query_model
- Function: id
- Description: Access to the id. Returns a string.
- Parameters: ()
- Return: (String)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- id
- modify_model
- query_model
- Function: id
- Description: Access to the id. Returns a string.
- Parameters: ()
- Return: (String)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- settlement
- modify_model
- query_model
- Function: settlement
- Description: Access the settlement in the event
- Parameters: ()
- Return: (RETURN_QUERY_SETTLEMENT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- settlement
- modify_model
- query_model
- Function: settlement
- Description: Access the settlement in the event
- Parameters: ()
- Return: (RETURN_QUERY_SETTLEMENT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- settlement
- modify_model
- query_model
- Function: settlement
- Description: Access the settlement in the event
- Parameters: ()
- Return: (RETURN_QUERY_SETTLEMENT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- settlement
- modify_model
- query_model
- Function: settlement
- Description: Access the settlement in the event
- Parameters: ()
- Return: (RETURN_QUERY_SETTLEMENT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- settlement
- can_request_model_callback
- create_model_callback_request
- Function: settlement
- Description: Returns the settlement query interface.
- Parameters: ()
- Return: (RETURN_QUERY_SETTLEMENT_SCRIPT_INTERFACE)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- modify_model
- query_model
- get_key
- get_state_as_bool
- get_state_as_float
- get_state_as_string
- is_bool
- is_float
- is_string
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: get_key
- Description:
- Parameters: ()
- Return: (String)
- Function: get_state_as_bool
- Description:
- Parameters: ()
- Return: (bool)
- Function: get_state_as_float
- Description:
- Parameters: ()
- Return: (float32)
- Function: get_state_as_string
- Description:
- Parameters: ()
- Return: (String)
- Function: is_bool
- Description:
- Parameters: ()
- Return: (bool)
- Function: is_float
- Description:
- Parameters: ()
- Return: (bool)
- Function: is_string
- Description:
- Parameters: ()
- Return: (bool)
-
- modify_model
- query_model
- get_key
- get_state_as_bool
- get_state_as_float
- get_state_as_string
- is_bool
- is_float
- is_string
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: get_key
- Description:
- Parameters: ()
- Return: (String)
- Function: get_state_as_bool
- Description:
- Parameters: ()
- Return: (bool)
- Function: get_state_as_float
- Description:
- Parameters: ()
- Return: (float32)
- Function: get_state_as_string
- Description:
- Parameters: ()
- Return: (String)
- Function: is_bool
- Description:
- Parameters: ()
- Return: (bool)
- Function: is_float
- Description:
- Parameters: ()
- Return: (bool)
- Function: is_string
- Description:
- Parameters: ()
- Return: (bool)
-
- modify_model
- query_model
- get_key
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: get_key
- Description:
- Parameters: ()
- Return: (String)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- region_slot
- modify_model
- query_model
- Function: region_slot
- Description: Access the region slot in the event
- Parameters: ()
- Return: (RETURN_QUERY_SLOT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- slot
- can_request_model_callback
- create_model_callback_request
- Function: slot
- Description: Returns the slot query interface.
- Parameters: ()
- Return: (RETURN_QUERY_SLOT_SCRIPT_INTERFACE)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- region_slot
- modify_model
- query_model
- Function: region_slot
- Description: Access the region slot in the event
- Parameters: ()
- Return: (RETURN_QUERY_SLOT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- faction
- modify_model
- query_model
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- has_stolen_ceo
- query_character
- modify_character
- modify_model
- query_model
- Function: has_stolen_ceo
- Description: Access a bool stating if the characters faction has already stolen an ceo. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- source_faction
- ability
- agent_action_key
- action_was_success
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: source_faction
- Description: Faction performing the action
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: ability
- Description: String key for the ability used (from abilities table)
- Parameters: ()
- Return: (String)
- Function: agent_action_key
- Description: String key for the agent action
- Parameters: ()
- Return: (String)
- Function: action_was_success
- Description: Action was success
- Parameters: ()
- Return: (bool)
-
- query_character
- modify_character
- modify_model
- query_model
- source_faction
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: source_faction
- Description: Source faction of the undercover character
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- source_faction
- discovering_faction
- discover_action_key
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: source_faction
- Description: Source faction of the undercover character
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: discovering_faction
- Description: Faction that discovered the undercover character
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: discover_action_key
- Description: String key for the discover action used
- Parameters: ()
- Return: (String)
-
- query_character
- modify_character
- modify_model
- query_model
- source_faction
- action_key
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: source_faction
- Description: Source faction of the undercover character
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: action_key
- Description: String key for the source faction action used
- Parameters: ()
- Return: (String)
-
- query_character
- modify_character
- modify_model
- query_model
- source_faction
- ability
- agent_action_key
- action_was_success
- target_character
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: source_faction
- Description: Faction performing the action
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: ability
- Description: String key for the ability used (from abilities table)
- Parameters: ()
- Return: (String)
- Function: agent_action_key
- Description: String key for the agent action
- Parameters: ()
- Return: (String)
- Function: action_was_success
- Description: Action was success
- Parameters: ()
- Return: (bool)
- Function: target_character
- Description: Target of the action
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- source_faction
- ability
- agent_action_key
- action_was_success
- target_faction
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: source_faction
- Description: Faction performing the action
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: ability
- Description: String key for the ability used (from abilities table)
- Parameters: ()
- Return: (String)
- Function: agent_action_key
- Description: String key for the agent action
- Parameters: ()
- Return: (String)
- Function: action_was_success
- Description: Action was success
- Parameters: ()
- Return: (bool)
- Function: target_faction
- Description: Target of the action
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- source_faction
- ability
- agent_action_key
- action_was_success
- target_garrison
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: source_faction
- Description: Faction performing the action
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: ability
- Description: String key for the ability used (from abilities table)
- Parameters: ()
- Return: (String)
- Function: agent_action_key
- Description: String key for the agent action
- Parameters: ()
- Return: (String)
- Function: action_was_success
- Description: Action was success
- Parameters: ()
- Return: (bool)
- Function: target_garrison
- Description: Target of the action
- Parameters: ()
- Return: (RETURN_QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE)
-
- query_character
- modify_character
- modify_model
- query_model
- source_faction
- Function: query_character
- Description: Access to the query character interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_character
- Description: Access to the modify character interface
- Parameters: ()
- Return: (RETURN_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: source_faction
- Description: Source faction of the undercover character
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
-
- unit
- modify_model
- query_model
- Function: unit
- Description: Access the unit in the event
- Parameters: ()
- Return: (RETURN_QUERY_UNIT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- unit
- modify_model
- query_model
- Function: unit
- Description: Access the unit in the event
- Parameters: ()
- Return: (RETURN_QUERY_UNIT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- unit
- modify_model
- query_model
- previous_experience_level
- Function: unit
- Description: Access the unit in the event
- Parameters: ()
- Return: (RETURN_QUERY_UNIT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: previous_experience_level
- Description: Experience level the unit was before it ranked up
- Parameters: ()
- Return: (card32)
-
- cqi
- unit_key
- faction
- modify_model
- query_model
- Function: cqi
- Description: Access the cqi of the slot that was snapshotted
- Parameters: ()
- Return: (card32)
- Function: unit_key
- Description: Access the key of the unit that was recruited
- Parameters: ()
- Return: (String)
- Function: faction
- Description: Access the faction in the event
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- unit
- can_request_model_callback
- create_model_callback_request
- Function: unit
- Description: Returns the unit query interface.
- Parameters: ()
- Return: (RETURN_QUERY_UNIT_SCRIPT_INTERFACE)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- unit
- modify_model
- query_model
- Function: unit
- Description: Access the unit in the event
- Parameters: ()
- Return: (RETURN_QUERY_UNIT_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- should_error_on_failed_campaign_validation
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: should_error_on_failed_campaign_validation
- Description: Should script report an error if validation fails?
- Parameters: ()
- Return: (bool)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- region
- modify_model
- query_model
- Function: region
- Description: Access the region in the event
- Parameters: ()
- Return: (RETURN_QUERY_REGION_SCRIPT_INTERFACE)
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- token
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: token
- Description: Returns the world power token key
- Parameters: ()
- Return: (String)
-
- modify_model
- query_model
- token
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: token
- Description: Returns the world power token key
- Parameters: ()
- Return: (String)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- modify_model
- query_model
- token
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: token
- Description: Returns the world power token key
- Parameters: ()
- Return: (String)
-
- modify_model
- query_model
- token
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: token
- Description: Returns the world power token key
- Parameters: ()
- Return: (String)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: This is the campaign specific cinematic trigger function with model callback access.
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- modify_model
- query_model
- Function: modify_model
- Description: Access to the modify model interface
- Parameters: ()
- Return: (RETURN_MODIFY_MODEL_SCRIPT_INTERFACE)
- Function: query_model
- Description: Access to the query model interface
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
-
- can_request_model_callback
- create_model_callback_request
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- has_component
- component_parent_id
- is_child_of_component_id
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: has_component
- Description: Does the event have a component. Returns a bool
- Parameters: ()
- Return: (bool)
- Function: component_parent_id
- Description: Returns the component parent id string.
- Parameters: ()
- Return: (String)
- Function: is_child_of_component_id
- Description: Is the component is a child of the intput string componenet id. component_campaign_ui_event("parent_id"). returns a bool
- Parameters: (String check_parent_id)
- Return: (bool)
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
-
- component_id
- can_request_model_callback
- create_model_callback_request
- Function: component_id
- Description: Returns the component id string.
- Parameters: ()
- Return: (String)
- Function: can_request_model_callback
- Description: Some events are shared between battle and campaign. At this time battle does not support callbacks
- Parameters: ()
- Return: (bool)
- Function: create_model_callback_request
- Description: Creates a new model callback request with the specified ID
- Parameters: (String id)
- Return: (RETURN_OPTIONAL_CAMPAIGN_MODEL_SCRIPT_CALLBACK_INTERFACE)
Interface Functions
- Description: Interface for accessing database tables
- is_null_interface
- factions_table
- main_units_table
- subcultures_table
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: factions_table
- Description: Factions Table
- Parameters: ()
- Return: (RETURN_FACTION_TABLE_SCRIPT_INTERFACE)
- Function: main_units_table
- Description: Main Units Table
- Parameters: ()
- Return: (RETURN_MAIN_UNITS_TABLE_SCRIPT_INTERFACE)
- Function: subcultures_table
- Description: Subcultures Table
- Parameters: ()
- Return: (RETURN_SUBCULTURES_TABLE_SCRIPT_INTERFACE)
- Description: Database table interface for the factions table
- lookup_record
- number_of_records
- record_at_index
- Function: lookup_record
- Description: Lookup a record by key
- Parameters: lookup_record(String key)
- Return: FACTION_RECORD_SCRIPT_INTERFACE
- Function: number_of_records
- Description: Number of records in the table
- Parameters: number_of_records()
- Return: int
- Function: record_at_index
- Description: Lookup a record by index
- Parameters: record_at_index(int index)
- Return: int
- Description: An individual faction record from the database
- is_null_interface
- key
- subculture
- grant_rebel_captures_to_faction
- permitted_army_general_units
- is_rebel
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: key
- Description: Record Key
- Parameters: ()
- Return: (String)
- Function: subculture
- Description: Subculture Record
- Parameters: ()
- Return: (RETURN_SUBCULTURE_RECORD_SCRIPT_INTERFACE)
- Function: grant_rebel_captures_to_faction
- Description: Record of the faction this faction hands regions over to on successful rebellion
- Parameters: ()
- Return: (RETURN_OPTIONAL_FACTION_RECORD_SCRIPT_INTERFACE)
- Function: permitted_army_general_units
- Description: List of all permitted army generals units
- Parameters: ()
- Return: (RETURN_MAIN_UNIT_RECORD_LIST_SCRIPT_INTERFACE)
- Function: is_rebel
- Description: Is this a rebel faction?
- Parameters: ()
- Return: (bool)
- Description: A lis of faction record script interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: FACTION_RECORD_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Main Units Table
- lookup_record
- number_of_records
- record_at_index
- Function: lookup_record
- Description: Lookup a record by key
- Parameters: lookup_record(String key)
- Return: MAIN_UNIT_RECORD_SCRIPT_INTERFACE
- Function: number_of_records
- Description: Number of records in the table
- Parameters: number_of_records()
- Return: int
- Function: record_at_index
- Description: Lookup a record by index
- Parameters: record_at_index(int index)
- Return: int
- Description: An invidual main unit record, from the database
- is_null_interface
- key
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: key
- Description: Record key
- Parameters: ()
- Return: (String)
- Description: A list of main unit records
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: MAIN_UNIT_RECORD_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Subcultures Table
- lookup_record
- number_of_records
- record_at_index
- Function: lookup_record
- Description: Lookup a record by key
- Parameters: lookup_record(String key)
- Return: SUBCULTURE_RECORD_SCRIPT_INTERFACE
- Function: number_of_records
- Description: Number of records in the table
- Parameters: number_of_records()
- Return: int
- Function: record_at_index
- Description: Lookup a record by index
- Parameters: record_at_index(int index)
- Return: int
- Description: An individual subculture record, from the database
- is_null_interface
- key
- culture
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: key
- Description: Record Key
- Parameters: ()
- Return: (String)
- Function: culture
- Description: Culture Record Key
- Parameters: ()
- Return: (String)
- Description: A list of subculture record interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: SUBCULTURE_RECORD_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Logged information for a campaign battle
- is_null_interface
- winning_factions
- losing_factions
- winning_characters
- losing_characters
- winning_captains
- losing_captains
- duels
- winner_result
- loser_result
- position_x
- position_y
- round_fought
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: winning_factions
- Description: All factions involved in the winning battle alliance
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Function: losing_factions
- Description: All factions involved in the losing battle alliance
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Function: winning_characters
- Description: All characters involved in the winning battle alliance
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_BATTLE_LOG_CHARACTER_LIST_SCRIPT_INTERFACE)
- Function: losing_characters
- Description: All characters involved in the losing battle alliance
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_BATTLE_LOG_CHARACTER_LIST_SCRIPT_INTERFACE)
- Function: winning_captains
- Description: All captains involved in the winning battle alliance
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_BATTLE_LOG_UNIT_LIST_SCRIPT_INTERFACE)
- Function: losing_captains
- Description: All captains involved in the losing battle alliance
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_BATTLE_LOG_UNIT_LIST_SCRIPT_INTERFACE)
- Function: duels
- Description: All duels that occurred during this battle
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_BATTLE_LOG_DUEL_LIST_SCRIPT_INTERFACE)
- Function: winner_result
- Description: Result type for the winning alliance
- Parameters: ()
- Return: (String)
- Function: loser_result
- Description: Result type for the losing alliance
- Parameters: ()
- Return: (String)
- Function: position_x
- Description: X coordinate of the battle in logical map space
- Parameters: ()
- Return: (card32)
- Function: position_y
- Description: Y coordinate of the battle in logical map space
- Parameters: ()
- Return: (card32)
- Function: round_fought
- Description: Round this battle was fought
- Parameters: ()
- Return: (card32)
- Description: Logged battle information for an individual character in a campaign battle
- is_null_interface
- character
- personal_kills
- retinue_kills
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: character
- Description: Underlying campaign character
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: personal_kills
- Description: Amount of enemies killed by this character and their bodyguard
- Parameters: ()
- Return: (card32)
- Function: retinue_kills
- Description: Amount of enemies killed by this character and their entire retinue
- Parameters: ()
- Return: (card32)
- Description: A list of characters in a campaign battle log entry
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_CAMPAIGN_BATTLE_LOG_CHARACTER_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Logged battle information for an individual character in a campaign battle
- is_null_interface
- unit
- personal_kills
- retinue_kills
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: unit
- Description: Underlying campaign unit
- Parameters: ()
- Return: (RETURN_QUERY_UNIT_SCRIPT_INTERFACE)
- Function: personal_kills
- Description: Amount of enemies killed by this unit
- Parameters: ()
- Return: (card32)
- Function: retinue_kills
- Description: Amount of enemies killed by this unit and their entire retinue (if the unit is commading the retinue)
- Parameters: ()
- Return: (card32)
- Description: A list of units in a campaign battle log entry
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_CAMPAIGN_BATTLE_LOG_UNIT_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Logged information about a duel that occurred in a campaign battle
- is_null_interface
- proposer
- target
- winner
- loser
- has_winner
- outcome
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: proposer
- Description: Character that proposed the duel
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: target
- Description: Character that did not propose the duel
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: winner
- Description: Character that won the duel (there may not be a winner)
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: loser
- Description: Character that lost the duel (there may not be a loser)
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: has_winner
- Description: Does this duel have a winner?
- Parameters: ()
- Return: (bool)
- Function: outcome
- Description: The outcome of the duel
- Parameters: ()
- Return: (String)
- Description: A list of duels that occurred during a logged campaign battle
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_CAMPAIGN_BATTLE_LOG_DUEL_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Followup negotiation record
- is_null_interface
- component_records
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: component_records
- Description: Follow up negotiation component records
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_COMPONENT_RECORD_LIST_SCRIPT_INTERFACE)
- Description: List of follow up negotiation records
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_FOLLOWUP_NEGOTIATION_RECORD_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Required treaty record
- is_null_interface
- component_record
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: component_record
- Description: Required treaty component record
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_COMPONENT_RECORD_SCRIPT_INTERFACE)
- Description: List of required treaty records
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_REQUIRED_TREATY_RECORD_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Basic diplomacy component record
- is_null_interface
- key
- required_treaties
- followup_negotiations
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: key
- Description: Component record key
- Parameters: ()
- Return: (String)
- Function: required_treaties
- Description: Required treaties
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_REQUIRED_TREATIES_LIST_SCRIPT_INTERFACE)
- Function: followup_negotiations
- Description: Follow up negotiations
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_FOLLOWUP_NEGOTIATION_LIST_SCRIPT_INTERFACE)
- Description: List of basic component records
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_COMPONENT_RECORD_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Interface for a single diplomacy deal
- is_null_interface
- cqi
- components
- proposers
- recipients
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: cqi
- Description: CQI
- Parameters: ()
- Return: (card32)
- Function: components
- Description: Components
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_DEAL_COMPONENT_LIST_SCRIPT_INTERFACE)
- Function: proposers
- Description: Proposers
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_LIST_SCRIPT_INTERFACE)
- Function: recipients
- Description: Recipients
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_LIST_SCRIPT_INTERFACE)
- Description: A list of diplomacy deals
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_DEAL_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Interface for a diplomacy component parameter
- is_null_interface
- get_alliances
- get_factions
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: get_alliances
- Description:
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_ALLIANCE_LIST_SCRIPT_INTERFACE)
- Function: get_factions
- Description:
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Description: Interface for a single diplomacy deal component
- is_null_interface
- treaty_component_key
- proposer
- recipient
- round_signed
- component_record
- parameters
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: treaty_component_key
- Description: Treaty Component Record Key
- Parameters: ()
- Return: (String)
- Function: proposer
- Description: Proposer
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: recipient
- Description: Recipient
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: round_signed
- Description: Round Signed
- Parameters: ()
- Return: (card32)
- Function: component_record
- Description: Underlying component record
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_COMPONENT_RECORD_SCRIPT_INTERFACE)
- Function: parameters
- Description: Component's parameters
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_PARAMETER_LIST_SCRIPT_INTERFACE)
- Description: A list of diplomacy deal components
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_DEAL_COMPONENT_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: A list of diplomacy deal component parameters
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: DIPLOMACY::VARIABLE_VALUE_MODEL
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Interface for a diplomatic negotiation
- is_null_interface
- cqi
- proposers
- recipients
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: cqi
- Description: Cqi
- Parameters: ()
- Return: (card32)
- Function: proposers
- Description: Proposers
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_LIST_SCRIPT_INTERFACE)
- Function: recipients
- Description: Recipients
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_LIST_SCRIPT_INTERFACE)
- Description: Interface for a negotiated diplomacy deal
- is_null_interface
- deal
- components
- proposers
- recipients
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: deal
- Description: Deal
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_DEAL_SCRIPT_INTERFACE)
- Function: components
- Description: Components
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_PROPOSED_COMPONENT_LIST_SCRIPT_INTERFACE)
- Function: proposers
- Description: Proposers
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_LIST_SCRIPT_INTERFACE)
- Function: recipients
- Description: Recipients
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_LIST_SCRIPT_INTERFACE)
- Description: A list of negotiated diplomacy deals
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_NEGOTIATED_DEAL_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Interface for a group of related negotiated diplomacy deals
- is_null_interface
- deals
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: deals
- Description: Deals
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_NEGOTIATED_DEAL_LIST_SCRIPT_INTERFACE)
- Description: A negotiation participant, made up of multiple factions
- is_null_interface
- negotiation_role
- is_primary_participant
- primary_faction
- other_factions
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: negotiation_role
- Description: Role in the negotiation
- Parameters: ()
- Return: (String)
- Function: is_primary_participant
- Description: Is the primary participant
- Parameters: ()
- Return: (bool)
- Function: primary_faction
- Description: Primary Faction
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: other_factions
- Description: Other Factions
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Description: A list of negotiation participants
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_NEGOTIATION_PARTICIPANT_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Interface for a single proposed diplomacy deal component
- is_null_interface
- treaty_component_key
- proposer
- recipient
- component_record
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: treaty_component_key
- Description: Treaty Component Record Key
- Parameters: ()
- Return: (String)
- Function: proposer
- Description: Proposer
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: recipient
- Description: Recipient
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: component_record
- Description: Underlying component record
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_COMPONENT_RECORD_SCRIPT_INTERFACE)
- Description: A list of proposed diplomacy deal components
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_PROPOSED_COMPONENT_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: An alliance of factions
- is_null_interface
- contains_member
- cqi
- members
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: contains_member
- Description: Does this alliance contain the specified faction?
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction)
- Return: (bool)
- Function: cqi
- Description: Alliance's CQI
- Parameters: ()
- Return: (card32)
- Function: members
- Description: All members of this alliance
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Description: A list of alliances
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_DIPLOMACY_ALLIANCE_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Event Generator Queries
- is_null_interface
- round_last_valid_event_was_generated
- round_last_valid_dilemma_was_generated
- round_last_valid_incident_was_generated
- round_last_valid_mission_was_generated
- round_last_mission_was_generated_with_issuer
- rounds_until_issuer_valid
- any_of_missions_active
- any_of_missions_active_with_status
- have_any_of_missions_been_generated
- any_of_missions_active_with_issuer
- any_of_missions_generated_with_issuer
- have_any_of_incidents_been_generated
- have_any_of_dilemmas_been_generated
- dilemma_choice_made
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: round_last_valid_event_was_generated
- Description: Returns the round the last valid event was generated, 0 if none have been generated
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction)
- Return: (card32)
- Function: round_last_valid_dilemma_was_generated
- Description: Returns the round the last valid dilemma was generated, 0 if none have been generated
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction)
- Return: (card32)
- Function: round_last_valid_incident_was_generated
- Description: Returns the round the last valid incident was generated, 0 if none have been generated
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction)
- Return: (card32)
- Function: round_last_valid_mission_was_generated
- Description: Returns the round the last valid mission was generated, 0 if none have been generated
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction)
- Return: (card32)
- Function: round_last_mission_was_generated_with_issuer
- Description: Returns the round the last mission was generated with specified issuer, 0 if none have been generated. Issuer is a semi-colon (;) separated list of issuer keys
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String issuer_keys)
- Return: (card32)
- Function: rounds_until_issuer_valid
- Description: Returns the number of rounds until the specified issuer is valid to use again
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String issuer_key)
- Return: (card32)
- Function: any_of_missions_active
- Description: Returns true if any of the specified missions are currently active. mission_keys is a semi-colon (;) separated list of mission keys
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String mission_keys)
- Return: (bool)
- Function: any_of_missions_active_with_status
- Description: Returns true if any of the specified missions are currently active. mission_keys is a semi-colon (;) separated list of mission keys. Status is the status key
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String mission_keys, String status_key)
- Return: (bool)
- Function: have_any_of_missions_been_generated
- Description: Returns true if any of the specified missions have been generated. mission_keys is a semi-colon (;) separated list of mission keys.
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String mission_keys)
- Return: (bool)
- Function: any_of_missions_active_with_issuer
- Description: Returns true if any missions issued by one of the specified issuers is currently active. issuer_keys is a semi-colon (;) separated list of keys.
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String issuer_keys)
- Return: (bool)
- Function: any_of_missions_generated_with_issuer
- Description: Returns true if any missions have been generated and issued by one of the specified issuers. issuer_keys is a semi-colon (;) separated list of keys.
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String issuer_keys)
- Return: (bool)
- Function: have_any_of_incidents_been_generated
- Description: Returns true if any of the specified incidents have been generated. incident_keys is a semi-colon (;) separated list of incident keys.
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String incident_keys)
- Return: (bool)
- Function: have_any_of_dilemmas_been_generated
- Description: Returns true if any of the specified dilemmas have been generated. dilemma_keys is a semi-colon (;) separated list of dilemma keys.
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String dilemma_keys)
- Return: (bool)
- Function: dilemma_choice_made
- Description: Returns the choice made for the most recent instance of the specified dilemma. Returns NONE if the dilemma has not been generated or if the choice has not been made yet.
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String dilemma_key)
- Return: (String)
- Description: CUSTOM_EVENT_BUILDER_SCRIPT_INTERFACE
- is_null_interface
- add_character_target
- add_faction_target
- add_region_target
- add_force_target
- add_settlement_target
- trigger
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: add_character_target
- Description: Add a character target
- Parameters: add_character_target()
- Return: String
- Function: add_faction_target
- Description: Add a faction as a target
- Parameters: add_faction_target()
- Return: String, QUERY_FACTION_SCRIPT_INTERFACE
- Function: add_region_target
- Description: Add a region as a target
- Parameters: add_region_target()
- Return: String, QUERY_REGION_SCRIPT_INTERFACE
- Function: add_force_target
- Description: Add a force as a target
- Parameters: add_force_target()
- Return: String, QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- Function: add_settlement_target
- Description: Add a settleemnt as a target
- Parameters: add_settlement_target()
- Return: String, QUERY_SETTLEMENT_SCRIPT_INTERFACE
- Function: trigger
- Description: Activate the event
- Parameters: trigger()
- Return: void
- Description: Campaign Model Callback Request
- is_null_interface
- event_id
- regions
- factions
- military_forces
- characters
- set_id
- add_region
- add_faction
- add_military_force
- add_character
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: event_id
- Description: String identifier of this event
- Parameters: ()
- Return: (String)
- Function: regions
- Description: Regions contained within this request
- Parameters: ()
- Return: (RETURN_QUERY_REGION_LIST_SCRIPT_INTERFACE)
- Function: factions
- Description: Factions contained within this request
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Function: military_forces
- Description: Military Forces contained within this request
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_LIST_SCRIPT_INTERFACE)
- Function: characters
- Description: Characters contained within this request
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_LIST_SCRIPT_INTERFACE)
- Function: set_id
- Description: Set the string identifier of this event
- Parameters: (String id)
- Return: ()
- Function: add_region
- Description: Add a region to the request. Returns index of the parameter
- Parameters: (QUERY_REGION_SCRIPT_INTERFACE* region)
- Return: (card32)
- Function: add_faction
- Description: Add a faction to the request. Returns index of the parameter
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction)
- Return: (card32)
- Function: add_military_force
- Description: Add a military force to the request. Returns index of the parameter
- Parameters: (QUERY_MILITARY_FORCE_SCRIPT_INTERFACE* force)
- Return: (card32)
- Function: add_character
- Description: Add a character to the request. Returns index of the parameter
- Parameters: (QUERY_CHARACTER_SCRIPT_INTERFACE* character)
- Return: (card32)
- Description: An empty interface, returned if a requested interface doesn't exist. If function calls are made with this interface, the LUA script will fail
- is_null_interface
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Description: Scripting specific functionality.
- is_null_interface
- model
- query_episodic_scripting
- set_ui_enabled
- add_time_trigger
- remove_time_trigger
- fade_scene
- dismiss_advice
- show_shroud
- fade_shroud
- show_borders
- take_shroud_snapshot
- restore_shroud_from_snapshot
- make_neighbouring_regions_visible_in_shroud
- make_neighbouring_regions_seen_in_shroud
- make_sea_region_visible_in_shroud
- make_sea_region_seen_in_shroud
- steal_user_input
- steal_escape_key
- register_instant_movie
- register_instant_movie_by_record
- register_outro_movie
- add_marker
- remove_marker
- disable_saving_game
- disable_end_turn
- end_turn
- add_vfx
- remove_vfx
- add_circle_area_trigger
- remove_area_trigger
- disable_shortcut
- override_ui
- autosave_at_next_opportunity
- add_event_restricted_unit_record
- remove_event_restricted_unit_record
- add_event_restrict_all_units
- remove_event_restrict_all_units
- add_event_restricted_building_record
- remove_event_restricted_building_record
- add_event_restricted_pooled_resource_record
- remove_event_restricted_pooled_resource_record
- suppress_all_event_feed_event_types
- whitelist_event_feed_event_type
- cinematic
- disable_event_feed_events
- toggle_dilemma_generation
- toggle_incident_generation
- toggle_mission_generation
- trigger_performance_metrics_start
- trigger_performance_metrics_stop
- take_screenshot
- add_custom_battlefield
- remove_custom_battlefield
- award_achievement
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_episodic_scripting
- Description: Returns the query episodic scripting interface
- Parameters: query_episodic_scripting()
- Return: QUERY_EPISODIC_SCRIPTING_SCRIPT_INTERFACE
- Function: set_ui_enabled
- Description: Enables ui. Takes a bool to enable/disable.
- Parameters: set_ui_enabled( enable_bool )
- Return:
- Function: add_time_trigger
- Description: Register a trigger to fire in TIME seconds. Takes an id string and a time.
- Parameters: add_time_trigger( "id_string", time_in_seconds_float )
- Return:
- Function: remove_time_trigger
- Description: Remove a trigger by id String. Takes an id string.
- Parameters: remove_time_trigger( "id_string" )
- Return:
- Function: fade_scene
- Description: Fade the scene to black and back. Takes two floats.
- Parameters: fade_scene(duration_seconds, target_brghtness)
- Return:
- Function: dismiss_advice
- Description: Dismisses advice panel in the ui
- Parameters: dismiss_advice()
- Return:
- Function: show_shroud
- Description: Show or Hide the shroud. Takes a bool parameter.
- Parameters: show_shroud( show )
- Return:
- Function: fade_shroud
- Description: Fade the shroud. Takes two floats.
- Parameters: fade_shroud(duration_seconds, target_alpha)
- Return:
- Function: show_borders
- Description: Show or Hide the borders. Takes a bool parameter.
- Parameters: show_borders( show )
- Return:
- Function: take_shroud_snapshot
- Description: Take snapshot of current shroud.
- Parameters: take_shroud_snapshot()
- Return:
- Function: restore_shroud_from_snapshot
- Description: Restore snapshot of shroud.
- Parameters: restore_shroud_from_snapshot()
- Return:
- Function: make_neighbouring_regions_visible_in_shroud
- Description:
- Parameters: make_neighbouring_regions_visible_in_shroud()
- Return:
- Function: make_neighbouring_regions_seen_in_shroud
- Description:
- Parameters: make_neighbouring_regions_seen_in_shroud()
- Return:
- Function: make_sea_region_visible_in_shroud
- Description: takes a sea region key
- Parameters: make_sea_region_visible_in_shroud( "sea region key" )
- Return:
- Function: make_sea_region_seen_in_shroud
- Description: takes a sea region key
- Parameters: make_sea_region_seen_in_shroud( "sea region key" )
- Return:
- Function: steal_user_input
- Description: takes a bool to enable/disable
- Parameters: steal_user_input( enable )
- Return:
- Function: steal_escape_key
- Description: takes a bool to enable/disable
- Parameters: steal_escape_key ( steal )
- Return:
- Function: register_instant_movie
- Description: Can only register one at a time. Takes the movie path.
- Parameters: register_instant_movie( "movie_path" )
- Return:
- Function: register_instant_movie_by_record
- Description: Can only register one at a time. Takes the movie record key (videos table).
- Parameters: (String key)
- Return: (void)
- Function: register_outro_movie
- Description: Can only register one at a time. Takes the movie path.
- Parameters: register_instant_movie( "movie_path" )
- Return:
- Function: add_marker
- Description: Add a marker at a position (x, y, z), using a specific VFX, with a specific active state. First parameter is the unique ID
- Parameters: add_marker("test_id", "ping_type", 10, 50, 2)
- Return:
- Function: remove_marker
- Description: Remove a marker matching the unique id
- Parameters: remove_marker("test_id")
- Return:
- Function: disable_saving_game
- Description: Takes a bool to disable/enable
- Parameters: disable_saving_game(true)
- Return:
- Function: disable_end_turn
- Description: Takes a bool to disable/enable
- Parameters: disable_end_turn(true)
- Return:
- Function: end_turn
- Description: End the turn at next opportunity (only do this for a player faction)
- Parameters: end_turn()
- Return:
- Function: add_vfx
- Description: Add a vfx at a position (x, y, z), using a specific VFX, with a specific active state. First parameter is the unique ID
- Parameters: add_vfx("test", "vfx_id (campaign_vfx_lookup_table) ", 10, 50, 2)
- Return:
- Function: remove_vfx
- Description: Remove the vfx with the specified unique ID
- Parameters: remove_vfx("test")
- Return:
- Function: add_circle_area_trigger
- Description: Set up a circular area trigger, used with AreaEntered/AreaExited. name is a name for this trigger area. Multiple triggers with the same name act as a single trigger.
- Parameters: add_circle_area_trigger(x, y, radius, "name", "filter", trigger_on_enter, trigger_on_exit, trigger_once_only)
- Return:
- Function: remove_area_trigger
- Description: Remove the named area trigger.
- Parameters: remove_area_trigger("name")
- Return:
- Function: disable_shortcut
- Description: Disable or enable a shortcut.
- Parameters: disable_shortcut("object_id", "function_id", set_disabled)
- Return:
- Function: override_ui
- Description: Enable or disable the specified ui override. Takes a ui_id string and a bool to enable/disable
- Parameters: override_ui("ui_id", enable)
- Return:
- Function: autosave_at_next_opportunity
- Description:
- Parameters: autosave_at_next_opportunity()
- Return:
- Function: add_event_restricted_unit_record
- Description: Prevent a unit from being recruited until a scripted event has occurred. Takes a unit record key string
- Parameters: add_event_restricted_unit_record("unit_record", "disabled_tooltip")
- Return:
- Function: remove_event_restricted_unit_record
- Description: Remove a restriction added by 'add_event_restricted_unit_record'. Takes a unit record key string
- Parameters: remove_event_restricted_unit_record("unit_record")
- Return:
- Function: add_event_restrict_all_units
- Description: Stop all units being recruited until a scripted event has occurred
- Parameters: add_event_restrict_all_units("disabled_tooltip")
- Return:
- Function: remove_event_restrict_all_units
- Description: Remove all units being recruited restriction
- Parameters: remove_event_restrict_all_units()
- Return:
- Function: add_event_restricted_building_record
- Description: Prevent a building from being build until a scripted event has occurred. Takes a building record key string
- Parameters: add_event_restricted_building_record("building_record")
- Return:
- Function: remove_event_restricted_building_record
- Description: Remove a restriction added by 'add_event_restricted_building_record'. Takes a building record key string
- Parameters: remove_event_restricted_building_record("building_record")
- Return:
- Function: add_event_restricted_pooled_resource_record
- Description: Disable pooled resource effects for all pooled resources of the given type. Takes a pooled resource record key string.
- Parameters: (String pooled_resource_record)
- Return: (void)
- Function: remove_event_restricted_pooled_resource_record
- Description: Remove event restriction on pooled resource effects for all pooled resources of the given type. Takes a pooled resource record key string.
- Parameters: (String pooled_resource_record)
- Return: (void)
- Function: suppress_all_event_feed_event_types
- Description: Forces all event feed messages to be suppressed/unsuppressed
- Parameters: suppress_all_event_feed_event_types(true)
- Return:
- Function: whitelist_event_feed_event_type
- Description: Removes a targeted event feed event from the set of suppressed events
- Parameters: whitelist_event_feed_event_type("agent_action_vs_armyevent_feed_target_agent_faction")
- Return:
- Function: cinematic
- Description: creates a cinematic scripting interface. This interface provides functions like cindy_playback
- Parameters: cinematic()
- Return:
- Function: disable_event_feed_events
- Description: Enable or disable event feed events by category, subcategory or event (any list can be empty). Note that if you disable something by for example subcategory then you can only re-enable it by subcategory, enabling the category it is in (or the specific event) will not re-enable it.
- Parameters: disable_event_feed_events(true, "category_key_1;category_key_2", "", "event_key")
- Return:
- Function: toggle_dilemma_generation
- Description: Set dilemma generation to be allowed or not
- Parameters: toggle_dilemma_generation(bool enabled)
- Return:
- Function: toggle_incident_generation
- Description: Set incident generation to be allowed or not
- Parameters: toggle_incident_generation(bool enabled)
- Return:
- Function: toggle_mission_generation
- Description: Set mission generation to be allowed or not
- Parameters: toggle_mission_generation(bool enabled)
- Return:
- Function: trigger_performance_metrics_start
- Description: Start timing information gather
- Parameters: trigger_performance_metrics_start()
- Return:
- Function: trigger_performance_metrics_stop
- Description: Stop timing information gather and send
- Parameters: trigger_performance_metrics_stop()
- Return:
- Function: take_screenshot
- Description: Notify the campaign view to take a screenshot
- Parameters: (String filename)
- Return: (void)
- Function: add_custom_battlefield
- Description: Add a custom battlefield
- Parameters: (String id, float32 x_pos, float32 y_pos, float32 radius, bool dump_campaign, String override_loading_screen, String override_script_path, String battle_path, card32 human_alliance, bool launch_battle_immediately, bool is_land_battle)
- Return: (void)
- Function: remove_custom_battlefield
- Description: Remove a custom battlefield by id
- Parameters: (String id)
- Return: (void)
- Function: award_achievement
- Description: Award an achievement
- Parameters: (String achievement)
- Return: (void)
- Description: Contains entities that exist in the game world. Examples include the region manager and faction list
- is_null_interface
- model
- query_world
- get_modify_world_power_tokens
- add_world_leader_region_status
- remove_world_leader_region_status
- register_mp_co_op_factions
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_world
- Description: Returns the query world interface
- Parameters: query_world()
- Return: QUERY_WORLD_SCRIPT_INTERFACE
- Function: get_modify_world_power_tokens
- Description: Returns the modify world power tokens interface from a QUERY_QUERY_WORLD_POWER_TOKENS_SCRIPT_INTERFACE_SCRIPT_INTERFACE
- Parameters: (QUERY_WORLD_POWER_TOKENS_SCRIPT_INTERFACE* query_interface)
- Return: (RETURN_MODIFY_WORLD_POWER_TOKENS_SCRIPT_INTERFACE)
- Function: add_world_leader_region_status
- Description: Disable factions being able to propose diplomatic treaty components to other factions with a reason. Filters can contain comma separated elements. Valid elements are "all", "faction:faction_key", "subculture:subculture_key" and "culture:culture_key". component_keys is a comma separated list of campaign_diplomacy_treaty_component keys. reason_key is a key from the campaign_diplomacy_treaty_availability_reasons table.
- Parameters: (String region_key)
- Return: (void)
- Function: remove_world_leader_region_status
- Description: Disable factions being able to propose diplomatic treaty components to other factions with a reason. Filters can contain comma separated elements. Valid elements are "all", "faction:faction_key", "subculture:subculture_key" and "culture:culture_key". component_keys is a comma separated list of campaign_diplomacy_treaty_component keys. reason_key is a key from the campaign_diplomacy_treaty_availability_reasons table.
- Parameters: (String region_key)
- Return: (void)
- Function: register_mp_co_op_factions
- Description: Register co-op factions in the model.
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction1, QUERY_FACTION_SCRIPT_INTERFACE* faction2)
- Return: (void)
- Description: Model is the central access point of the campaign. Everything should be reachable from this interface
- is_null_interface
- query_model
- get_modify_episodic_scripting
- get_modify_world
- get_modify_faction
- get_modify_character
- get_modify_region_manager
- get_modify_region
- get_modify_garrison_residence
- get_modify_settlement
- get_modify_slot
- get_modify_building
- get_modify_military_force_slot
- get_modify_military_force_building
- get_modify_military_force
- get_modify_military_force_retinue
- get_modify_military_force_horde_details
- get_modify_unit
- get_modify_pending_battle
- get_modify_campaign_ai
- get_modify_family_member
- get_modify_shared_states_manager
- get_modify_province
- get_modify_faction_province
- get_modify_mission
- get_modify_mission_by_cqi
- get_modify_faction_ceo_management
- get_modify_character_ceo_management
- get_modify_pooled_resource_manager
- get_modify_pooled_resource
- get_modify_undercover_character
- get_modify_undercover_character_manager
- create_incident
- create_dilemma
- random_percentage
- random_int
- random_number
- disable_diplomacy
- enable_diplomacy
- force_civil_war
- set_end_turn_notification_suppressed
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_model
- Description: Returns the query campaign model
- Parameters: query_model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: get_modify_episodic_scripting
- Description: Returns the modify episodic scripting interface
- Parameters: get_modify_episodic_scripting()
- Return: MODIFY_EPISODIC_SCRIPTING_SCRIPT_INTERFACE
- Function: get_modify_world
- Description: Returns the modify world interface
- Parameters: get_modify_world()
- Return: MODIFY_WORLD_SCRIPT_INTERFACE
- Function: get_modify_faction
- Description: Returns the modify faction interface from a QUERY_FACTION_SCRIPT_INTERFACE
- Parameters: get_modify_faction( query_faction_interface )
- Return: MODIFY_FACTION_SCRIPT_INTERFACE
- Function: get_modify_character
- Description: Returns the modify character interface from a QUERY_CHARACTER_SCRIPT_INTERFACE
- Parameters: get_modify_character( query_character_interface )
- Return: MODIFY_CHARACTER_SCRIPT_INTERFACE
- Function: get_modify_region_manager
- Description: Returns the modify region_manager interface
- Parameters: get_modify_region_manager()
- Return: MODIFY_REGION_MANAGER_SCRIPT_INTERFACE
- Function: get_modify_region
- Description: Returns the modify region interface from a QUERY_REGION_SCRIPT_INTERFACE
- Parameters: get_modify_region( query_region_interface )
- Return: MODIFY_REGION_SCRIPT_INTERFACE
- Function: get_modify_garrison_residence
- Description: Returns the modify garrison_residence interface from a QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE
- Parameters: get_modify_garrison_residence( query_garrison_residence_interface )
- Return: MODIFY_GARRISON_RESIDENCE_SCRIPT_INTERFACE
- Function: get_modify_settlement
- Description: Returns the modify settlement interface from a QUERY_SETTLEMENT_SCRIPT_INTERFACE
- Parameters: get_modify_settlement( query_settlement_interface )
- Return: MODIFY_SETTLEMENT_SCRIPT_INTERFACE
- Function: get_modify_slot
- Description: Returns the modify slot interface from a QUERY_SLOT_SCRIPT_INTERFACE
- Parameters: get_modify_slot( query_slot_interface )
- Return: MODIFY_SLOT_SCRIPT_INTERFACE
- Function: get_modify_building
- Description: Returns the modify building interface from a QUERY_BUILDING_SCRIPT_INTERFACE
- Parameters: get_modify_building( query_building_interface )
- Return: MODIFY_BUILDING_SCRIPT_INTERFACE
- Function: get_modify_military_force_slot
- Description: Returns the modify military force slot interface from a QUERY_MILITARY_FORCE_SLOT_SCRIPT_INTERFACE
- Parameters: get_modify_military_force_slot( query_military_force_slot_interface )
- Return: MODIFY_MILITARY_FORCE_SLOT_SCRIPT_INTERFACE
- Function: get_modify_military_force_building
- Description: Returns the modify military force building interface from a QUERY_MILITARY_FORCE_BUILDING_SCRIPT_INTERFACE
- Parameters: get_modify_military_force_building( query_military_force_building_interface )
- Return: MODIFY_MILITARY_FORCE_BUILDING_SCRIPT_INTERFACE
- Function: get_modify_military_force
- Description: Returns the modify military_force interface from a QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- Parameters: get_modify_military_force( query_military_force_interface )
- Return: MODIFY_MILITARY_FORCE_SCRIPT_INTERFACE
- Function: get_modify_military_force_retinue
- Description: Returns the modify military_force_retinue interface from a QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE
- Parameters: get_modify_military_force_retinue( query_military_force_retinue_interface )
- Return: MODIFY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE
- Function: get_modify_military_force_horde_details
- Description: Returns the modify military_force interface from a QUERY_MILITARY_FORCE_HORDE_DETAILS_SCRIPT_INTERFACE
- Parameters: get_modify_military_force_horde_details( query_military_force_horde_details_interface )
- Return: MODIFY_MILITARY_FORCE_HORDE_DETAILS_SCRIPT_INTERFACE
- Function: get_modify_unit
- Description: Returns the modify unit interface from a QUERY_UNIT_SCRIPT_INTERFACE
- Parameters: get_modify_unit( query_unit_interface )
- Return: MODIFY_UNIT_SCRIPT_INTERFACE
- Function: get_modify_pending_battle
- Description: Returns the modify pending_battle interface
- Parameters: get_modify_pending_battle()
- Return: MODIFY_PENDING_BATTLE_SCRIPT_INTERFACE
- Function: get_modify_campaign_ai
- Description: Returns the modify campaign_ai interface from a QUERY_CAMPAIGN_AI_SCRIPT_INTERFACE
- Parameters: get_modify_campaign_ai( query_campaign_ai_interface )
- Return: MODIFY_CAMPAIGN_AI_SCRIPT_INTERFACE
- Function: get_modify_family_member
- Description: Returns the modify family_member interface from a QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE
- Parameters: get_modify_family_member( query_family_member_interface )
- Return: MODIFY_FAMILY_MEMBER_SCRIPT_INTERFACE
- Function: get_modify_shared_states_manager
- Description: Get modify interface for the shared states manager
- Parameters: (QUERY_SHARED_STATES_MANAGER* query_interface)
- Return: (RETURN_OPTIONAL_MODIFY_SHARED_STATES_MANAGER)
- Function: get_modify_province
- Description: Get modify interface from query interface
- Parameters: (QUERY_PROVINCE_SCRIPT_INTERFACE* query_interface)
- Return: (RETURN_OPTIONAL_MODIFY_PROVINCE_SCRIPT_INTERFACE)
- Function: get_modify_faction_province
- Description: Get modify interface from query interface
- Parameters: (QUERY_FACTION_PROVINCE_SCRIPT_INTERFACE* query_interface)
- Return: (RETURN_OPTIONAL_MODIFY_FACTION_PROVINCE_SCRIPT_INTERFACE)
- Function: get_modify_mission
- Description: Returns the modify mission interface from a QUERY_MISSION_SCRIPT_INTERFACE
- Parameters: (QUERY_CAMPAIGN_MISSION_SCRIPT_INTERFACE* query_interface)
- Return: (RETURN_MODIFY_CAMPAIGN_MISSION_SCRIPT_INTERFACE)
- Function: get_modify_mission_by_cqi
- Description: Returns the modify mission interface representing the mission with the passed CQI
- Parameters: (card32 cqi)
- Return: (RETURN_OPTIONAL_MODIFY_CAMPAIGN_MISSION_SCRIPT_INTERFACE)
- Function: get_modify_faction_ceo_management
- Description: Get modify interface from query interface
- Parameters: (QUERY_FACTION_CEO_MANAGEMENT_SCRIPT_INTERFACE * query_interface)
- Return: (RETURN_MODIFY_FACTION_CEO_MANAGEMENT_SCRIPT_INTERFACE)
- Function: get_modify_character_ceo_management
- Description: Get modify interface from query interface
- Parameters: (QUERY_CHARACTER_CEO_MANAGEMENT_SCRIPT_INTERFACE * query_interface)
- Return: (RETURN_MODIFY_CHARACTER_CEO_MANAGEMENT_SCRIPT_INTERFACE)
- Function: get_modify_pooled_resource_manager
- Description: Get modify interface from query interface
- Parameters: (QUERY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE * query_interface)
- Return: (RETURN_MODIFY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE)
- Function: get_modify_pooled_resource
- Description: Get modify interface from query interface
- Parameters: (QUERY_POOLED_RESOURCE_SCRIPT_INTERFACE * query_interface)
- Return: (RETURN_MODIFY_POOLED_RESOURCE_SCRIPT_INTERFACE)
- Function: get_modify_undercover_character
- Description: Get modify interface from query interface
- Parameters: (QUERY_UNDERCOVER_CHARACTER_SCRIPT_INTERFACE * query_interface)
- Return: (RETURN_MODIFY_UNDERCOVER_CHARACTER_SCRIPT_INTERFACE)
- Function: get_modify_undercover_character_manager
- Description: Get modify interface from query interface
- Parameters: (QUERY_FACTION_UNDERCOVER_CHARACTER_MANAGER_SCRIPT_INTERFACE * query_interface)
- Return: (RETURN_MODIFY_FACTION_UNDERCOVER_CHARACTER_MANAGER_SCRIPT_INTERFACE)
- Function: create_incident
- Description: Starts creating a new incident. It will return a small object that you can use to customise your event.
- Parameters: create_incident(String event_key)
- Return: MODIFY_EVENT_BUILDER_SCRIPT_INTERFACE
- Function: create_dilemma
- Description: Starts creating a new dilemma. It will return a small object that you can use to customise your event.
- Parameters: create_dilemma(String event_key)
- Return: MODIFY_EVENT_BUILDER_SCRIPT_INTERFACE
- Function: random_percentage
- Description: Returns a random percentage value between and including (0, 100)
- Parameters: random_percentage()
- Return: Int
- Function: random_int
- Description: Returns a random number between and including the supplied numbers. Number can be negative.
- Parameters: random_int( min_value, max_value )
- Return: int
- Function: random_number
- Description: Returns a random number between and including the supplied numbers.
- Parameters: random_number( min_value, max_value )
- Return: float
- Function: disable_diplomacy
- Description: Disable factions being able to propose diplomatic treaty components to other factions with a reason. Filters can contain comma separated elements. Valid elements are "all", "faction:faction_key", "subculture:subculture_key" and "culture:culture_key". component_keys is a comma separated list of campaign_diplomacy_treaty_component keys. reason_key is a key from the campaign_diplomacy_treaty_availability_reasons table.
- Parameters: (String proposer_filter, String recipient_filter, String component_keys, String reason_key)
- Return: (void)
- Function: enable_diplomacy
- Description: Re-enable factions being able to propose diplomatic treaty components to other factions, subject to other conditions. Filters can contain comma separated elements. Valid elements are "all", "faction:faction_key", "subculture:subculture_key" and "culture:culture_key". component_keys is a comma separated list of diplomacy_treaty_component keys. reason_key is a key from the campaign_diplomacy_treaty_availability_reasons table.
- Parameters: (String proposer_filter, String recipient_filter, String component_keys, String reason_key)
- Return: (void)
- Function: force_civil_war
- Description: Triggers civil war with specified instigator
- Parameters: (QUERY_CHARACTER_SCRIPT_INTERFACE* instigator)
- Return: (void)
- Function: set_end_turn_notification_suppressed
- Description: Suppress or unsupress the specified end turn notification
- Parameters: (String notification_key, bool suppress)
- Return: ()
- Description: DESCRIPTION - TODO
- is_null_interface
- ceo_management
- model
- query_faction
- disable_movement
- enable_movement
- show_message_event
- show_message_event_located
- create_force
- create_force_with_general
- default_force_orientation_angle
- create_agent
- apply_effect_bundle
- remove_effect_bundle
- trigger_custom_mission
- cancel_custom_mission
- complete_custom_mission
- complete_scripted_mission_objective
- set_scripted_mission_objective_as_incomplete
- set_scripted_mission_text
- set_scripted_mission_position
- increase_treasury
- decrease_treasury
- lock_technology
- unlock_technology
- begin_tech_research
- add_event_restricted_unit_record
- remove_event_restricted_unit_record
- add_event_restrict_all_units
- remove_event_restrict_all_units
- add_event_restricted_building_record
- remove_event_restricted_building_record
- make_region_visible_in_shroud
- make_region_seen_in_shroud
- make_region_capital
- trigger_custom_mission_from_string
- trigger_mission
- trigger_dilemma
- trigger_incident
- lock_starting_general_recruitment
- unlock_starting_general_recruitment
- disable_diplomacy
- enable_diplomacy
- apply_automatic_diplomatic_deal
- set_tech_research_cooldown
- get_map_pins_handler
- create_recruitable_character
- create_recruitable_character_with_gender
- create_recruitable_character_with_subtype
- create_recruitable_character_from_template
- create_character
- create_character_with_gender
- create_character_with_subtype
- create_character_from_template
- change_base_threat_score_for_a_faction
- unlock_progression_level_to_allow_x_levels
- unlock_progression_level_changes
- lock_progression_level_changes
- is_progression_level_changes_locked
- make_confederation_with
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: ceo_management
- Description: Get ceo management modify interface
- Parameters: ()
- Return: (RETURN_OPTIONAL_MODIFY_FACTION_CEO_MANAGEMENT_SCRIPT_INTERFACE)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_faction
- Description: Returns the query faction interface
- Parameters: query_faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: disable_movement
- Description: freeze all characters of this faction in place
- Parameters: disable_movement()
- Return:
- Function: enable_movement
- Description: unfreeze all characters of this faction
- Parameters: enable_movement()
- Return:
- Function: show_message_event
- Description: Show a message event with the specified title, primary detail and secondary detail. The penultimate parameter indicates if this message persists in the event log. The final parameter is the message event type index, used to pick message variants with different images and other details.
- Parameters: show_message_event( "title_localisation_key", "primary_detail_localisation_key", "secondary_detail_localisation_key", is_persistent_bool, index_int)
- Return:
- Function: show_message_event_located
- Description: Show a message event with the specified title, primary detail, secondary detail and location. The penultimate parameter indicates if this message persists in the event log. The final parameter is the message event type index, used to pick message variants with different images and other details.
- Parameters: show_message_event( "title_localisation_key", "primary_detail_localisation_key", "secondary_detail_localisation_key", x_coord, y_coord, is_persistent_bool, index_int)
- Return:
- Function: create_force
- Description: Create a navy or army at a position. Starting_health_percentage_override greater than 0 cancels mustering and applies an initial strength override, starting_orientation_angle different than default_orientation_angle overrides the starting facing angle
- Parameters: create_force( "unit_list", "region_key", x_position, y_position, "id", exclude_named_characters_bool, "starting_health_percentage_override", "starting_orientation_angle")
- Return:
- Function: create_force_with_general
- Description: create a navy or army at a position. Final parameter specified whether the command goes via the command queue. Starting_health_percentage_override greater than 0 cancels mustering and applies an initial strength override, starting_orientation_angle different than default_orientation_angle overrides the starting facing angle
- Parameters: create_force_with_general("unit_list", "region_key", x_position, y_position, "general_agent_type_key", "general_agent_subtype_key", "character_template_key", "id", "make_faction_leader", "starting_health_percentage_override", "starting_orientation_angle")
- Return:
- Function: default_force_orientation_angle
- Description: Provides a default orientation angle to be used with create_force* functions as an identity element (won't affect force orientation if passed to them)
- Parameters:
- Return: float32 - default orientation angle
- Function: create_agent
- Description: create an agent at a position
- Parameters: create_agent( "agent_key", "agent_subtype_key", x_position, y_position, "id", "character_generation_template_record_key" )
- Return:
- Function: apply_effect_bundle
- Description: Apply an effect bundle to a faction for a number of turns (-1 turns means indefinitely).
- Parameters: apply_effect_bundle("effect_bundle_key", turns)
- Return:
- Function: remove_effect_bundle
- Description: Remove a previously applied effect bundle from a faction
- Parameters: remove_effect_bundle("effect_bundle_key")
- Return:
- Function: trigger_custom_mission
- Description: Start a player mission
- Parameters: trigger_custom_mission("mission_definition")
- Return:
- Function: cancel_custom_mission
- Description: Cancel mission
- Parameters: (String mission)
- Return: (void)
- Function: complete_custom_mission
- Description: Complete mission
- Parameters: (String mission)
- Return: (void)
- Function: complete_scripted_mission_objective
- Description: Complete a scripted mission objective
- Parameters: complete_scripted_mission_objective(string mission_key, string script_key, bool success)
- Return:
- Function: set_scripted_mission_objective_as_incomplete
- Description: Mark a scripted mission objective as incomplete
- Parameters: set_scripted_mission_objective_as_incomplete(string mission_key, string script_key)
- Return:
- Function: set_scripted_mission_text
- Description: Set the text of a scripted mission objective
- Parameters: set_scripted_mission_text(string mission_key, string script_key, string override_text_key)
- Return:
- Function: set_scripted_mission_position
- Description: Set the position of a scripted mission objective
- Parameters: set_scripted_mission_position(string mission_key, string script_key, card16 pos_x, card16 pos_y)
- Return:
- Function: increase_treasury
- Description: modify the treasury by the specified amount
- Parameters: increase_treasury( amount_int )
- Return:
- Function: decrease_treasury
- Description: modify the treasury by the specified amount
- Parameters: decrease_treasury( amount_int )
- Return:
- Function: lock_technology
- Description: Lock a technology and all children
- Parameters: lock_technology( "technology_key" )
- Return:
- Function: unlock_technology
- Description: Unlock a technology and all children
- Parameters: unlock_technology( "technology_key" )
- Return:
- Function: begin_tech_research
- Description: Starts researching a tech, if available to research and nothing is currently being researched
- Parameters: begin_tech_research( "technology_key" )
- Return: boolean - true if research was started
- Function: add_event_restricted_unit_record
- Description: Prevent a unit from being recruited until a scripted event has occurred. Restriction only applies to this faction.
- Parameters: add_event_restricted_unit_record( "unit_key" )
- Return:
- Function: remove_event_restricted_unit_record
- Description: Remove a restriction added for this faction
- Parameters: remove_event_restricted_unit_record( "unit_key" )
- Return:
- Function: add_event_restrict_all_units
- Description: Prevent all units from being recruited until a scripted event has occurred. Restriction only applies to this faction.
- Parameters: add_event_restricted_unit_record()
- Return:
- Function: remove_event_restrict_all_units
- Description: Remove all units restriction added for this faction
- Parameters: remove_event_restricted_unit_record()
- Return:
- Function: add_event_restricted_building_record
- Description: Prevent a building from being build until a scripted event has occurred. Restriction only applies to this faction.
- Parameters: add_event_restricted_building_record( "building_key" )
- Return:
- Function: remove_event_restricted_building_record
- Description: Remove a restriction added for this faction.
- Parameters: remove_event_restricted_building_record( "building_key" )
- Return:
- Function: make_region_visible_in_shroud
- Description: Uncover shroud for region.
- Parameters: make_region_visible_in_shroud( "region_key" )
- Return:
- Function: make_region_seen_in_shroud
- Description: Uncover shroud for region.
- Parameters: make_region_seen_in_shroud( "region_key" )
- Return:
- Function: make_region_capital
- Description: Set the factions capital to the specified region. Will fail if the faction does not own the region
- Parameters: (QUERY_REGION_SCRIPT_INTERFACE* region)
- Return: (bool)
- Function: trigger_custom_mission_from_string
- Description: Start a player mission.
- Parameters: trigger_custom_mission_from_string("mission_def_str")
- Return:
- Function: trigger_mission
- Description: Start a player mission. Accepts a CSV string containing keys.
- Parameters: trigger_mission("mission_key_1, mission_key_2", fire_immediately)
- Return: boolean - true if a mission was launched
- Function: trigger_dilemma
- Description: Start a player dilemma. Accepts a CSV string containing keys.
- Parameters: trigger_dilemma("dilemma_key_1, dilemma_key_2", fire_immediately)
- Return: boolean - true if a dilemma was launched
- Function: trigger_incident
- Description: Start a player incident. Accepts a CSV string containing keys.
- Parameters: trigger_incident("incident_key_1, incident_key_2", fire_immediately)
- Return: boolean - true if an incident was launched
- Function: lock_starting_general_recruitment
- Description: lock recruitment of a starting general. Works for convalescing generals as well
- Parameters: lock_starting_general_recruitment("character_startpos_id")
- Return:
- Function: unlock_starting_general_recruitment
- Description: Unlock recruitment of a starting general. Works for convalescing generals as well
- Parameters: unlock_starting_general_recruitment("character_startpos_id")
- Return:
- Function: disable_diplomacy
- Description: Disable this faction being able to propose diplomatic treaty components to other factions with a reason. Filter can contain comma separated elements. Valid elements are "all", "faction:faction_key", "subculture:subculture_key" and "culture:culture_key". component_keys is a comma separated list of campaign_diplomacy_treaty_component keys. reason_key is a key from the campaign_diplomacy_treaty_availability_reasons table.
- Parameters: (String recipient_filter, String component_keys, String reason_key)
- Return: (void)
- Function: enable_diplomacy
- Description: Re-enable this faction being able to propose diplomatic treaty components to other factions, subject to other conditions. Filter can contain comma separated elements. Valid elements are "all", "faction:faction_key", "subculture:subculture_key" and "culture:culture_key". component_keys is a comma separated list of diplomacy_treaty_component keys. reason_key is a key from the campaign_diplomacy_treaty_availability_reasons table.
- Parameters: (String recipient_filter, String component_keys, String reason_key)
- Return: (void)
- Function: apply_automatic_diplomatic_deal
- Description: Apply an automatic diplomatic deal. This cannot be rejected. It is up to you to ensure it is valid to offer at this time. automatic_deal_key is a campaign_diplomacy_automatic_deal key. other_faction_interface is an interface to another faction. parameters is a comma separated list of parameters where each parameter can be of the form 'alliance_cqi:xxx', 'alliance_oath_key:xxx', 'ceo_cqi:xxx', 'deal_cqi:xxx', 'faction_cqi:xxx', 'faction_key:xxx', 'character_cqi:xxx', 'region_cqi:xxx' or 'region_key:xxx'.
- Parameters: (String automatic_deal_key, QUERY_FACTION_SCRIPT_INTERFACE * other_faction_interface, String parameters)
- Return: (void)
- Function: set_tech_research_cooldown
- Description: Sets the cooldown turn timer on researching
- Parameters: (card32 cooldown)
- Return: ()
- Function: get_map_pins_handler
- Description: Returns the map pins handler owned by this faction
- Parameters: ()
- Return: (RETURN_MODIFY_MAP_PINS_HANDLER_SCRIPT_INTERFACE)
- Function: create_recruitable_character
- Description: Creates a new recruitable character with the specified agent type
- Parameters: (String agent_type_key)
- Return: ()
- Function: create_recruitable_character_with_gender
- Description: Creates a new recruitable character with the specified agent type and gender
- Parameters: (String agent_type_key, bool male)
- Return: ()
- Function: create_recruitable_character_with_subtype
- Description: Creates a new recruitable character with the specified agent type, agent subtype and gender
- Parameters: (String agent_type_key, String agent_subtype_key, bool male, bool non_deployable)
- Return: ()
- Function: create_recruitable_character_from_template
- Description: Creates a new recruitable character from the specified generation template
- Parameters: (String agent_type_key, String agent_subtype_key, String generation_template_key)
- Return: ()
- Function: create_character
- Description: Creates a new character with the specified agent type
- Parameters: (String agent_type_key)
- Return: (RETURN_OPTIONAL_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: create_character_with_gender
- Description: Creates a new character with the specified agent type and gender
- Parameters: (String agent_type_key, bool male)
- Return: (RETURN_OPTIONAL_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: create_character_with_subtype
- Description: Creates a new character with the specified agent type, agent subtype and gender
- Parameters: (String agent_type_key, String agent_subtype_key, bool male, bool non_deployable)
- Return: (RETURN_OPTIONAL_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: create_character_from_template
- Description: Creates a new character from the specified generation template
- Parameters: (String agent_type_key, String agent_subtype_key, String generation_template_key, bool must_be_an_adult)
- Return: (RETURN_OPTIONAL_MODIFY_CHARACTER_SCRIPT_INTERFACE)
- Function: change_base_threat_score_for_a_faction
- Description: Changes the base threat score of a faction
- Parameters: (card32 value)
- Return: (void)
- Function: unlock_progression_level_to_allow_x_levels
- Description: Unlocks progression level changes to allow for the given number of levels, passing 0 will allow unlimited. Once levels are processed progresion will be locked again.
- Parameters: (card32 levels_allowed)
- Return: ()
- Function: unlock_progression_level_changes
- Description: Unlocks the progression level changes of this faction and processes their current prestige
- Parameters: ()
- Return: ()
- Function: lock_progression_level_changes
- Description: Locks the progression level changes of this faction, they can still gain prestige
- Parameters: ()
- Return: ()
- Function: is_progression_level_changes_locked
- Description: Returns if the progression level changes for this faction are currently locked
- Parameters: ()
- Return: (bool)
- Function: make_confederation_with
- Description: Confederate the given faction, if possible
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE * other_faction_interface)
- Return: (bool)
- Description: DESCRIPTION - TODO
- is_null_interface
- ceo_management
- model
- query_character
- add_experience
- apply_effect_bundle
- remove_effect_bundle
- disable_movement
- enable_movement
- walk_to
- teleport_to
- attack
- attack_garrison
- attack_settlement
- replenish_action_points
- zero_action_points
- kill_character
- wound_character
- set_character_unique
- add_loyalty_effect
- reset_skills
- create_force
- default_force_orientation_angle
- set_undercover_character_enabler
- apply_relationship_trigger_set
- set_is_deployable
- move_to_faction
- move_to_faction_and_make_recruited
- move_recruitment_pool_character_to_recruited_characters
- assign_to_post
- make_child_of
- assign_faction_leader
- assign_faction_leader_with_regent
- family_member
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: ceo_management
- Description: Get ceo management modify interface
- Parameters: ()
- Return: (RETURN_OPTIONAL_MODIFY_CHARACTER_CEO_MANAGEMENT_SCRIPT_INTERFACE)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_character
- Description: Returns the query character interface
- Parameters: query_character()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE
- Function: add_experience
- Description: Adds experience and gravitas for the character. Input experience int and gravitas int.
- Parameters: add_experience(experience_points, gravitas_points)
- Return: none
- Function: apply_effect_bundle
- Description: Apply an effect bundle to a character for a number of turns (-1 turns means indefinitely).
- Parameters: apply_effect_bundle("effect_bundle_key", turns)
- Return:
- Function: remove_effect_bundle
- Description: Remove a previously applied effect bundle from a character
- Parameters: remove_effect_bundle("effect_bundle_key")
- Return:
- Function: disable_movement
- Description: Disable movement for this character
- Parameters: disable_movement()
- Return:
- Function: enable_movement
- Description: Enable movement for this character
- Parameters: enable_movement()
- Return:
- Function: walk_to
- Description: Walk to position X, Y
- Parameters: walk_to(x, y)
- Return:
- Function: teleport_to
- Description: Teleport to position X, Y
- Parameters: teleport_to(x, y)
- Return:
- Function: attack
- Description: Attack another character
- Parameters: attack( query_character_script_interface_target )
- Return:
- Function: attack_garrison
- Description: Attack a Garrison
- Parameters: attack( query_garrison_residence_script_interface )
- Return:
- Function: attack_settlement
- Description: Attack a Settlement
- Parameters: attack( query_settlement_script_interface )
- Return:
- Function: replenish_action_points
- Description: Replenish action points
- Parameters: replenish_action_points()
- Return:
- Function: zero_action_points
- Description: Set zero action points
- Parameters: zero_action_points()
- Return:
- Function: kill_character
- Description: Kill a character. Takes a bool whether to also destroy the force.
- Parameters: kill_character( destroy_force_bool )
- Return:
- Function: wound_character
- Description: Wound a character
- Parameters: wound_character("convalescence_time")
- Return:
- Function: set_character_unique
- Description: Set a character as unique
- Parameters: set_character_unique(bool is_unique)
- Return:
- Function: add_loyalty_effect
- Description: Add a loyalty effect to a character
- Parameters: add_loyalty_effect(String loyalty_effect)
- Return:
- Function: reset_skills
- Description: Resets the skill points
- Parameters: reset_skills
- Return:
- Function: create_force
- Description: Create an army at a position. Starting_health_percentage_override greater than 0 cancels mustering and applies an initial strength override, starting_orientation_angle different than default_orientation_angle overrides the starting facing angle
- Parameters: create_force("region_key", "unit_list", "x_position", "y_position", "id", "starting_health_percentage_override", "starting_orientation_angle"
- Return:
- Function: default_force_orientation_angle
- Description: Provides a default orientation angle to be used with create_force function as an identity element (won't affect force orientation if passed to them)
- Parameters:
- Return: float32 - default orientation angle
- Function: set_undercover_character_enabler
- Description: Set if character has the enabler to be an undercover character
- Parameters: (bool enabled)
- Return: ()
- Function: apply_relationship_trigger_set
- Description: Apply the specified relationship trigger set from this character to the receiver
- Parameters: (QUERY_CHARACTER_SCRIPT_INTERFACE* receiver_root, String relationship_trigger_set_key)
- Return: ()
- Function: set_is_deployable
- Description: Set if the character can be deployed as a general
- Parameters: (bool value)
- Return: ()
- Function: move_to_faction
- Description: Moves character to another faction
- Parameters: (String faction_key)
- Return: (void)
- Function: move_to_faction_and_make_recruited
- Description: Moves character to another faction and move character to recruited character list
- Parameters: (String faction_key)
- Return: (void)
- Function: move_recruitment_pool_character_to_recruited_characters
- Description: Move character to recruited character list from the recruitment pool
- Parameters: ()
- Return: (void)
- Function: assign_to_post
- Description: Assigns character to ministerial position
- Parameters: (String ministerial_postion_key)
- Return: ()
- Function: make_child_of
- Description: Sets character parent (father or mother depending on parent gender)
- Parameters: (MODIFY_CHARACTER_SCRIPT_INTERFACE* parent)
- Return: ()
- Function: assign_faction_leader
- Description: Assign this character as their faction's leader
- Parameters: ()
- Return: ()
- Function: assign_faction_leader_with_regent
- Description: Assign this character as their faction's leader with an option for a regent candiadte
- Parameters: (MODIFY_CHARACTER_SCRIPT_INTERFACE* regent)
- Return: (void)
- Function: family_member
- Description: Returns the modify family member of the character or a NULL_INTERFACE if it doesn't exist.
- Parameters: ()
- Return: (RETURN_OPTIONAL_MODIFY_FAMILY_MEMBER_SCRIPT_INTERFACE)
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_region_manager
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_region_manager
- Description: Returns the query region_manager interface
- Parameters: query_region_manager()
- Return: QUERY_REGION_MANAGER_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_province
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_province
- Description: Returns the query province scripting interface
- Parameters: query_province()
- Return: QUERY_PROVINCE_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_faction_province
- set_public_order
- set_public_order_disabled
- apply_effect_bundle
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_faction_province
- Description: Returns the query faction province scripting interface
- Parameters: query_faction_province()
- Return: QUERY_FACTION_PROVINCE_SCRIPT_INTERFACE
- Function: set_public_order
- Description: Set the public order value for this faction province
- Parameters: set_public_order( value_int )
- Return:
- Function: set_public_order_disabled
- Description: Rnable / Disable public order
- Parameters: set_public_order_disabled( is_disabled_bool )
- Return:
- Function: apply_effect_bundle
- Description: Apply an effect bundle to a province for a number of turns (-1 turns means indefinitely).
- Parameters: apply_effect_bundle("effect_bundle_key", turns)
- Return:
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_region
- apply_effect_bundle
- remove_effect_bundle
- raze_and_abandon_settlement_without_attacking
- settlement_gifted_as_if_by_payload
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_region
- Description: Returns the query region interface
- Parameters: query_region()
- Return: QUERY_REGION_SCRIPT_INTERFACE
- Function: apply_effect_bundle
- Description: Apply an effect bundle to a region for a number of turns (-1 turns means indefinitely).
- Parameters: apply_effect_bundle_to_region("effect_bundle_key", turns)
- Return:
- Function: remove_effect_bundle
- Description: Remove a previously applied effect bundle from a region
- Parameters: remove_effect_bundle_from_region("effect_bundle_key")
- Return:
- Function: raze_and_abandon_settlement_without_attacking
- Description: Set this region to be razed and abandoned
- Parameters: ()
- Return: (bool)
- Function: settlement_gifted_as_if_by_payload
- Description: Transfer this region to another faction. Uses the same path as regions gifted by payload.
- Parameters: (MODIFY_FACTION_SCRIPT_INTERFACE * to_faction)
- Return: (void)
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_garrison_residence
- join_garrison
- leave_garrison
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_garrison_residence
- Description: Returns the query garrison_residence interface
- Parameters: query_garrison_residence()
- Return: QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE
- Function: join_garrison
- Description: Join the garrison residence
- Parameters: join_garrison( query_character_script_interface )
- Return:
- Function: leave_garrison
- Description: Leave the garrison residence
- Parameters: leave_garrison( )
- Return:
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_settlement
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_settlement
- Description: Returns the query settlement interface
- Parameters: query_settlement()
- Return: QUERY_SETTLEMENT_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_slot
- damage_building
- destroy_building
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_slot
- Description: Returns the query slot interface
- Parameters: query_slot()
- Return: QUERY_SLOT_SCRIPT_INTERFACE
- Function: damage_building
- Description: Damage the building in this slow by a set percentage (0-100).
- Parameters: (card32 damage_to_apply)
- Return: (bool)
- Function: destroy_building
- Description: Destroy the building in this slot.
- Parameters: ()
- Return: (bool)
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_building
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_building
- Description: Returns the query building interface
- Parameters: query_building()
- Return: QUERY_BUILDING_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_military_force_slot
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_military_force_slot
- Description: Returns the query military force slot scripting interface
- Parameters: query_military_force_slot()
- Return: QUERY_MILITARY_FORCE_SLOT_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_military_force_building
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_military_force_building
- Description: Returns the query military force building scripting interface
- Parameters: query_military_force_building()
- Return: QUERY_MILITARY_FORCE_BUILDING_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_military_force
- change_stance
- start_mustering
- apply_effect_bundle
- remove_effect_bundle
- set_retreated
- add_existing_character_as_retinue
- force_immediate_construct_siege_item
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_military_force
- Description: Returns the query military_force interface
- Parameters: query_military_force()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- Function: change_stance
- Description: Activate a military force stance
- Parameters: change_stance( "stance " )
- Return:
- Function: start_mustering
- Description: Start or restart mustering for all military force retinues
- Parameters: update_mustering()
- Return:
- Function: apply_effect_bundle
- Description: Apply an effect bundle to military force for number of turns (-1 turns means indefinitely).
- Parameters: apply_effect_bundle("effect_bundle_key", turns)
- Return:
- Function: remove_effect_bundle
- Description: Remove a previously applied effect bundle from military force
- Parameters: remove_effect_bundle("effect_bundle_key")
- Return:
- Function: set_retreated
- Description: Sets the force as having retreated this turn. Meaning they'll be destroyed the next time they lose a battle.
- Parameters: set_retreated()
- Return:
- Function: add_existing_character_as_retinue
- Description: Deploys the given modifying character into the force.
- Parameters: add_existing_character_as_retinue(modify_character, bool create_units_at_max_health)
- Return:
- Function: force_immediate_construct_siege_item
- Description: Force create the specified siege item if the force is besieging a walled settlement.
- Parameters: (String siege_item_key, bool ignore_restrictions)
- Return: (bool)
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- apply_effect_bundle
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: apply_effect_bundle
- Description: Apply an effect bundle to military force for number of turns (-1 turns means indefinitely).
- Parameters: apply_effect_bundle("effect_bundle_key", turns)
- Return:
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_military_force_horde_details
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_military_force_horde_details
- Description: Returns the query military force horde details scripting interface
- Parameters: query_military_force_horde_details()
- Return: QUERY_MILITARY_FORCE_HORDE_DETAILS_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_unit
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_unit
- Description: Returns the query unit interface
- Parameters: query_unit()
- Return: QUERY_UNIT_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- query_pending_battle
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the modify campaign model
- Parameters: model()
- Return: MODIFY_MODEL_SCRIPT_INTERFACE
- Function: query_pending_battle
- Description: Returns the query pending_battle interface
- Parameters: query_pending_battle()
- Return: QUERY_PENDING_BATTLE_SCRIPT_INTERFACE
- Description: DESCRIPTION - TODO
- is_null_interface
- query_campaign_ai
- cai_strategic_stance_manager_block_all_stances_but_that_specified_towards_target_faction
- cai_strategic_stance_manager_promote_specified_stance_towards_target_faction
- cai_strategic_stance_manager_promote_specified_stance_towards_target_faction_by_number
- cai_force_personality_change
- cai_strategic_stance_manager_force_stance_update_between_factions
- cai_strategic_stance_manager_set_stance_promotion_between_factions_for_a_given_stance
- cai_strategic_stance_manager_clear_all_promotions_between_factions
- cai_strategic_stance_manager_set_stance_blocking_between_factions_for_a_given_stance
- cai_strategic_stance_manager_clear_all_blocking_between_factions
- cai_disable_movement_for_character
- cai_disable_movement_for_faction
- cai_enable_movement_for_character
- cai_enable_movement_for_faction
- cai_disable_command_assignment_for_character
- cai_enable_command_assignment_for_character
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_campaign_ai
- Description: Returns the query campaign_ai interface
- Parameters: query_campaign_ai()
- Return: QUERY_CAMPAIGN_AI_SCRIPT_INTERFACE
- Function: cai_strategic_stance_manager_block_all_stances_but_that_specified_towards_target_faction
- Description: Returns the query campaign_ai interface
- Parameters: cai_strategic_stance_manager_block_all_stances_but_that_specified_towards_target_faction("stance_managing_faction_key", "target_faction_key", "stance_type")
- Return:
- Function: cai_strategic_stance_manager_promote_specified_stance_towards_target_faction
- Description: Returns the query campaign_ai interface
- Parameters: cai_strategic_stance_manager_promote_specified_stance_towards_target_faction("stance_managing_faction_key", "target_faction_key", "stance_type")
- Return:
- Function: cai_strategic_stance_manager_promote_specified_stance_towards_target_faction_by_number
- Description: Returns the query campaign_ai interface
- Parameters: cai_strategic_stance_manager_promote_specified_stance_towards_target_faction_by_number("stance_managing_faction_key", "target_faction_key", "stance_type_number")
- Return:
- Function: cai_force_personality_change
- Description: Returns the query campaign_ai interface
- Parameters: cai_force_personality_change("faction_key", "game_phase", "current_quirk_bias")
- Return:
- Function: cai_strategic_stance_manager_force_stance_update_between_factions
- Description: Returns the query campaign_ai interface
- Parameters: cai_strategic_stance_manager_force_stance_update_between_factions("stance_managing_faction_key", "target_faction_key")
- Return:
- Function: cai_strategic_stance_manager_set_stance_promotion_between_factions_for_a_given_stance
- Description: Returns the query campaign_ai interface
- Parameters: cai_strategic_stance_manager_set_stance_promotion_between_factions_for_a_given_stance("stance_managing_faction_key", "target_faction_key", "stance_type_number", "start_round", "start_level", "end_round", "end_level")
- Return:
- Function: cai_strategic_stance_manager_clear_all_promotions_between_factions
- Description: Returns the query campaign_ai interface
- Parameters: cai_strategic_stance_manager_clear_all_promotions_between_factions("stance_managing_faction_key", "target_faction_key")
- Return:
- Function: cai_strategic_stance_manager_set_stance_blocking_between_factions_for_a_given_stance
- Description: Returns the query campaign_ai interface
- Parameters: cai_strategic_stance_manager_set_stance_blocking_between_factions_for_a_given_stance("stance_managing_faction_key", "target_faction_key", "stance_type_number", "final_inclusive_blocking_round")
- Return:
- Function: cai_strategic_stance_manager_clear_all_blocking_between_factions
- Description: Returns the query campaign_ai interface
- Parameters: cai_strategic_stance_manager_clear_all_blocking_between_factions("stance_managing_faction_key", "target_faction_key")
- Return:
- Function: cai_disable_movement_for_character
- Description: Returns the query campaign_ai interface
- Parameters: cai_disable_movement_for_character("faction:f,type:t,ability:a,surname:s,forename:f,garrison:g,x:1,y:2,r:3")
- Return:
- Function: cai_disable_movement_for_faction
- Description: Returns the query campaign_ai interface
- Parameters: cai_disable_movement_for_faction("faction_key")
- Return:
- Function: cai_enable_movement_for_character
- Description: Returns the query campaign_ai interface
- Parameters: cai_enable_movement_for_character("faction:f,type:t,ability:a,surname:s,forename:f,garrison:g,x:1,y:2,r:3")
- Return:
- Function: cai_enable_movement_for_faction
- Description: Returns the query campaign_ai interface
- Parameters: cai_enable_movement_for_faction("faction_key")
- Return:
- Function: cai_disable_command_assignment_for_character
- Description: Returns the query campaign_ai interface
- Parameters: cai_disable_command_assignment_for_character("faction:f,type:t,ability:a,surname:s,forename:f,garrison:g,x:1,y:2,r:3")
- Return:
- Function: cai_enable_command_assignment_for_character
- Description: Returns the query campaign_ai interface
- Parameters: cai_enable_command_assignment_for_character("faction:f,type:t,ability:a,surname:s,forename:f,garrison:g,x:1,y:2,r:3")
- Return:
- Description: Modify Family Member
- is_null_interface
- query_family_member
- divorce_spouse
- marry_character
- marry_random_character
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_family_member
- Description: Returns the query family_member interface
- Parameters: ()
- Return: (RETURN_QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE)
- Function: divorce_spouse
- Description: Divorces this family memebers spouse if they have one
- Parameters: ()
- Return: (void)
- Function: marry_character
- Description: Marry these two characters. Will fail if the characters are already married.
- Parameters: (MODIFY_FAMILY_MEMBER_SCRIPT_INTERFACE* target_character)
- Return: ()
- Function: marry_random_character
- Description: Create a new character and marry them to this one. Will fail if the character is already married.
- Parameters: ()
- Return: ()
- Description: Character's ceo management
- is_null_interface
- query_character_ceo_management
- add_scripted_permission
- remove_scripted_permission
- add_ceo
- remove_ceos
- remove_ceo
- change_points_of_ceos
- apply_trigger
- unequip_slot
- equip_ceo_in_slot
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_character_ceo_management
- Description: Get the query interface
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_CEO_MANAGEMENT_SCRIPT_INTERFACE)
- Function: add_scripted_permission
- Description: Add scripted permissions by key
- Parameters: (String scripted_permission_key)
- Return: (void)
- Function: remove_scripted_permission
- Description: Remove scripted permissions by key
- Parameters: (String scripted_permission_key)
- Return: (void)
- Function: add_ceo
- Description: Add ceo by key
- Parameters: (String ceo_data_key)
- Return: (void)
- Function: remove_ceos
- Description: Remove all ceos with key
- Parameters: (String ceo_data_key)
- Return: (void)
- Function: remove_ceo
- Description: Remove the given ceo
- Parameters: (QUERY_CEO_SCRIPT_INTERFACE* ceo_interface)
- Return: (void)
- Function: change_points_of_ceos
- Description: Change points of all ceos and spawners with ceo key
- Parameters: (String ceo_data_key, int32 change_in_points)
- Return: (void)
- Function: apply_trigger
- Description: Apply trigger to character
- Parameters: (String trigger_key)
- Return: (void)
- Function: unequip_slot
- Description: Unequip current ceo in ceo equipment slot
- Parameters: (QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE * ceo_equipment_slot_interface)
- Return: (void)
- Function: equip_ceo_in_slot
- Description: Equip ceo in ceo equipment slot
- Parameters: (QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE * ceo_equipment_slot_interface, QUERY_CEO_SCRIPT_INTERFACE * ceo_interface)
- Return: (void)
- Description: Faction's ceo management
- is_null_interface
- query_faction_ceo_management
- add_scripted_permission
- remove_scripted_permission
- add_ceo
- remove_ceos
- remove_ceo
- change_points_of_ceos
- apply_trigger
- unequip_slot
- equip_ceo_in_slot
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_faction_ceo_management
- Description: Get the query interface
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_CEO_MANAGEMENT_SCRIPT_INTERFACE)
- Function: add_scripted_permission
- Description: Add scripted permissions by key
- Parameters: (String scripted_permission_key)
- Return: (void)
- Function: remove_scripted_permission
- Description: Remove scripted permissions by key
- Parameters: (String scripted_permission_key)
- Return: (void)
- Function: add_ceo
- Description: Add ceo by key
- Parameters: (String ceo_data_key)
- Return: (void)
- Function: remove_ceos
- Description: Remove all ceos with key
- Parameters: (String ceo_data_key)
- Return: (void)
- Function: remove_ceo
- Description: Remove the given ceo
- Parameters: (QUERY_CEO_SCRIPT_INTERFACE* ceo_interface)
- Return: (void)
- Function: change_points_of_ceos
- Description: Change points of all ceos and spawners with ceo key
- Parameters: (String ceo_data_key, int32 change_in_points)
- Return: (void)
- Function: apply_trigger
- Description: Apply trigger to faction
- Parameters: (String trigger_key)
- Return: (void)
- Function: unequip_slot
- Description: Unequip current ceo in ceo equipment slot
- Parameters: (QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE * ceo_equipment_slot_interface)
- Return: (void)
- Function: equip_ceo_in_slot
- Description: Equip ceo in ceo equipment slot
- Parameters: (QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE * ceo_equipment_slot_interface, QUERY_CEO_SCRIPT_INTERFACE * ceo_interface)
- Return: (void)
- Description: Pooled Resource
- is_null_interface
- query_pooled_resource
- apply_transaction_to_factor
- enable
- disable
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_pooled_resource
- Description: Query interface for this pooled resource
- Parameters: ()
- Return: (RETURN_QUERY_POOLED_RESOURCE_SCRIPT_INTERFACE)
- Function: apply_transaction_to_factor
- Description: Apply a transaction to the specified factor. Returns amount actually applied
- Parameters: (String resource_factor_key, int32 amount)
- Return: (int32)
- Function: enable
- Description: Enable pooled resource effects
- Parameters: ()
- Return: (void)
- Function: disable
- Description: Disable pooled resource effects
- Parameters: ()
- Return: (void)
- Description: Pooled Resource Manager
- is_null_interface
- query_pooled_resource_manager
- resource
- apply_resource_transaction
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_pooled_resource_manager
- Description: Query interface for this pooled resource manager
- Parameters: ()
- Return: (RETURN_QUERY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE)
- Function: resource
- Description: Managed instance of the specified resource, if present
- Parameters: (String resource_key)
- Return: (RETURN_OPTIONAL_MODIFY_POOLED_RESOURCE_SCRIPT_INTERFACE)
- Function: apply_resource_transaction
- Description: Apply the specified resource transaction. Returns true if successful. Must be affordable
- Parameters: (String resource_transaction_key)
- Return: (bool)
- Description: Map Pins Handler
- is_null_interface
- add_character_pin
- add_settlement_pin
- add_terrain_pin
- remove_pin
- remove_all_runtime_script_pins
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: add_character_pin
- Description: Adds a map pin for specified character
- Parameters: (MODIFY_CHARACTER_SCRIPT_INTERFACE* for_character, String map_pins_record_key, bool is_visible)
- Return: (card32)
- Function: add_settlement_pin
- Description: Adds a map pin for specified settlement
- Parameters: (MODIFY_SETTLEMENT_SCRIPT_INTERFACE* for_settlement, String map_pins_record_key, bool is_visible)
- Return: (card32)
- Function: add_terrain_pin
- Description: Adds a map pin on terrain at specified logical position
- Parameters: (card32 at_logical_pos_x, card32 at_logical_pos_y, String map_pins_record_key, bool is_visible)
- Return: (card32)
- Function: remove_pin
- Description: Removes pin from the map
- Parameters: (card32 pin_command_queue_index)
- Return: (void)
- Function: remove_all_runtime_script_pins
- Description: Removes all runtime script pins
- Parameters: ()
- Return: (void)
- Description: Undercover Character
- is_null_interface
- set_cover_points
- apply_source_faction_recall
- apply_source_faction_disown
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: set_cover_points
- Description: Set cover points
- Parameters: (card32 cover_points)
- Return: (void)
- Function: apply_source_faction_recall
- Description: Recall to the source faction
- Parameters: ()
- Return: (void)
- Function: apply_source_faction_disown
- Description: Disown from the source faction
- Parameters: ()
- Return: (void)
- Description: Undercover Character Manager
- is_null_interface
- set_network_points_for_faction
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: set_network_points_for_faction
- Description: Set network points vs a Faction
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE * query_interface, card32 network_points)
- Return: (void)
- Description: Campaign Mission
- is_null_interface
- query_mission
- cancel
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_mission
- Description: Returns the query campaign mission interface
- Parameters: ()
- Return: (RETURN_QUERY_CAMPAIGN_MISSION_SCRIPT_INTERFACE)
- Function: cancel
- Description: Cancel this mission
- Parameters: ()
- Return: (void)
- Description: World Power Tokens
- is_null_interface
- query_world_power_tokens
- transfer
- remove
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: query_world_power_tokens
- Description: Returns the query world power tokens interface
- Parameters: ()
- Return: (RETURN_QUERY_WORLD_POWER_TOKENS_SCRIPT_INTERFACE)
- Function: transfer
- Description: Transfer world power token to new owner
- Parameters: (String token_key, MODIFY_FACTION_SCRIPT_INTERFACE * faction_interface)
- Return: (void)
- Function: remove
- Description: Remove world power token from current owner
- Parameters: (String token_key, MODIFY_FACTION_SCRIPT_INTERFACE * faction_interface)
- Return: (void)
- Description: Shared states manager holds the generic data store we use to store/modify arbitrary state
- is_null_interface
- set_bool_value
- set_float_value
- set_string_value
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: set_bool_value
- Description: Sets the state for the given key to the bool value
- Parameters: (String key, bool value)
- Return: (void)
- Function: set_float_value
- Description: Sets the state for the given key to the float value
- Parameters: (String key, float32 value)
- Return: (void)
- Function: set_string_value
- Description: Sets the state for the given key to the String value
- Parameters: (String key, String value)
- Return: (void)
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- is_new_game
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Description
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: is_new_game
- Description: Description
- Parameters: ()
- Return: (bool)
- Description: Contains entities that exist in the game world. Examples include the region manager and faction list
- is_null_interface
- model
- world_power_tokens
- pooled_resources
- faction_list
- region_manager
- faction_by_key
- province_list
- active_character_list
- character_list
- faction_exists
- climate_phase_index
- whose_turn_is_it
- alliance_list
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Description
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: world_power_tokens
- Description: Returns world power tokens manager
- Parameters: ()
- Return: (RETURN_QUERY_WORLD_POWER_TOKENS_SCRIPT_INTERFACE)
- Function: pooled_resources
- Description: Returns pooled resources manager
- Parameters: ()
- Return: (RETURN_QUERY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE)
- Function: faction_list
- Description: Returns a list interface of all factions
- Parameters: faction_list()
- Return: QUERY_FACTION_LIST_SCRIPT_INTERFACE
- Function: region_manager
- Description: Returns the region manager, which has access to all regions
- Parameters: region_manager()
- Return: QUERY_REGION_MANAGER_SCRIPT_INTERFACE
- Function: faction_by_key
- Description: Returns a faction script interface, by key
- Parameters: faction_by_key("rom_rome")
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: province_list
- Description: Returns the list of all provinces in the world
- Parameters: province_list()
- Return: QUERY_PROVINCE_LIST_SCRIPT_INTERFACE
- Function: active_character_list
- Description: Returns a list interface of all active characters
- Parameters: active_character_list()
- Return: QUERY_CHARACTER_LIST_SCRIPT_INTERFACE
- Function: character_list
- Description: Returns a list interface of all characters that have been spawned in the game (including incative ones)
- Parameters: active_character_list()
- Return: QUERY_CHARACTER_LIST_SCRIPT_INTERFACE
- Function: faction_exists
- Description: Returns if a faction exists in the game, by key
- Parameters: faction_exists("rom_rome")
- Return: bool
- Function: climate_phase_index
- Description: Returns the current climate phase index
- Parameters: climate_phase_index()
- Return: int
- Function: whose_turn_is_it
- Description: Returns a faction script interface for the faction whose turn it currently is
- Parameters: whose_turn_is_it()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: alliance_list
- Description: Get all of the faction's active diplomatic deals
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_ALLIANCE_LIST_SCRIPT_INTERFACE)
- Description: Model is the central access point of the campaign. Everything should be reachable from this interface
- is_null_interface
- episodic_scripting
- world
- pending_battle
- date_in_range
- date_and_week_in_range
- turn_number
- campaign_name
- target_from_effect_bundle_key
- is_multiplayer
- is_player_turn
- character_can_reach_character
- difficulty_level
- local_faction
- campaign_ai
- game_options
- historical_character_manager
- campaign_type
- calendar_year
- season
- is_advisor_sound_playing
- character_for_command_queue_index
- character_for_startpos_id
- character_for_template
- all_characters_for_template
- region_slot_for_command_queue_index
- military_force_for_command_queue_index
- military_force_retinue_for_command_queue_index
- faction_for_command_queue_index
- province_for_command_queue_index
- faction_province_for_command_queue_index_faction_key
- has_character_command_queue_index
- has_military_force_command_queue_index
- has_faction_command_queue_index
- is_benchmark_mode
- campaign_game_mode
- unit_scale_multiplier
- total_faction_armies_in_region
- event_generator_interface
- database
- shared_states_manager
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: episodic_scripting
- Description: Access episodic scripting interface
- Parameters: episodic_scripting()
- Return: QUERY_EPISODIC_SCRIPTING_SCRIPT_INTERFACE
- Function: world
- Description: Access campaign world interface
- Parameters: world()
- Return: QUERY_WORLD_SCRIPT_INTERFACE
- Function: pending_battle
- Description: Access campaign pending battle interface
- Parameters: pending_battle()
- Return: QUERY_PENDING_BATTLE_SCRIPT_INTERFACE
- Function: date_in_range
- Description: Test to see if the current calendar year is within the years specified. start <= current <= end
- Parameters: Start Year, End Year (Inclusive) e.g. date_in_range(1066, 2001)
- Return: bool
- Function: date_and_week_in_range
- Description: Test to see if the current calendar year and week in year is within the years and weeks specified. Week should be 0 <= week < 48. start <= current <= end
- Parameters: Start Week, Start Year, End Week, End Year (Inclusive) e.g. date_and_week_in_range(0, 1066, 47, 2001)
- Return: bool
- Function: turn_number
- Description: Returns the number of the turn currently being taken, starting at 1
- Parameters: turn_number()
- Return: int
- Function: campaign_name
- Description: Returns the campaign name
- Parameters: campaign_name()
- Return: String
- Function: target_from_effect_bundle_key
- Description: Returns a target for an effect bundle
- Parameters: Effect bundle key
- Return: String
- Function: is_multiplayer
- Description: Returns true when in multiplayer campaign
- Parameters: is_multiplayer()
- Return: bool
- Function: is_player_turn
- Description: Is this the players turn?
- Parameters: is_player_turn()
- Return: bool
- Function: character_can_reach_character
- Description: Can a character reach another character this turn?
- Parameters: Two characters e.g. character_can_reach_character(context:character(), context:target_character())
- Return: bool
- Function: difficulty_level
- Description: What is the local faction's difficulty level?
- Parameters: difficulty_level()
- Return: int
- Function: local_faction
- Description: Returns the local faction interface
- Parameters: local_faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: campaign_ai
- Description: Access campaign AI script interface
- Parameters: campaign_ai()
- Return: QUERY_CAMPAIGN_AI_SCRIPT_INTERFACE
- Function: game_options
- Description: Returns the query campaign options interface
- Parameters: game_options()
- Return: QUERY_CAMPAIGN_GAME_OPTIONS_INTERFACE
- Function: historical_character_manager
- Description: Access campaign historical character manager interface
- Parameters: historical_character_manager()
- Return: QUERY_HISTORICAL_CHARACTER_MANAGER_SCRIPT_INTERFACE
- Function: campaign_type
- Description: Returns the type of the campaign
- Parameters: campaign_type()
- Return: card32
- Function: calendar_year
- Description: Returns the current year of the campaign calendar
- Parameters: calendar_year()
- Return: card32
- Function: season
- Description: Returns the current season as a string
- Parameters: season()
- Return: string
- Function: is_advisor_sound_playing
- Description: Is the advisor playing any sound
- Parameters: is_advisor_sound_playing()
- Return: bool
- Function: character_for_command_queue_index
- Description: Returns a QUERY_CHARACTER_SCRIPT_INTERFACE for the cqi
- Parameters: An integer CQI > 0, character_for_command_queue_index(CQI)
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the cqi doesn't exist)
- Function: character_for_startpos_id
- Description: Lookup a character by startpos id
- Parameters: (String startpos_id)
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: character_for_template
- Description: Lookup a character by character generation template
- Parameters: (String character_template)
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: all_characters_for_template
- Description: Receive all characters with specific character generation template
- Parameters: (String character_template)
- Return: (RETURN_QUERY_CHARACTER_LIST_SCRIPT_INTERFACE)
- Function: region_slot_for_command_queue_index
- Description: Lookup a region slot by command queue index
- Parameters: (card32 region_slot_command_queue_index)
- Return: (RETURN_OPTIONAL_QUERY_SLOT_SCRIPT_INTERFACE)
- Function: military_force_for_command_queue_index
- Description: Returns a QUERY_MILITARY_FORCE_SCRIPT_INTERFACE for the cqi
- Parameters: An integer CQI > 0, military_force_for_command_queue_index(CQI)
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the cqi doesn't exist)
- Function: military_force_retinue_for_command_queue_index
- Description: Returns a QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE for the cqi
- Parameters: An integer CQI > 0, military_force_retinue_for_command_queue_index(CQI)
- Return: QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the cqi doesn't exist)
- Function: faction_for_command_queue_index
- Description: Returns a QUERY_FACTION_SCRIPT_INTERFACE for the cqi
- Parameters: An integer CQI > 0, faction_for_command_queue_index(CQI)
- Return: QUERY_FACTION_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the cqi doesn't exist)
- Function: province_for_command_queue_index
- Description: Returns a QUERY_PROVINCE_SCRIPT_INTERFACE for the cqi
- Parameters: An integer CQI > 0, province_for_command_queue_index(CQI)
- Return: QUERY_PROVINCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the cqi doesn't exist)
- Function: faction_province_for_command_queue_index_faction_key
- Description: Returns a QUERY_FACTION_PROVINCE_SCRIPT_INTERFACE for the cqi and faction key
- Parameters: An integer CQI > 0 and a faction key, province_for_command_queue_index(CQI, FactionKey)
- Return: QUERY_FACTION_PROVINCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the cqi doesn't exist or the faction doesn't have a manager in the province)
- Function: has_character_command_queue_index
- Description: Returns true if the cqi exists
- Parameters: An integer CQI > 0, has_character_command_queue_index(CQI)
- Return: bool
- Function: has_military_force_command_queue_index
- Description: Returns true if the cqi exists
- Parameters: An integer CQI > 0, has_military_force_command_queue_index(CQI)
- Return: bool
- Function: has_faction_command_queue_index
- Description: Returns true if the cqi exists
- Parameters: An integer CQI > 0, has_faction_command_queue_index(CQI)
- Return: bool
- Function: is_benchmark_mode
- Description: Query if this campaign is a banchmark test
- Parameters: ()
- Return: (bool)
- Function: campaign_game_mode
- Description: Current Campaign Game Mode
- Parameters: ()
- Return: (String)
- Function: unit_scale_multiplier
- Description: Multiplier for unit scale
- Parameters: ()
- Return: (float32)
- Function: total_faction_armies_in_region
- Description: Multiplier for unit scale
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE* faction, String region_key)
- Return: (int32)
- Function: event_generator_interface
- Description: Event generator interface
- Parameters: ()
- Return: (RETURN_QUERY_EVENT_GENERATOR_SCRIPT_INTERFACE)
- Function: database
- Description: Access for database tables
- Parameters: ()
- Return: (RETURN_DATABASE_SCRIPT_INTERFACE)
- Function: shared_states_manager
- Description: Shared States Manager
- Parameters: ()
- Return: (RETURN_QUERY_SHARED_STATES_MANAGER)
- Description: Faction interface
- is_null_interface
- ceo_management
- command_queue_index
- region_list
- character_list
- military_force_list
- model
- is_human
- name
- capital_region
- faction_leader
- has_faction_leader
- has_capital_region
- trade_value
- trade_value_percent
- number_of_trade_routes
- get_tech_research_cooldown
- treasury
- projected_net_income
- treasury_percent
- losing_money
- tax_level
- upkeep_expenditure_percent
- research_queue_idle
- has_technology
- state_religion
- num_generals
- culture
- subculture
- progression_level
- is_horde
- can_be_horde
- diplomatic_standing_with
- holds_entire_province
- is_vassal
- is_dead
- is_rebel
- pooled_resources
- distance_to_region
- capital_region_distance
- number_of_world_leader_regions
- is_world_leader
- is_at_civil_war
- non_deployable_characters_count
- get_valid_spawn_location_in_region
- get_valid_spawn_location_near
- diplomatic_deal_list
- factions_met
- factions_of_same_culture
- factions_of_same_subculture
- is_quest_battle_faction
- undercover_character_manager
- foreign_undercover_characters_in_faction
- discovered_unresolved_undercover_characters_in_faction
- max_undercover_characters
- faction_province_list
- character_posts
- character_posts_for_opposite_government
- number_of_characters_in_recruitment_pool
- maximum_characters_in_recruitment_pool
- number_of_employed_characters
- can_do_diplomacy
- has_specified_diplomatic_deal_with_anybody
- has_specified_diplomatic_deal_with_as_proposer
- has_specified_diplomatic_deal_with_as_recipient
- has_specified_diplomatic_deal_with
- number_of_factions_we_have_specified_diplomatic_deal_with
- factions_we_have_specified_diplomatic_deal_with
- factions_we_have_specified_diplomatic_deal_with_directional
- can_apply_automatic_diplomatic_deal
- has_effect_bundle
- can_make_confederation_with
- is_mission_active
- has_mission_been_issued
- num_progression_levels
- max_progression_level
- min_progression_level
- progression_level_key_for_level
- progression_level_key
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: ceo_management
- Description: The ceo management for a faction. Can be null if the faction doesn't support ceos
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_CEO_MANAGEMENT_SCRIPT_INTERFACE)
- Function: command_queue_index
- Description: Command queue index of the Faction
- Parameters: command_queue_index()
- Return: int
- Function: region_list
- Description: A list of regions owned by the faction
- Parameters: region_list()
- Return: QUERY_REGION_LIST_SCRIPT_INTERFACE
- Function: character_list
- Description: All characters in this faction
- Parameters: character_list()
- Return: QUERY_CHARACTER_LIST_SCRIPT_INTERFACE
- Function: military_force_list
- Description: All military forces in this faction
- Parameters: military_force_list()
- Return: QUERY_MILITARY_FORCE_LIST_SCRIPT_INTERFACE
- Function: model
- Description: Access to the campaign model interface
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: is_human
- Description: Is this a human faction?
- Parameters: is_human()
- Return: bool
- Function: name
- Description: The faction's name
- Parameters: name()
- Return: string
- Function: capital_region
- Description: Faction's capital region
- Parameters: capital_region()
- Return: QUERY_REGION_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the faction has no capital region)
- Function: faction_leader
- Description: The character that leads the faction
- Parameters: faction_leader()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the faction has no faction leader
- Function: has_faction_leader
- Description: Does the faction have a leader?
- Parameters: has_faction_leader()
- Return: bool
- Function: has_capital_region
- Description: Does the faction have a capital region?
- Parameters: has_capital_region()
- Return: bool
- Function: trade_value
- Description: Returns the absolute value of the factions global trade
- Parameters: ()
- Return: (card32)
- Function: trade_value_percent
- Description: Returns the percentage value of global trade owned by the faction
- Parameters: ()
- Return: (card32)
- Function: number_of_trade_routes
- Description: Returns the absolute value of the factions global trade
- Parameters: ()
- Return: (card32)
- Function: get_tech_research_cooldown
- Description: Returns the current cooldown turns remaining on tech research
- Parameters: ()
- Return: (card32)
- Function: treasury
- Description: Returns the factions treasury value
- Parameters: treasury()
- Return: int
- Function: projected_net_income
- Description: The projected change in income
- Parameters: ()
- Return: (int32)
- Function: treasury_percent
- Description: Returns the factions treasury value as a percentage of the sum of all factions treasury values
- Parameters: treasury_percent()
- Return: int
- Function: losing_money
- Description: Returns whether or not the factions regular expenditure exceeds their regular income
- Parameters: losing_money()
- Return: bool
- Function: tax_level
- Description: Returns the average tax level for the faction
- Parameters: tax_level()
- Return: int
- Function: upkeep_expenditure_percent
- Description: Returns the average tax level for the faction
- Parameters: upkeep_expenditure_percent()
- Return: int
- Function: research_queue_idle
- Description: Is faction not researching any tech even though they could be
- Parameters: research_queue_idle()
- Return: bool
- Function: has_technology
- Description: Does the characters faction have the specified technology
- Parameters: has_technology("beer")
- Return: bool
- Function: state_religion
- Description: Returns the state religion of the faction
- Parameters: state_religion()
- Return: string
- Function: num_generals
- Description: How many generals does this faction have?
- Parameters: num_generals()
- Return: int
- Function: culture
- Description: Returns the culture for the faction
- Parameters: culture()
- Return: string
- Function: subculture
- Description: Returns the subculture for the faction
- Parameters: subculture()
- Return: string
- Function: progression_level
- Description: returns the current progression level
- Parameters: progression_level();
- Return: card32
- Function: is_horde
- Description: return weather the faction is currently a horde
- Parameters: is_horde()
- Return: bool
- Function: can_be_horde
- Description: return weather the faction can become a horde
- Parameters: can_be_horde()
- Return: bool
- Function: diplomatic_standing_with
- Description: return the factions diplomatic standing with the specified faction
- Parameters: diplomatic_standing_with( FACTION_QUERY_INTERFACE )
- Return: int32
- Function: holds_entire_province
- Description: Does this faction hold the entire specified province? Also may include vassals
- Parameters: holds_entire_province(String province, bool include_vassals)
- Return: bool
- Function: is_vassal
- Description: Is this faction a vassel
- Parameters: is_vassal()
- Return: bool
- Function: is_dead
- Description: Returns true if the faction is dead
- Parameters: is_dead()
- Return: bool
- Function: is_rebel
- Description: Returns true if the faction is rebel one
- Parameters: is_rebel()
- Return: bool
- Function: pooled_resources
- Description: Pooled resource manager for this faction
- Parameters: pooled_resources()
- Return: QUERY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE
- Function: distance_to_region
- Description: Returns number of regions needed to reach the specified target region (shortest path starting from the capital)
- Parameters: (QUERY_REGION_SCRIPT_INTERFACE* target_region)
- Return: (int)
- Function: capital_region_distance
- Description: Returns number of regions needed to reach the specified target region (shortest path starting from the capital)
- Parameters: (QUERY_REGION_SCRIPT_INTERFACE* target_region)
- Return: (int)
- Function: number_of_world_leader_regions
- Description: Returns the number of world leader region count
- Parameters: ()
- Return: (card32)
- Function: is_world_leader
- Description: Returns if this faction is a world leader or not
- Parameters: ()
- Return: (bool)
- Function: is_at_civil_war
- Description: Returns if this faction is at civil war or not
- Parameters: ()
- Return: (bool)
- Function: non_deployable_characters_count
- Description: Returns the number of non-deployable characters
- Parameters: ()
- Return: (int32)
- Function: get_valid_spawn_location_in_region
- Description: Get a valid spawn location for characters of this faction in region specified by region_key,ignore_zoc == true means that the position can be inside zoc, the bool in the tuple is true if a position was found and false otherwise
- Parameters: (String region_key, bool ignore_zoc)
- Return: (std::tuple)
- Function: get_valid_spawn_location_near
- Description: Get a valid spawn location for characters of this faction near specified position (x, y) at a preferred distance,ignore_zoc == true means that the position can be inside zoc, the bool in the tuple is true if a position was found and false otherwise
- Parameters: (card32 x, card32 y, card32 preferred_distance, bool ignore_zoc)
- Return: (std::tuple)
- Function: diplomatic_deal_list
- Description: Get all of the faction's active diplomatic deals
- Parameters: ()
- Return: (RETURN_QUERY_DIPLOMACY_DEAL_LIST_SCRIPT_INTERFACE)
- Function: factions_met
- Description: return the factions this faction has met
- Parameters: factions_met()
- Return: QUERY_FACTION_LIST_SCRIPT_INTERFACE
- Function: factions_of_same_culture
- Description: return the factions with the same culture as this faction
- Parameters: factions_of_same_culture()
- Return: QUERY_FACTION_LIST_SCRIPT_INTERFACE
- Function: factions_of_same_subculture
- Description: return the factions with the same subculture as this faction
- Parameters: factions_of_same_subculture()
- Return: QUERY_FACTION_LIST_SCRIPT_INTERFACE
- Function: is_quest_battle_faction
- Description: is this faction a quest battle faction
- Parameters: is_quest_battle_faction()
- Return: bool
- Function: undercover_character_manager
- Description: Undercover Character Manager for Faction, optional
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_UNDERCOVER_CHARACTER_MANAGER_SCRIPT_INTERFACE)
- Function: foreign_undercover_characters_in_faction
- Description: Foreign undercover characters in this faction
- Parameters: ()
- Return: (RETURN_QUERY_UNDERCOVER_CHARACTER_LIST_SCRIPT_INTERFACE)
- Function: discovered_unresolved_undercover_characters_in_faction
- Description: Discovered foreign undercover characters waiting to be resolved
- Parameters: ()
- Return: (RETURN_QUERY_UNDERCOVER_CHARACTER_LIST_SCRIPT_INTERFACE)
- Function: max_undercover_characters
- Description: The manimum number of spies the faction can have.
- Parameters: ()
- Return: (card32)
- Function: faction_province_list
- Description: Returns all faction provinces associated with the current faction
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_PROVINCE_LIST_SCRIPT_INTERFACE)
- Function: character_posts
- Description: Returns all character posts in the faction government
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_POST_LIST_SCRIPT_INTERFACE)
- Function: character_posts_for_opposite_government
- Description: Returns all character posts that will be used when the faction transitions to/from empire
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_POST_LIST_SCRIPT_INTERFACE)
- Function: number_of_characters_in_recruitment_pool
- Description: Number of characters currently in this factions recruitment pool (including locked characters)
- Parameters: ()
- Return: (card32)
- Function: maximum_characters_in_recruitment_pool
- Description: Maximum number of characters that can ever be in this factions recruitment pool
- Parameters: ()
- Return: (card32)
- Function: number_of_employed_characters
- Description: Number of characters currently employed by this faction. Excluding temporary commanders
- Parameters: ()
- Return: (card32)
- Function: can_do_diplomacy
- Description: Can this faction perform diplomacy
- Parameters: ()
- Return: (bool)
- Function: has_specified_diplomatic_deal_with_anybody
- Description: Do we have the specified diplomatic deal with anybody?
- Parameters: (String component_key)
- Return: (bool)
- Function: has_specified_diplomatic_deal_with_as_proposer
- Description: Do we have the specified diplomatic deal with a specified faction where we are the proposer?
- Parameters: (String component_key, QUERY_FACTION_SCRIPT_INTERFACE* other_faction_interface)
- Return: (bool)
- Function: has_specified_diplomatic_deal_with_as_recipient
- Description: Do we have the specified diplomatic deal with a specified faction where we are the recipient?
- Parameters: (String component_key, QUERY_FACTION_SCRIPT_INTERFACE* other_faction_interface)
- Return: (bool)
- Function: has_specified_diplomatic_deal_with
- Description: Do we have the specified diplomatic deal with a specified faction?
- Parameters: (String component_key, QUERY_FACTION_SCRIPT_INTERFACE * other_faction_interface)
- Return: (bool)
- Function: number_of_factions_we_have_specified_diplomatic_deal_with
- Description: How many factions do we have the specified diplomatic deal with?
- Parameters: (String component_key)
- Return: (card32)
- Function: factions_we_have_specified_diplomatic_deal_with
- Description: Returns the factions we have the specified diplomatic deal with
- Parameters: (String component_key)
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Function: factions_we_have_specified_diplomatic_deal_with_directional
- Description: Returns the factions we have the specified diplomatic deal with that match the specified direction
- Parameters: (String component_key, bool is_proposer)
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Function: can_apply_automatic_diplomatic_deal
- Description: Check if an automatic diplomatic deal can be applied. automatic_deal_key is a campaign_diplomacy_automatic_deal key. other_faction_interface is an interface to another faction. parameters is a comma separated list of parameters where each parameter can be of the form 'alliance_cqi:xxx', 'alliance_oath_key:xxx', 'ceo_cqi:xxx', 'deal_cqi:xxx', 'faction_cqi:xxx', 'faction_key:xxx', 'character_cqi:xxx', 'region_cqi:xxx' or 'region_key:xxx'.
- Parameters: (String automatic_deal_key, QUERY_FACTION_SCRIPT_INTERFACE * other_faction_interface, String parameters)
- Return: (bool)
- Function: has_effect_bundle
- Description: Returns true if the faction has the given effect bundle
- Parameters: has_effect_bundle()
- Return: bool
- Function: can_make_confederation_with
- Description: Can we confederate this faction
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE * other_faction_interface)
- Return: (bool)
- Function: is_mission_active
- Description: Is the given mission key active in the mission manager.
- Parameters: (String mission_key)
- Return: (bool)
- Function: has_mission_been_issued
- Description: Has the given mission key ever been issued in the mission manager.
- Parameters: (String mission_key)
- Return: (bool)
- Function: num_progression_levels
- Description: Returns how many progression levels this faction has.
- Parameters: ()
- Return: (int32)
- Function: max_progression_level
- Description: Get the index of the highest progression level available.
- Parameters: ()
- Return: (int32)
- Function: min_progression_level
- Description: Get the index of the lowest progression level available.
- Parameters: ()
- Return: (int32)
- Function: progression_level_key_for_level
- Description: Get the key of the progression level for the specified progression_level index.
- Parameters: (int32 level)
- Return: (String)
- Function: progression_level_key
- Description: Get the key of the progression level for the current progression_level.
- Parameters: ()
- Return: (String)
- Description: A list of faction interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Persistent retinue
- is_null_interface
- campaign_model
- command_queue_index
- retinue_slots
- retinue_commander
- linked_to_military_force_retinue
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: campaign_model
- Description:
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: command_queue_index
- Description:
- Parameters: ()
- Return: (card32)
- Function: retinue_slots
- Description: List of slots in the retinue
- Parameters: ()
- Return: (RETURN_QUERY_PERSISTENT_RETINUE_SLOT_LIST_SCRIPT_INTERFACE)
- Function: retinue_commander
- Description: Optional Retinue Commander. Character retinues will probably have one, non character retinues will not.
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: linked_to_military_force_retinue
- Description: Optional Military Force Retinue. If this Retinue exists on the map, this is the Retinue it is linked to
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE)
- Description: Persistent retinue slot
- is_null_interface
- campaign_model
- command_queue_index
- owning_retinue
- slot_index
- slot_unit_record_key
- retinue_slot_commander
- linked_to_military_force_retinue_slot
- recruitment_interface
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: campaign_model
- Description:
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: command_queue_index
- Description:
- Parameters: ()
- Return: (card32)
- Function: owning_retinue
- Description: Part of this Persistent Retinue
- Parameters: ()
- Return: (RETURN_QUERY_PERSISTENT_RETINUE_SCRIPT_INTERFACE)
- Function: slot_index
- Description: Index of the slot in the owning Persistent Retinue
- Parameters: ()
- Return: (card32)
- Function: slot_unit_record_key
- Description: Key of the unit in the slot
- Parameters: ()
- Return: (String)
- Function: retinue_slot_commander
- Description: Optional slot commander.
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: linked_to_military_force_retinue_slot
- Description: Optional Military Force Retinue Slot. If this Retinue slot exists on the map, this is the Retinue slot it is linked to
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_MILITARY_FORCE_RETINUE_SLOT_SCRIPT_INTERFACE)
- Function: recruitment_interface
- Description: Optional link to slot recruitment. Not all slots are able to recruit.
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_PERSISTENT_RETINUE_SLOT_RECRUITMENT_SCRIPT_INTERFACE)
- Description: A list of persistent retinue slots
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_PERSISTENT_RETINUE_SLOT_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Persistent retinue slot recruitment
- is_null_interface
- campaign_model
- is_recruiting
- recruiting_unit_key
- can_recruit
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: campaign_model
- Description:
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: is_recruiting
- Description: Is the slot recruiting
- Parameters: ()
- Return: (bool)
- Function: recruiting_unit_key
- Description: If the slot is recruiting, what is the unit key being recruited
- Parameters: ()
- Return: (String)
- Function: can_recruit
- Description: Can the slot recruit a unit?
- Parameters: ()
- Return: (bool)
- Description: Character interface
- is_null_interface
- command_queue_index
- has_garrison_residence
- has_region
- has_military_force
- owned_persistent_retinue
- commanded_persistent_retinue
- commanded_resistent_retinue_slot
- commanded_military_force_retinue
- commanded_military_force_retinue_slot
- ceo_management
- model
- garrison_residence
- faction
- region
- military_force
- get_forename
- get_surname
- in_settlement
- in_port
- is_besieging
- is_blockading
- is_carrying_troops
- character_type
- character_subtype
- battles_fought
- action_points_remaining_percent
- action_points_per_turn
- is_male
- age
- performed_action_this_turn
- is_ambushing
- turns_at_sea
- turns_in_own_regions
- turns_in_enemy_regions
- is_faction_leader
- rank
- defensive_sieges_fought
- defensive_sieges_won
- offensive_sieges_fought
- offensive_sieges_won
- fought_in_battle
- won_battle
- percentage_of_own_alliance_killed
- logical_position_x
- logical_position_y
- display_position_x
- display_position_y
- battles_won
- offensive_battles_won
- offensive_battles_fought
- defensive_battles_won
- defensive_battles_fought
- offensive_naval_battles_won
- offensive_naval_battles_fought
- defensive_naval_battles_won
- defensive_naval_battles_fought
- offensive_ambush_battles_won
- offensive_ambush_battles_fought
- defensive_ambush_battles_won
- defensive_ambush_battles_fought
- cqi
- is_embedded_in_military_force
- has_skill
- is_hidden
- routed_in_battle
- body_guard_casulties
- is_deployed
- is_at_sea
- is_wounded
- has_recruited_mercenaries
- loyalty
- gravitas
- has_father
- has_mother
- mother
- father
- family_member
- is_politician
- post_battle_ceo_chance
- is_caster
- is_visible_to_faction
- is_spy
- is_dead
- distance_to_region
- current_experience
- character_subtype_key
- startpos_key
- latest_wound_death_type
- get_is_deployable
- generation_template_key
- is_character_is_faction_recruitment_pool
- is_character_in_faction_recruited_characters
- has_undercover_character_enabler
- undercover_character_links
- character_post
- active_assignment
- relationships
- get_current_attribute_value
- get_max_attribute_value
- get_min_attribute_value
- has_effect_bundle
- is_in_own_territory
- has_come_of_age
- rounds_in_current_faction
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: command_queue_index
- Description: Command queue index of the Character
- Parameters: command_queue_index()
- Return: int
- Function: has_garrison_residence
- Description: Is the character contained in a garrison residence?
- Parameters: has_garrison_residence()
- Return: bool
- Function: has_region
- Description: Is the character in a valid region?
- Parameters: has_region()
- Return: bool
- Function: has_military_force
- Description: Does this character command a military force?
- Parameters: has_military_force()
- Return: bool
- Function: owned_persistent_retinue
- Description: Persistent retinue owned by the character
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_PERSISTENT_RETINUE_SCRIPT_INTERFACE)
- Function: commanded_persistent_retinue
- Description: The persistent retinue the character is commanding
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_PERSISTENT_RETINUE_SCRIPT_INTERFACE)
- Function: commanded_resistent_retinue_slot
- Description: The persistent retinue slot the character is commanding
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_PERSISTENT_RETINUE_SLOT_SCRIPT_INTERFACE)
- Function: commanded_military_force_retinue
- Description: The military force retinue this character is commanding
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE)
- Function: commanded_military_force_retinue_slot
- Description: The military force retinue slot this character is commanding
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_MILITARY_FORCE_RETINUE_SLOT_SCRIPT_INTERFACE)
- Function: ceo_management
- Description: The ceo management for a chacater. Can be null if the character doesn't support ceos
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_CEO_MANAGEMENT_SCRIPT_INTERFACE)
- Function: model
- Description: Access to the model interface
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: garrison_residence
- Description: The garrison containing the character
- Parameters: garrison_residence()
- Return: QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the character is not contained)
- Function: faction
- Description: Access to the character's faction interface
- Parameters: faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: region
- Description: Access to the region that the character is in
- Parameters: region()
- Return: QUERY_REGION_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the character is not in a valid region)
- Function: military_force
- Description: The military force that the character commands
- Parameters: military_force()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the character is not commanding a military force)
- Function: get_forename
- Description: Returns the character forename
- Parameters: get_forename()
- Return: string
- Function: get_surname
- Description: Returns the character surname
- Parameters: get_surname()
- Return: string
- Function: in_settlement
- Description: Checks that a character is in a settlement
- Parameters: in_settlement()
- Return: bool
- Function: in_port
- Description: Is the character in a port?
- Parameters: in_port()
- Return: bool
- Function: is_besieging
- Description: Is the character besieging?
- Parameters: is_besieging()
- Return: bool
- Function: is_blockading
- Description: Is the character blockading?
- Parameters: is_blockading()
- Return: bool
- Function: is_carrying_troops
- Description: Is the character transporting an army?
- Parameters: is_carrying_troops()
- Return: bool
- Function: character_type
- Description: Returns true if the character context is of the agent type specified
- Parameters: Key from agents table, e.g. character_type("ninja")
- Return: bool
- Function: character_subtype
- Description: Returns true if the character context is of the agent subtype specified
- Parameters: Key from agent subtypes table, e.g. character_subtype("emp_celestial_wizard")
- Return: bool
- Function: battles_fought
- Description: How many battles has this character fought in?
- Parameters: battles_fought()
- Return: int
- Function: action_points_remaining_percent
- Description: Returns the percentage of movement points remaining as an integer value
- Parameters: action_points_remaining_percent() < 50
- Return: int
- Function: action_points_per_turn
- Description: Action points per turn
- Parameters: action_points_per_turn()
- Return: int
- Function: is_male
- Description: Is the character male?
- Parameters: is_male()
- Return: bool
- Function: age
- Description: The character's age
- Parameters: age()
- Return: int
- Function: performed_action_this_turn
- Description: Has the character performed any action this turn?
- Parameters: performed_action_this_turn()
- Return: bool
- Function: is_ambushing
- Description: Is the character ambushing?
- Parameters: is_ambushing()
- Return: bool
- Function: turns_at_sea
- Description: Returns the number of turns at sea exclusively
- Parameters: turns_at_sea()
- Return: int
- Function: turns_in_own_regions
- Description: Returns the number of turns in home regions exclusively
- Parameters: turns_in_own_regions()
- Return: int
- Function: turns_in_enemy_regions
- Description: Returns the number of turns in enemy regions exclusively
- Parameters: turns_in_enemy_regions()
- Return: int
- Function: is_faction_leader
- Description: Is the character the faction leader?
- Parameters: is_faction_leader()
- Return: bool
- Function: rank
- Description: Rank of character (1-6)
- Parameters: rank()
- Return: int
- Function: defensive_sieges_fought
- Description: Number of defensive sieges fought
- Parameters: defensive_sieges_fought()
- Return: int
- Function: defensive_sieges_won
- Description: Number of defensive sieges won
- Parameters: defensive_sieges_won()
- Return: int
- Function: offensive_sieges_fought
- Description: Number of offensive sieges fought
- Parameters: offensive_sieges_fought()
- Return: int
- Function: offensive_sieges_won
- Description: Number of offensive sieges won
- Parameters: offensive_sieges_won()
- Return: int
- Function: fought_in_battle
- Description: Did the character fight in missile or melee combat in the battle
- Parameters: fought_in_battle()
- Return: bool
- Function: won_battle
- Description: Was the character in the winning alliance in a battle
- Parameters: won_battle()
- Return: bool
- Function: percentage_of_own_alliance_killed
- Description: Percentage of men killed in the character's alliance
- Parameters: percentage_of_own_alliance_killed()
- Return: int
- Function: logical_position_x
- Description: Logical position on map, x coord
- Parameters: logical_position_x()
- Return: int
- Function: logical_position_y
- Description: Logical position on map, y coord
- Parameters: logical_position_y()
- Return: int
- Function: display_position_x
- Description: Display/real position on map, x coord
- Parameters: display_position_x()
- Return: float
- Function: display_position_y
- Description: Display/real position on map, y coord
- Parameters: display_position_y()
- Return: float
- Function: battles_won
- Description: Number of battles won
- Parameters: battles_won()
- Return: card32
- Function: offensive_battles_won
- Description: Number of offensive battles won
- Parameters: offensive_battles_won()
- Return: card32
- Function: offensive_battles_fought
- Description: Number of offensive battles fought
- Parameters: offensive_battles_fought()
- Return: card32
- Function: defensive_battles_won
- Description: Number of defensive battles won
- Parameters: defensive_battles_won()
- Return: card32
- Function: defensive_battles_fought
- Description: Number of defensive battles fought
- Parameters: defensive_battles_fought()
- Return: card32
- Function: offensive_naval_battles_won
- Description: Number of offensive naval battles won
- Parameters: offensive_naval_battles_won()
- Return: card32
- Function: offensive_naval_battles_fought
- Description: Number of offensive naval battles fought
- Parameters: offensive_naval_battles_fought()
- Return: card32
- Function: defensive_naval_battles_won
- Description: Number of defensive naval battles won
- Parameters: defensive_naval_battles_won()
- Return: card32
- Function: defensive_naval_battles_fought
- Description: Number of defensive naval battles fought
- Parameters: defensive_naval_battles_fought()
- Return: card32
- Function: offensive_ambush_battles_won
- Description: Number of offensive ambush battles won
- Parameters: offensive_ambush_battles_won()
- Return: card32
- Function: offensive_ambush_battles_fought
- Description: Number of offensive ambush battles fought
- Parameters: offensive_ambush_battles_fought()
- Return: card32
- Function: defensive_ambush_battles_won
- Description: Number of defensive ambush battles won
- Parameters: defensive_ambush_battles_won()
- Return: card32
- Function: defensive_ambush_battles_fought
- Description: Number of defensive ambush battles fought
- Parameters: defensive_ambush_battles_fought()
- Return: card32
- Function: cqi
- Description: Character CQI
- Parameters: cqi()
- Return: card32
- Function: is_embedded_in_military_force
- Description: Is part of a military force
- Parameters: is_embedded_in_military_force()
- Return: bool
- Function: has_skill
- Description: Has the skill passed
- Parameters: has_skill()
- Return: bool
- Function: is_hidden
- Description: Is the character hidden from a faction
- Parameters: is_hidden()
- Return: bool
- Function: routed_in_battle
- Description: The commander routed
- Parameters: routed_in_battle()
- Return: bool
- Function: body_guard_casulties
- Description: Percentage of commanded unit lost in battle
- Parameters: body_guard_casulties()
- Return: float32
- Function: is_deployed
- Description: Is the character deployed
- Parameters: is_deployed()
- Return: bool
- Function: is_at_sea
- Description: Is the character at sea
- Parameters: is_at_sea()
- Return: bool
- Function: is_wounded
- Description: return true if this character is wounded
- Parameters: is_wounded()
- Return: bool
- Function: has_recruited_mercenaries
- Description: Has the character recruited mercenaries
- Parameters: has_recruited_mercenaries()
- Return: bool
- Function: loyalty
- Description: returns the characters loyalty
- Parameters: loyalty()
- Return: int32
- Function: gravitas
- Description: returns the characters gravitas
- Parameters: gravitas()
- Return: card32
- Function: has_father
- Description: returns whether a character has a father or not
- Parameters: has_father()
- Return: bool
- Function: has_mother
- Description: returns whether a character has a mother or not
- Parameters: has_mother()
- Return: bool
- Function: mother
- Description: returns a character mother's family member script interface
- Parameters: mother()
- Return: QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE
- Function: father
- Description: returns a characters father's family member script interface
- Parameters: father()
- Return: QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE
- Function: family_member
- Description: returns a characters family member script interface
- Parameters: family_member()
- Return: QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE
- Function: is_politician
- Description: returns whether a character is a politian or not
- Parameters: is_politician()
- Return: bool
- Function: post_battle_ceo_chance
- Description: returns a mod on the drop chance for post battle ceo
- Parameters: post_battle_ceo_chance()
- Return: float32
- Function: is_caster
- Description: returns true if the character is a caster
- Parameters: is_caster()
- Return: bool
- Function: is_visible_to_faction
- Description: returns true if this character is visible to the specified faction
- Parameters: is_visible_to_faction("faction")
- Return: bool
- Function: is_spy
- Description: returns true if this character is a spy
- Parameters: is_spy()
- Return: bool
- Function: is_dead
- Description: returns true if this character is dead
- Parameters: is_dead()
- Return: bool
- Function: distance_to_region
- Description: Returns number of regions needed to reach the specified target region (shortest path starting from the capital)
- Parameters: (QUERY_REGION_SCRIPT_INTERFACE* target_region)
- Return: (int)
- Function: current_experience
- Description: Returns the current experience points
- Parameters: ()
- Return: (int)
- Function: character_subtype_key
- Description: Character Agent Subtype Record Key
- Parameters: ()
- Return: (String)
- Function: startpos_key
- Description: Character Startpos Key. Empty if it doesn't have one
- Parameters: ()
- Return: (String)
- Function: latest_wound_death_type
- Description: Death type of the latest wound the character received. Empty if it doesn't have one
- Parameters: ()
- Return: (String)
- Function: get_is_deployable
- Description: See if the character can be deployed as a general
- Parameters: ()
- Return: (bool)
- Function: generation_template_key
- Description: Character Generation Template Key
- Parameters: ()
- Return: (String)
- Function: is_character_is_faction_recruitment_pool
- Description: Is the character in the faction recruitment pool (not actively hired by the faction)
- Parameters: ()
- Return: (bool)
- Function: is_character_in_faction_recruited_characters
- Description: Is the character in the recruit characters list (currently hired by the faction)
- Parameters: ()
- Return: (bool)
- Function: has_undercover_character_enabler
- Description: Does the character have the enabler to be an undercover character?
- Parameters: ()
- Return: (bool)
- Function: undercover_character_links
- Description: Undercover Character links for character
- Parameters: ()
- Return: (RETURN_QUERY_UNDERCOVER_CHARACTER_LIST_SCRIPT_INTERFACE)
- Function: character_post
- Description: Post occupied by this character. May be null
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_POST_SCRIPT_INTERFACE)
- Function: active_assignment
- Description: Current assignment this character is on
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_ASSIGNMENT_SCRIPT_INTERFACE)
- Function: relationships
- Description: All relationships this character has. May be empty
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_RELATIONSHIP_LIST_SCRIPT_INTERFACE)
- Function: get_current_attribute_value
- Description: Returns the attribute value if present otherwise 0
- Parameters: (String attribute_type_record_key)
- Return: (int32)
- Function: get_max_attribute_value
- Description: Returns the max attribute value if present otherwise 0
- Parameters: (String attribute_type_record_key)
- Return: (int32)
- Function: get_min_attribute_value
- Description: Returns the min attribute value if present otherwise 0
- Parameters: (String attribute_type_record_key)
- Return: (int32)
- Function: has_effect_bundle
- Description: Returns true if the character has the given effect bundle
- Parameters: has_effect_bundle()
- Return: bool
- Function: is_in_own_territory
- Description: Is the character within their factions territory?
- Parameters: ()
- Return: (bool)
- Function: has_come_of_age
- Description: Has the character come of age and is considered an adult?
- Parameters: ()
- Return: (bool)
- Function: rounds_in_current_faction
- Description: How many turns has the character been in their current faction? Note, only works for adult characters! Children return 0.
- Parameters: ()
- Return: (card32)
- Description: A list of character interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Family interface
- is_null_interface
- has_father
- has_mother
- has_spouse
- father
- mother
- spouse
- come_of_age
- is_pregnant
- character
- is_in_faction_leaders_family
- is_in_the_same_family
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: has_father
- Description: returns if this family member has a father
- Parameters: has_father()
- Return: bool
- Function: has_mother
- Description: returns if this family member has a mother
- Parameters: has_mother()
- Return: bool
- Function: has_spouse
- Description: Does this character have a spouse?
- Parameters: ()
- Return: (bool)
- Function: father
- Description: returns if this family members father
- Parameters: father()
- Return: QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE
- Function: mother
- Description: returns if this family member has a mother
- Parameters: mother()
- Return: QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE
- Function: spouse
- Description: Spouse of this family member
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE)
- Function: come_of_age
- Description: return if the character has come of age
- Parameters: come_of_age()
- Return: bool
- Function: is_pregnant
- Description: Is this character pregnant?
- Parameters: ()
- Return: (bool)
- Function: character
- Description: Access to the character object of this family member
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: is_in_faction_leaders_family
- Description: Check if the character is related to the faction leader.
- Parameters: ()
- Return: (bool)
- Function: is_in_the_same_family
- Description: Check if this character is related to the other specified character.
- Parameters: (QUERY_FAMILY_MEMBER_SCRIPT_INTERFACE* other_character)
- Return: (bool)
- Description: The interface that stores and manages all regions in the game. Useful for looking up region and slot//settlement keys.
- is_null_interface
- model
- region_list
- region_by_key
- settlement_by_key
- slot_by_key
- resource_exists_anywhere
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Access to the model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: region_list
- Description: A list of all regions
- Parameters: region_list()
- Return: QUERY_REGION_LIST_SCRIPT_INTERFACE
- Function: region_by_key
- Description: Returns the region interface for a given region key
- Parameters: input a region key string e.g. region_by_key("jap_tosa")
- Return: QUERY_REGION_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the region key is invalid)
- Function: settlement_by_key
- Description: Returns the settlement interface for a given settlement key
- Parameters: input a settlement key string e.g. settlement_by_key("settlement:jap_aki:koriyama")
- Return: QUERY_SETTLEMENT_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the settlement key is invalid)
- Function: slot_by_key
- Description: Returns the slot interface for a given slot key
- Parameters: input a slot key string e.g. slot_by_key("rice:jap_awa:farm")
- Return: QUERY_SLOT_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the slot key is invalid)
- Function: resource_exists_anywhere
- Description: Are any regions producing this resource?
- Parameters: input a resource key e.g. resource_exists_anywhere("res_coffee")
- Return: bool. It will also return false if the resource key is invalid.
- Description: DESCRIPTION - TODO
- is_null_interface
- cqi
- model
- faction_province_list
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: cqi
- Description: Returns the cqi of the province
- Parameters: cqi()
- Return: card32
- Function: model
- Description: Returns the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: faction_province_list
- Description: Returns the list of faction provinces in the province
- Parameters: faction_province_list()
- Return: QUERY_FACTION_PROVINCE_LIST_SCRIPT_INTERFACE
- Description: A list of province interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_PROVINCE_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: The collection of regions in a province owned by the same faction
- is_null_interface
- model
- province
- region_list
- pooled_resources
- tax_administration_cost
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: province
- Description: The province the faction provicne is part of
- Parameters: province()
- Return: QUERY_PROVINCE_SCRIPT_INTERFACE
- Function: region_list
- Description: The list of regions owned by the faction in the province
- Parameters: region_list()
- Return: QUERY_REGION_LIST_SCRIPT_INTERFACE
- Function: pooled_resources
- Description: Pooled resource manager attached to this faction province
- Parameters: pooled_resources()
- Return: QUERY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE
- Function: tax_administration_cost
- Description: Gets the tax administration cost for a province
- Parameters: tax_administration_cost()
- Return: float
- Description: A list of faction province interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_FACTION_PROVINCE_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Region script interface, includes region finance and slot/settlement info
- is_null_interface
- command_queue_index
- model
- owning_faction
- slot_list
- settlement
- garrison_residence
- name
- province_name
- province
- public_order
- num_buildings
- slot_type_exists
- building_exists
- last_building_constructed_key
- resource_exists
- adjacent_region_list
- majority_religion
- region_wealth_change_percent
- squalor
- sanitation
- is_abandoned
- religion_proportion
- can_recruit_agent_at_settlement
- faction_province_growth
- faction_province_growth_per_turn
- is_province_capital
- has_development_points_to_upgrade
- pooled_resources
- can_raze_and_abandon_settlement_without_attacking
- has_effect_bundle
- distance_to_region
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: command_queue_index
- Description: Unique command queue index
- Parameters: ()
- Return: (card32)
- Function: model
- Description: Access to the model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: owning_faction
- Description: Access to the faction that owns the region
- Parameters: owning_faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: slot_list
- Description: A list of slots contained in the region
- Parameters: slot_list()
- Return: QUERY_SLOT_LIST_SCRIPT_INTERFACE
- Function: settlement
- Description: The region settlement
- Parameters: settlement()
- Return: QUERY_SETTLEMENT_SCRIPT_INTERFACE
- Function: garrison_residence
- Description: The regions settlement as a garrison_residence
- Parameters: garrison_residence()
- Return: QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE
- Function: name
- Description: The region key
- Parameters: name()
- Return: String
- Function: province_name
- Description: Key of the province containing the region
- Parameters: province_name()
- Return: String
- Function: province
- Description: The province interface containing the region
- Parameters: province()
- Return: QUERY_PROVICNE_SCRIPT_INTERFACE
- Function: public_order
- Description: Region public order
- Parameters: public_order()
- Return: int32
- Function: num_buildings
- Description: The number of buildings in a region
- Parameters: num_buildings()
- Return: int32
- Function: slot_type_exists
- Description: Does a slot with a given key exist in the region?
- Parameters: input a slot key, e.g. slot_type_exists("rice:jap_awa:farm")
- Return: bool
- Function: building_exists
- Description: Does a building with a given key exist in the region?
- Parameters: input a building key, e.g. building_exists("key")
- Return: bool
- Function: last_building_constructed_key
- Description: Returns the key of the last building constructed this region
- Parameters: last_building_constructed_key()
- Return: String
- Function: resource_exists
- Description: Is a resource produced in this region?
- Parameters: input a resource key, e.g. resource_exists("key")
- Return: bool
- Function: adjacent_region_list
- Description: Returns the list of regions adjacent to this one (including where the connection is not traversable)
- Parameters: adjacent_region_list()
- Return: QUERY_REGION_LIST_SCRIPT_INTERFACE
- Function: majority_religion
- Description: Returns key of the majority religion in the region
- Parameters: majority_religion()
- Return: String
- Function: region_wealth_change_percent
- Description: Returns key of the % region wealth change
- Parameters: region_wealth_change_percent()
- Return: float
- Function: squalor
- Description: Returns the current squalor in the region
- Parameters: squalor()
- Return: card32
- Function: sanitation
- Description: Returns the current sanitation in the region
- Parameters: sanitation()
- Return: card32
- Function: is_abandoned
- Description: Returns true if the region is abandoned
- Parameters: is_abandoned()
- Return: bool
- Function: religion_proportion
- Description: Returns the proportion domination of the specified religion
- Parameters: religion_proportion()
- Return: float32
- Function: can_recruit_agent_at_settlement
- Description: Returns true if you can recruite the specified agent type at the regions settlement
- Parameters: can_recruit_agent_at_settlement()
- Return: bool
- Function: faction_province_growth
- Description: Returns the total amount of growth points accumulated in a province towards the next population point
- Parameters: faction_province_growth()
- Return: card32
- Function: faction_province_growth_per_turn
- Description: Returns the amount of growth points added in a province towards the next population point this turn
- Parameters: faction_province_growth_per_turn()
- Return: card32
- Function: is_province_capital
- Description: Is this region the province capital?
- Parameters: is_province_capital()
- Return: bool
- Function: has_development_points_to_upgrade
- Description: Does this region have enough development points to upgrade?
- Parameters: has_development_points_to_upgrade()
- Return: bool
- Function: pooled_resources
- Description: Pooled resource manager attached to this region
- Parameters: pooled_resources()
- Return: QUERY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE
- Function: can_raze_and_abandon_settlement_without_attacking
- Description: Can script raze and abandon this region?
- Parameters: ()
- Return: (bool)
- Function: has_effect_bundle
- Description: Returns true if the region has the given effect bundle
- Parameters: has_effect_bundle()
- Return: bool
- Function: distance_to_region
- Description: Returns number of regions needed to reach the specified target region (shortest path starting from the capital)
- Parameters: (QUERY_REGION_SCRIPT_INTERFACE* target_region)
- Return: (int)
- Description: A list of region interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_REGION_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Garrison residence interface, a residence that can act as a garrison for military forces. A Settlement is a garrison residence for example.
- is_null_interface
- has_army
- has_navy
- model
- faction
- army
- navy
- region
- unit_count
- buildings
- is_under_siege
- can_assault
- can_be_occupied_by_faction
- is_settlement
- is_slot
- settlement_interface
- slot_interface
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: has_army
- Description: Is there a garrisoned army?
- Parameters: has_army()
- Return: bool
- Function: has_navy
- Description: Is there a garrisoned navy?
- Parameters: has_navy()
- Return: bool
- Function: model
- Description: Access to the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: faction
- Description: The faction that owns the garrison
- Parameters: faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: army
- Description: Returns the army in the garrison residence, if it has one
- Parameters: army()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the garrison is empty)
- Function: navy
- Description: Returns the army in the garrison residence, if it has one
- Parameters: army()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the garrison is empty)
- Function: region
- Description: The region for the garrison residence
- Parameters: region()
- Return: QUERY_REGION_SCRIPT_INTERFACE
- Function: unit_count
- Description: Number of units in a garrison
- Parameters: unit_count()
- Return: int >= 0
- Function: buildings
- Description: Returns a list of buildings in the garrison
- Parameters: buildings()
- Return: QUERY_BUILDING_LIST_SCRIPT_INTERFACE
- Function: is_under_siege
- Description: Is the garrison under siege?
- Parameters: is_under_siege()
- Return: bool
- Function: can_assault
- Description: Can the attacking army launch a seige
- Parameters: can_assault()
- Return: bool
- Function: can_be_occupied_by_faction
- Description: Can the specified faction ever occupy this residence?
- Parameters: can_be_occupied_by_faction(String faction)
- Return: bool
- Function: is_settlement
- Description: Is this garrison a settlement type?
- Parameters: is_settlement()
- Return: bool
- Function: is_slot
- Description: Is this garrison a slot type?
- Parameters: is_slot()
- Return: bool
- Function: settlement_interface
- Description: If this garrison is a settlement type, returns a settlement interface
- Parameters: settlement_interface()
- Return: QUERY_SETTLEMENT_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the garrison is not a settlement)
- Function: slot_interface
- Description: If this garrison is a slot type, returns a slot interface
- Parameters: slot_interface()
- Return: QUERY_SLOT_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the garrison is not a settlement)
- Description: Settlement script interface
- is_null_interface
- has_commander
- logical_position_x
- logical_position_y
- display_position_x
- display_position_y
- model
- commander
- faction
- region
- slot_list
- is_port
- has_walls
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: has_commander
- Description: Does the settlement have a commander of a military force
- Parameters: has_commander()
- Return: bool
- Function: logical_position_x
- Description: Logical position on map, x coord
- Parameters: logical_position_x()
- Return: int
- Function: logical_position_y
- Description: Logical position on map, y coord
- Parameters: logical_position_y()
- Return: int
- Function: display_position_x
- Description: Display/real position on map, x coord
- Parameters: display_position_x()
- Return: float
- Function: display_position_y
- Description: Display/real position on map, y coord
- Parameters: display_position_y()
- Return: float
- Function: model
- Description: Access to the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: commander
- Description: Returns the embedded military force commander
- Parameters: commander()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the settlement does not have a commander)
- Function: faction
- Description: Access to the faction that owns the settlement
- Parameters: faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: region
- Description: The region for this settlement
- Parameters: region()
- Return: QUERY_REGION_SCRIPT_INTERFACE
- Function: slot_list
- Description: Returns the list of slots in the settlement
- Parameters: slot_list()
- Return: QUERY_SLOT_LIST_SCRIPT_INTERFACE
- Function: is_port
- Description: Is this settlement a port
- Parameters: is_port()
- Return: bool
- Function: has_walls
- Description: Does settlement have walls?
- Parameters: ()
- Return: (bool)
- Description: Slot script interface
- is_null_interface
- command_queue_index
- has_building
- model
- region
- building
- faction
- type
- name
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: command_queue_index
- Description: Unique command queue index
- Parameters: ()
- Return: (card32)
- Function: has_building
- Description: Is there a building in this slot?
- Parameters: has_building()
- Return: bool
- Function: model
- Description: Access to the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: region
- Description: The region for this slot
- Parameters: region()
- Return: QUERY_REGION_SCRIPT_INTERFACE
- Function: building
- Description: Returns the building in this slot (if it exists)
- Parameters: building()
- Return: QUERY_BUILDING_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the slot does not have a building)
- Function: faction
- Description: Returns the faction that owns the slot
- Parameters: faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: type
- Description: The slot type
- Parameters: type()
- Return: string
- Function: name
- Description: The slot name
- Parameters: name()
- Return: string
- Description: A list of slot interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- slot_type_exists
- buliding_type_exists
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_SLOT_LIST_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Function: slot_type_exists
- Description: Does a slot with this key exist in the list?
- Parameters: input a slot key to query, slot_type_exists( "slot_key" )
- Return: bool
- Function: buliding_type_exists
- Description: Does a building with this key exist in the list? (building_level_record key)
- Parameters: input a slot key to query, buliding_type_exists( "building_level_record_key" )
- Return: bool
- Description: Building script interface
- is_null_interface
- model
- faction
- region
- slot
- name
- chain
- superchain
- percent_health
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Access to the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: faction
- Description: Returns the faction that owns the building
- Parameters: faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: region
- Description: The region the building is in
- Parameters: region()
- Return: QUERY_REGION_SCRIPT_INTERFACE
- Function: slot
- Description: The slot containing the building
- Parameters: slot()
- Return: QUERY_SLOT_SCRIPT_INTERFACE
- Function: name
- Description: The key for the building (building level record)
- Parameters: name()
- Return: String
- Function: chain
- Description: The key for the building chain (building_chain_record key)
- Parameters: chain()
- Return: String
- Function: superchain
- Description: The key for the building superchain (building_superchain_record key)
- Parameters: superchain()
- Return: String
- Function: percent_health
- Description: The health of a building as a percentage between 0-100
- Parameters: percent_health()
- Return: 100 >= int >= 0
- Description: A list of building interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_BUILDING_LIST_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: The collection of regions in a province owned by the same faction
- is_null_interface
- model
- military_force
- has_building
- building
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: military_force
- Description: Returns the owning force
- Parameters: military_force()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- Function: has_building
- Description: Does the slot have a building in it?
- Parameters: has_building()
- Return: bool
- Function: building
- Description: Returns the building for this slot, or the null interface if one doesn't exist
- Parameters: building()
- Return: QUERY_MILITARY_FORCE_BUILDING_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE)
- Description: A list of military force slot interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_MILITARY_FORCE_SLOT_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: The collection of regions in a province owned by the same faction
- is_null_interface
- model
- military_force
- slot
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: military_force
- Description: Returns the owning military force
- Parameters: military_force()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- Function: slot
- Description: Returns the owning military force slot
- Parameters: slot()
- Return: QUERY_MILITARY_FORCE_SLOT_SCRIPT_INTERFACE
- Description: A list of military force slot interfaces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_MILITARY_FORCE_BUILDING_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Military force interface. Armies and navies are military forces.
- is_null_interface
- command_queue_index
- military_force_retinues
- has_general
- is_army
- is_navy
- has_horde_details
- horde_details
- model
- unit_list
- character_list
- general_character
- faction
- has_garrison_residence
- garrison_residence
- contains_mercenaries
- upkeep
- active_stance
- can_activate_stance
- morale
- is_armed_citizenry
- can_recruit_agent_at_force
- can_recruit_unit
- can_recruit_unit_class
- can_recruit_unit_category
- strength
- pooled_resources
- has_effect_bundle
- region
- is_in_own_territory
- distance_to_region
- is_replenishing
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: command_queue_index
- Description: Command queue index of the Military Force
- Parameters: command_queue_index()
- Return: int
- Function: military_force_retinues
- Description: List of retinues in the military force
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_RETINUE_LIST_SCRIPT_INTERFACE)
- Function: has_general
- Description: Does the military force have a commanding general?
- Parameters: has_general()
- Return: bool
- Function: is_army
- Description: Is this military force an army?
- Parameters: is_army()
- Return: bool
- Function: is_navy
- Description: Is this military force a navy?
- Parameters: is_navy()
- Return: bool
- Function: has_horde_details
- Description: Does this military force have horde details? Is this force a horde?
- Parameters: has_horde_details()
- Return: bool
- Function: horde_details
- Description: Access to the horde details interface, or null script interface if it doesn't exist
- Parameters: horde_details()
- Return: QUERY_MILITARY_FORCE_HORDE_DETAILS_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE)
- Function: model
- Description: Access to the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: unit_list
- Description: Returns the list of units in the military force
- Parameters: unit_list()
- Return: QUERY_UNIT_LIST_SCRIPT_INTERFACE
- Function: character_list
- Description: A list of characters embedded in the military force
- Parameters: character_list()
- Return: QUERY_CHARACTER_LIST_SCRIPT_INTERFACE
- Function: general_character
- Description: Returns the character interface for the military force general (if one exists)
- Parameters: general_character()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the military force doesn't have a commander)
- Function: faction
- Description: The faction that the military force belongs to
- Parameters: faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: has_garrison_residence
- Description: Is the force in a garrison residence?
- Parameters: has_garrison_residence()
- Return: bool
- Function: garrison_residence
- Description: Returns the garrison residence the force is embedded in
- Parameters: garrison_residence()
- Return: QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if the army isn't embedded)
- Function: contains_mercenaries
- Description: Returns if the force contains mercenaries
- Parameters: contains_mercenaries()
- Return: bool
- Function: upkeep
- Description: Returns the upkeep costs for the military force
- Parameters: upkeep()
- Return: int >= 0
- Function: active_stance
- Description: Returns the active stance for the military force
- Parameters: active_stance()
- Return: String
- Function: can_activate_stance
- Description: Can the military force enter this stance
- Parameters: input a stance string to query, can_activate_stance( "stance" )
- Return: bool
- Function: morale
- Description: Get the morale for this army
- Parameters: morale()
- Return: card32
- Function: is_armed_citizenry
- Description: returns true if the force is armed citizenry
- Parameters: is_armed_citizenry()
- Return: bool
- Function: can_recruit_agent_at_force
- Description: Returns true if you can recruit the specified agent at this force
- Parameters: can_recruit_agent_at_force()
- Return: bool
- Function: can_recruit_unit
- Description: Returns true if this force can recruit a unit of this type
- Parameters: can_recruit_unit()
- Return: bool
- Function: can_recruit_unit_class
- Description: Returns true if this force can recruit a unit of this class
- Parameters: can_recruit_unit_class()
- Return: bool
- Function: can_recruit_unit_category
- Description: Returns true if this force can recruit a unit of this category
- Parameters: can_recruit_unit_category()
- Return: bool
- Function: strength
- Description: Returns the strength of the military force
- Parameters: strength()
- Return: float32
- Function: pooled_resources
- Description: Pooled resource manager attached to this military force
- Parameters: pooled_resources()
- Return: QUERY_POOLED_RESOURCE_MANAGER_SCRIPT_INTERFACE
- Function: has_effect_bundle
- Description: Returns true if the military force has the given effect bundle
- Parameters: has_effect_bundle()
- Return: bool
- Function: region
- Description: The region for the military force
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_REGION_SCRIPT_INTERFACE)
- Function: is_in_own_territory
- Description: Returns true uf the force is within its faction's territory
- Parameters: is_in_own_territory()
- Return: bool
- Function: distance_to_region
- Description: Returns number of regions needed to reach the specified target region (shortest path starting from the capital)
- Parameters: (QUERY_REGION_SCRIPT_INTERFACE* target_region)
- Return: (int)
- Function: is_replenishing
- Description: Returns TRUE if the force will replenish this turn (not at full strength, in friendly territory, etc.), FALSE otherwise.
- Parameters: ()
- Return: (bool)
- Description: A list of military forces
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Military force retinue (on the campaign map in a military force)
- is_null_interface
- campaign_model
- command_queue_index
- owning_military_force
- retinue_commander
- retinue_commander_is_commanding_military_force
- is_mercenary_retinue
- has_effect_bundle
- persistent_retinue
- military_force_retinue_slots
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: campaign_model
- Description: Access to the campaign model
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: command_queue_index
- Description: Unique command queue index
- Parameters: ()
- Return: (card32)
- Function: owning_military_force
- Description: Military force the retinue is in
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: retinue_commander
- Description: If this retinue has a commander character, return it
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: retinue_commander_is_commanding_military_force
- Description: Is this retinue's commander the commander of the military force?
- Parameters: ()
- Return: (bool)
- Function: is_mercenary_retinue
- Description: Is this retinue a mercenary?
- Parameters: ()
- Return: (bool)
- Function: has_effect_bundle
- Description: Does this retinue have the effect bundle on it?
- Parameters: (String effect_bundle_key)
- Return: (bool)
- Function: persistent_retinue
- Description: Persistent retinue this Military Force Retinue is built from
- Parameters: ()
- Return: (RETURN_QUERY_PERSISTENT_RETINUE_SCRIPT_INTERFACE)
- Function: military_force_retinue_slots
- Description: List of slots in this military force retinue
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_RETINUE_SLOT_LIST_SCRIPT_INTERFACE)
- Description: A list of Military force retinue
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Military force retinue slot (on the campaign map in a military force)
- is_null_interface
- campaign_model
- command_queue_index
- owning_military_force
- slot_commander
- slot_commander_is_commanding_military_force
- slot_commander_is_retinue_commander
- linked_to_unit
- persistent_slot_unit_record_key
- persistent_slot
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: campaign_model
- Description: Access to the campaign model
- Parameters: ()
- Return: (RETURN_QUERY_MODEL_SCRIPT_INTERFACE)
- Function: command_queue_index
- Description: Unique command queue index
- Parameters: ()
- Return: (card32)
- Function: owning_military_force
- Description: Military force the retinue slot is in
- Parameters: ()
- Return: (RETURN_QUERY_MILITARY_FORCE_SCRIPT_INTERFACE)
- Function: slot_commander
- Description: Commander character of the slot, if one exists
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: slot_commander_is_commanding_military_force
- Description: Is the slot commander also commanding the military force?
- Parameters: ()
- Return: (bool)
- Function: slot_commander_is_retinue_commander
- Description: Is the slot commander also commanding the retinue this slot exists in?
- Parameters: ()
- Return: (bool)
- Function: linked_to_unit
- Description: Return the Unit Interface that this slot is linked to, may not eixst if the unit/character is convalesing or there is no underlying unit record in the slot
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_UNIT_SCRIPT_INTERFACE)
- Function: persistent_slot_unit_record_key
- Description: Unit record key of the underlying Persistent Retinue slot.
- Parameters: ()
- Return: (String)
- Function: persistent_slot
- Description: The underlying Persistent Slot this Military Force Slot is created from
- Parameters: ()
- Return: (RETURN_QUERY_PERSISTENT_RETINUE_SLOT_SCRIPT_INTERFACE)
- Description: A list of Military force retinue slot
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_MILITARY_FORCE_RETINUE_SLOT_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: DESCRIPTION - TODO
- is_null_interface
- model
- miltary_force
- miltary_force_slot_list
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Returns the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: miltary_force
- Description: Returns the owning miltary force
- Parameters: miltary_force()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- Function: miltary_force_slot_list
- Description: Returns the horde slot list
- Parameters: miltary_force_slot_list()
- Return: QUERY_MILITARY_FORCE_SLOT_LIST_SCRIPT_INTERFACE
- Description: Unit script interface. Land units and Naval units are derived from Unit.
- is_null_interface
- military_force_retinue
- military_force_retinue_slot
- has_force_commander
- has_unit_commander
- is_land_unit
- is_naval_unit
- model
- force_commander
- unit_commander
- military_force
- faction
- unit_key
- unit_category
- unit_class
- percentage_proportion_of_full_strength
- can_upgrade_unit_equipment
- can_upgrade_unit
- experience_level
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: military_force_retinue
- Description: Optional link to retinue this unit is in
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_MILITARY_FORCE_RETINUE_SCRIPT_INTERFACE)
- Function: military_force_retinue_slot
- Description: Optional link to the retinue slot this unit is in
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_MILITARY_FORCE_RETINUE_SLOT_SCRIPT_INTERFACE)
- Function: has_force_commander
- Description: Is the unit in a force with a commander?
- Parameters: has_force_commander()
- Return: bool
- Function: has_unit_commander
- Description: Does this unit have a character leading it? Not all units have one
- Parameters: has_unit_commander()
- Return: bool
- Function: is_land_unit
- Description: Is this a land unit?
- Parameters: is_land_unit()
- Return: bool
- Function: is_naval_unit
- Description: Is this a naval unit?
- Parameters: is_naval_unit()
- Return: bool
- Function: model
- Description: Access to the campaign model interface
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: force_commander
- Description: Returns the force commander if one exists
- Parameters: force_commander()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE unit doesn't have a force commander)
- Function: unit_commander
- Description: Returns the unit commander if one exists
- Parameters: unit_commander()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE unit doesn't have a unit commander)
- Function: military_force
- Description: Returns the military force containing this unit
- Parameters: military_force()
- Return: QUERY_MILITARY_FORCE_SCRIPT_INTERFACE
- Function: faction
- Description: Returns the faction that this unit belongs to
- Parameters: faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: unit_key
- Description: The unit record key
- Parameters: unit_key()
- Return: String
- Function: unit_category
- Description: The unit record category
- Parameters: unit_category()
- Return: String
- Function: unit_class
- Description: The unit record class
- Parameters: unit_class()
- Return: String
- Function: percentage_proportion_of_full_strength
- Description: The % of soldiers in the unit. Returns a value 0.0-100.0
- Parameters: percentage_proportion_of_full_strength()
- Return: float
- Function: can_upgrade_unit_equipment
- Description: Can this unit upgrade it's equipment
- Parameters: can_upgrade_unit_equipment()
- Return: bool
- Function: can_upgrade_unit
- Description: Can this unit be upgraded to another unit
- Parameters: can_upgrade_unit()
- Return: bool
- Function: experience_level
- Description: Current Unit Experience Level
- Parameters: ()
- Return: (card32)
- Description: A list of units
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- has_unit
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_UNIT_LIST_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Function: has_unit
- Description: Test if a unit exists in the unit list. Input a unit record key.
- Parameters: input a unit key string, has_unit(" unit_key ")
- Return: bool
- Description: Pending battle script interface.
- is_null_interface
- has_attacker
- has_defender
- has_contested_garrison
- model
- attacker
- secondary_attackers
- defender
- secondary_defenders
- contested_garrison
- is_active
- attacker_is_stronger
- percentage_of_attacker_killed
- percentage_of_defender_killed
- percentage_of_attacker_routed
- percentage_of_defender_routed
- attacker_commander_fought_in_battle
- defender_commander_fought_in_battle
- attacker_commander_fought_in_melee
- defender_commander_fought_in_melee
- attacker_battle_result
- defender_battle_result
- naval_battle
- seige_battle
- ambush_battle
- failed_ambush_battle
- night_battle
- battle_type
- attacker_strength
- defender_strength
- has_been_fought
- human_involved
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: has_attacker
- Description: Does the pending battle have an attacking character?
- Parameters: has_attacker()
- Return: bool
- Function: has_defender
- Description: Does the pending battle have a defending character?
- Parameters: has_defender()
- Return: bool
- Function: has_contested_garrison
- Description: Is the pending battle at a garrison?
- Parameters: has_contested_garrison()
- Return: bool
- Function: model
- Description: Access to the campaign model
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: attacker
- Description: Returns the attacking character, if one exists
- Parameters: attacker()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if no attacking character exists)
- Function: secondary_attackers
- Description: Returns the list of secondary attacking characters
- Parameters: secondary_attackers()
- Return: QUERY_CHARACTER_LIST_SCRIPT_INTERFACE
- Function: defender
- Description: Returns the defending character, if one exists
- Parameters: defender()
- Return: QUERY_CHARACTER_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if no defending character exists)
- Function: secondary_defenders
- Description: Returns the list of secondary defending characters
- Parameters: secondary_defenders()
- Return: QUERY_CHARACTER_LIST_SCRIPT_INTERFACE
- Function: contested_garrison
- Description: Returns the contested residence, if it exists
- Parameters: contested_garrison()
- Return: QUERY_GARRISON_RESIDENCE_SCRIPT_INTERFACE (or NULL_SCRIPT_INTERFACE if a garrison isn't being contested)
- Function: is_active
- Description: Is a pending battle active?
- Parameters: is_active()
- Return: bool
- Function: attacker_is_stronger
- Description: Is the attacking force stronger than the defender?
- Parameters: attacker_is_stronger()
- Return: bool
- Function: percentage_of_attacker_killed
- Description: Percentage of attacker killed in battle
- Parameters: percentage_of_attacker_killed()
- Return: 100 >= float >= 0
- Function: percentage_of_defender_killed
- Description: Percentage of defender killed in battle
- Parameters: percentage_of_defender_killed()
- Return: 100 >= float >= 0
- Function: percentage_of_attacker_routed
- Description: Percentage of attackers routed in battle
- Parameters: percentage_of_attacker_routed()
- Return: 100 >= float >= 0
- Function: percentage_of_defender_routed
- Description: Percentage of defenders routed in battle
- Parameters: percentage_of_defender_routed()
- Return: 100 >= float >= 0
- Function: attacker_commander_fought_in_battle
- Description: Did the commander engage in the battle?
- Parameters: attacker_commander_fought_in_battle()
- Return: bool
- Function: defender_commander_fought_in_battle
- Description: Did the commander engage in the battle?
- Parameters: defender_commander_fought_in_battle()
- Return: bool
- Function: attacker_commander_fought_in_melee
- Description: Did the commander engage in melee?
- Parameters: attacker_commander_fought_in_melee()
- Return: bool
- Function: defender_commander_fought_in_melee
- Description: Did the commander engage in melee?
- Parameters: defender_commander_fought_in_melee()
- Return: bool
- Function: attacker_battle_result
- Description: The battle result for the attacker
- Parameters: attacker_battle_result()
- Return: String (close_victory, decisive_victory, heroic_victory, pyrrhic_victory, close_defeat, decisive_defeat, crushing_defeat, valiant_defeat
- Function: defender_battle_result
- Description: The battle result for the defender
- Parameters: defender_battle_result()
- Return: String (close_victory, decisive_victory, heroic_victory, pyrrhic_victory, close_defeat, decisive_defeat, crushing_defeat, valiant_defeat
- Function: naval_battle
- Description: The battle is a naval battle
- Parameters: naval_battle()
- Return: bool
- Function: seige_battle
- Description: The battle is a seige battle
- Parameters: seige_battle()
- Return: bool
- Function: ambush_battle
- Description: The battle is a ambush battle
- Parameters: ambush_battle()
- Return: bool
- Function: failed_ambush_battle
- Description: The battle is a failed ambush battle
- Parameters: failed_ambush_battle()
- Return: bool
- Function: night_battle
- Description: The battle is a night battle
- Parameters: night_battle()
- Return: bool
- Function: battle_type
- Description: The battle type. Asks a programmer for the battle type strings (found in campaign_battle_type_enum_ids, campaignbonusvalues.cpp)
- Parameters: battle_type()
- Return: string
- Function: attacker_strength
- Description: The relative strength of the attacker
- Parameters: attacker_strength()
- Return: float32
- Function: defender_strength
- Description: The relative strength of the defender
- Parameters: defender_strength()
- Return: float32
- Function: has_been_fought
- Description: True if the battle has been fought
- Parameters: has_been_fought()
- Return: bool
- Function: human_involved
- Description: Whether the battle containes a human (player) faction
- Parameters: ()
- Return: (bool)
- Description: Mission script interface.
- is_null_interface
- model
- faction
- mission_record_key
- mission_issuer_record_key
- cqi
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: model
- Description: Access to the campaign model interface
- Parameters: model()
- Return: QUERY_MODEL_SCRIPT_INTERFACE
- Function: faction
- Description: Access to the faction interface
- Parameters: faction()
- Return: QUERY_FACTION_SCRIPT_INTERFACE
- Function: mission_record_key
- Description: Returns the mission record key
- Parameters: mission_record_key()
- Return: String
- Function: mission_issuer_record_key
- Description: Returns the mission issuer record key
- Parameters: mission_issuer_record_key()
- Return: String
- Function: cqi
- Description: Returns the CQI of this mission
- Parameters: ()
- Return: (card32)
- Description: Campaign AI script interface.
- is_null_interface
- strategic_stance_between_factions
- strategic_stance_between_factions_available
- strategic_stance_between_factions_promotion_or_blocking_is_set
- strategic_stance_between_factions_promotion_is_active
- strategic_stance_between_factions_promotion_current_level
- strategic_stance_between_factions_promotion_start_round
- strategic_stance_between_factions_promotion_start_level
- strategic_stance_between_factions_promotion_end_round
- strategic_stance_between_factions_promotion_end_level
- strategic_stance_between_factions_is_being_blocked
- strategic_stance_between_factions_is_being_blocked_until
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: strategic_stance_between_factions
- Description: Determine the strategic stance between two AI factions.
- Parameters: strategic_stance_between_factions(faction_being_queries, faction_that_is_being_considered)
- Return:
- Function: strategic_stance_between_factions_available
- Description: Determine if the strategic stance between two AI factions is available.
- Parameters: strategic_stance_between_factions_available(faction_being_queries, faction_that_is_being_considered)
- Return:
- Function: strategic_stance_between_factions_promotion_or_blocking_is_set
- Description: Determine if there is any currently active blocking or promotion set between factions.
- Parameters: strategic_stance_between_factions_promotion_or_blocking_is_set(faction_being_queries, faction_that_is_being_considered)
- Return:
- Function: strategic_stance_between_factions_promotion_is_active
- Description: Determine if there is any currently active promotion between factions for a given stance.
- Parameters: strategic_stance_between_factions_promotion_is_active(faction_being_queries, faction_that_is_being_considered, stance_by_number)
- Return:
- Function: strategic_stance_between_factions_promotion_current_level
- Description: Determine the current promotion level between factions for a given stance if set.
- Parameters: strategic_stance_between_factions_promotion_current_level(faction_being_queries, faction_that_is_being_considered, stance_by_number)
- Return:
- Function: strategic_stance_between_factions_promotion_start_round
- Description: Determine the start round on promotion between factions for a given stance if set.
- Parameters: strategic_stance_between_factions_promotion_start_round(faction_being_queries, faction_that_is_being_considered, stance_by_number)
- Return:
- Function: strategic_stance_between_factions_promotion_start_level
- Description: Determine the start level on promotion between factions for a given stance if set.
- Parameters: strategic_stance_between_factions_promotion_start_level(faction_being_queries, faction_that_is_being_considered, stance_by_number)
- Return:
- Function: strategic_stance_between_factions_promotion_end_round
- Description: Determine the end round on promotion between factions for a given stance if set.
- Parameters: strategic_stance_between_factions_promotion_end_round(faction_being_queries, faction_that_is_being_considered, stance_by_number)
- Return:
- Function: strategic_stance_between_factions_promotion_end_level
- Description: Determine the end level on promotion between factions for a given stance if set.
- Parameters: strategic_stance_between_factions_promotion_end_level(faction_being_queries, faction_that_is_being_considered, stance_by_number)
- Return:
- Function: strategic_stance_between_factions_is_being_blocked
- Description: Determine blocking is enabled between factions for a given stance if set.
- Parameters: strategic_stance_between_factions_is_being_blocked(faction_being_queries, faction_that_is_being_considered, stance_by_number)
- Return:
- Function: strategic_stance_between_factions_is_being_blocked_until
- Description: Determine when blocking is enabled too between factions for a given stance if set.
- Parameters: strategic_stance_between_factions_is_being_blocked_until(faction_being_queries, faction_that_is_being_considered, stance_by_number)
- Return:
- Description: Historical character manager interface. Access to database records, and which records have been used.
- is_null_interface
- historical_character_for_record_key
- historical_character_has_been_generated
- all_historical_characters_for_faction_agent_type
- all_valid_generatable_historical_characters_for_faction_agent_type
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: historical_character_for_record_key
- Description: Returns a QUERY_HISTORICAL_CHARACTER_SCRIPT_INTERFACE for the provided historical character record key
- Parameters: historical_character_for_record_key( "historical_character_record_key" )
- Return: QUERY_HISTORICAL_CHARACTER_SCRIPT_INTERFACE or NULL_SCRIPT_INTERFACE if the record key isn't valid
- Function: historical_character_has_been_generated
- Description: Returns true if the historical character has been generated. Parameter is a QUERY_HISTORICAL_CHARACTER_SCRIPT_INTERFACE interface.
- Parameters: historical_character_has_been_generated( QUERY_HISTORICAL_CHARACTER_SCRIPT_INTERFACE )
- Return: bool
- Function: all_historical_characters_for_faction_agent_type
- Description: Returns a QUERY_HISTORICAL_CHARACTER_LIST_SCRIPT_INTERFACE of all the matching historical characters for the faction key and agent type key.
- Parameters: all_historical_characters_for_faction_agent_type( "faction_key", "agent_type_key" )
- Return: QUERY_HISTORICAL_CHARACTER_LIST_SCRIPT_INTERFACE
- Function: all_valid_generatable_historical_characters_for_faction_agent_type
- Description: Returns a QUERY_HISTORICAL_CHARACTER_LIST_SCRIPT_INTERFACE of all the generatable historical characters for the faction key and agent type key. This will check spawning years and whether they have already been generated.
- Parameters: all_valid_generatable_historical_characters_for_faction_agent_type( "faction_key", "agent_type_key" )
- Return: QUERY_HISTORICAL_CHARACTER_LIST_SCRIPT_INTERFACE
- Description: Historical character interface. Access to the historical character database record information.
- is_null_interface
- record_key
- faction_key
- agent_type_key
- starting_spawn_year
- ending_spawn_year
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: record_key
- Description: Returns the historical character record key.
- Parameters: record_key()
- Return: String
- Function: faction_key
- Description: Returns the historical character faction key.
- Parameters: faction_key()
- Return: String
- Function: agent_type_key
- Description: Returns the historical character agent type key.
- Parameters: agent_type_key()
- Return: String
- Function: starting_spawn_year
- Description: Returns the historical character spawn starting year.
- Parameters: starting_spawn_year()
- Return: int
- Function: ending_spawn_year
- Description: Returns the historical character spawn ending year.
- Parameters: ending_spawn_year()
- Return: int
- Description: A list of historical characters
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_HISTORICAL_CHARACTER_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Character's ceo management
- is_null_interface
- character
- all_ceos
- all_ceos_for_category
- changing_points_for_ceo_data_will_have_no_impact
- can_create_ceo
- has_ceo_equipped
- number_of_ceos_equipped_for_category
- all_ceos_equipped_on_character
- all_ceo_equipment_slots
- all_ceo_equipment_slots_for_category
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: character
- Description: Owning character
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_SCRIPT_INTERFACE)
- Function: all_ceos
- Description: List of all the ceos active on the character.
- Parameters: ()
- Return: (RETURN_QUERY_CEO_LIST_SCRIPT_INTERFACE)
- Function: all_ceos_for_category
- Description: List of all the ceos active on the character matching the category.
- Parameters: (String category_key)
- Return: (RETURN_QUERY_CEO_LIST_SCRIPT_INTERFACE)
- Function: changing_points_for_ceo_data_will_have_no_impact
- Description: Will changing the points of this ceo_data change anything?
- Parameters: (String ceo_data_key)
- Return: (bool)
- Function: can_create_ceo
- Description: Can a ceo be created with this key?
- Parameters: (String ceo_data_key)
- Return: (bool)
- Function: has_ceo_equipped
- Description: Does the character have a ceo equipped with this key?
- Parameters: (String ceo_data_key)
- Return: (bool)
- Function: number_of_ceos_equipped_for_category
- Description: How many ceos are equipped in this ceo category?
- Parameters: (String category_key)
- Return: (card32)
- Function: all_ceos_equipped_on_character
- Description: List of all the ceos active on the character.
- Parameters: ()
- Return: (RETURN_QUERY_CEO_LIST_SCRIPT_INTERFACE)
- Function: all_ceo_equipment_slots
- Description: List of all the ceo equipment slots on the character.
- Parameters: ()
- Return: (RETURN_QUERY_CEO_EQUIPMENT_SLOT_LIST_SCRIPT_INTERFACE)
- Function: all_ceo_equipment_slots_for_category
- Description: List of all the category's ceo equipment slots on the character.
- Parameters: (String category_key)
- Return: (RETURN_QUERY_CEO_EQUIPMENT_SLOT_LIST_SCRIPT_INTERFACE)
- Description: Faction's ceo management
- is_null_interface
- faction
- all_ceos
- all_ceos_for_category
- changing_points_for_ceo_data_will_have_no_impact
- can_create_ceo
- has_ceo_equipped
- number_of_ceos_equipped_for_category
- all_ceos_equipped_on_faction
- all_ceo_equipment_slots
- all_ceo_equipment_slots_for_category
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: faction
- Description: Owning faction
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: all_ceos
- Description: List of all the ceos active on the faction.
- Parameters: ()
- Return: (RETURN_QUERY_CEO_LIST_SCRIPT_INTERFACE)
- Function: all_ceos_for_category
- Description: List of all the ceos active on the faction matching the category.
- Parameters: (String category_key)
- Return: (RETURN_QUERY_CEO_LIST_SCRIPT_INTERFACE)
- Function: changing_points_for_ceo_data_will_have_no_impact
- Description: Will changing the points of this ceo_data change anything?
- Parameters: (String ceo_data_key)
- Return: (bool)
- Function: can_create_ceo
- Description: Can a ceo be created with this key?
- Parameters: (String ceo_data_key)
- Return: (bool)
- Function: has_ceo_equipped
- Description: Does the faction have a ceo equipped with this key?
- Parameters: (String ceo_data_key)
- Return: (bool)
- Function: number_of_ceos_equipped_for_category
- Description: How many ceos are equipped in this ceo category?
- Parameters: (String category_key)
- Return: (card32)
- Function: all_ceos_equipped_on_faction
- Description: List of all the ceos active on the faction.
- Parameters: ()
- Return: (RETURN_QUERY_CEO_LIST_SCRIPT_INTERFACE)
- Function: all_ceo_equipment_slots
- Description: List of all the ceo equipment slots on the faction.
- Parameters: ()
- Return: (RETURN_QUERY_CEO_EQUIPMENT_SLOT_LIST_SCRIPT_INTERFACE)
- Function: all_ceo_equipment_slots_for_category
- Description: List of all the category's ceo equipment slots on the faction.
- Parameters: (String category_key)
- Return: (RETURN_QUERY_CEO_EQUIPMENT_SLOT_LIST_SCRIPT_INTERFACE)
- Description: Ceo Interface
- is_null_interface
- command_queue_index
- ceo_data_key
- category_key
- current_node_key
- num_points_in_ceo
- max_points_in_ceo
- point_change_enabled
- is_equipped_in_slot
- equipped_in_slot
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: command_queue_index
- Description: CEO cqi
- Parameters: ()
- Return: (card32)
- Function: ceo_data_key
- Description: ceo data key
- Parameters: ()
- Return: (String)
- Function: category_key
- Description: ceo category key
- Parameters: ()
- Return: (String)
- Function: current_node_key
- Description: active node key of ceo, can have no node active
- Parameters: ()
- Return: (String)
- Function: num_points_in_ceo
- Description: number of points in ceo
- Parameters: ()
- Return: (card32)
- Function: max_points_in_ceo
- Description: maximum number of points in ceo
- Parameters: ()
- Return: (card32)
- Function: point_change_enabled
- Description: ceo can change points
- Parameters: ()
- Return: (bool)
- Function: is_equipped_in_slot
- Description: is ceo equipped in a slot
- Parameters: ()
- Return: (bool)
- Function: equipped_in_slot
- Description: get the slot this ceo is equipped in
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE)
- Description: A list of ceos
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_CEO_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Ceo equipment slot Interface
- is_null_interface
- command_queue_index
- category_key
- equipped_ceo
- can_unequip_ceo
- all_equippable_ceos
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: command_queue_index
- Description: Ceo equipment slot cqi
- Parameters: ()
- Return: (card32)
- Function: category_key
- Description: category key
- Parameters: ()
- Return: (String)
- Function: equipped_ceo
- Description: ceo equipped in slot
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_CEO_SCRIPT_INTERFACE)
- Function: can_unequip_ceo
- Description: can unequip the ceo equipped in this slot?
- Parameters: ()
- Return: (bool)
- Function: all_equippable_ceos
- Description: all ceos that can be equipped in this slot
- Parameters: ()
- Return: (RETURN_QUERY_CEO_LIST_SCRIPT_INTERFACE)
- Description: A list of ceo equipment slots
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_CEO_EQUIPMENT_SLOT_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Pooled resource factor interface
- is_null_interface
- value
- percentage_of_capacity
- minimum_value
- maximum_value
- record_key
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: value
- Description: Signed value of factor
- Parameters: ()
- Return: (int32)
- Function: percentage_of_capacity
- Description: Integer percentage of factor capacity
- Parameters: ()
- Return: (int32)
- Function: minimum_value
- Description: Minimum Value
- Parameters: ()
- Return: (int32)
- Function: maximum_value
- Description: Maximum Value
- Parameters: ()
- Return: (int32)
- Function: record_key
- Description: Factor Record Key
- Parameters: ()
- Return: (String)
- Description: A list of pooled resource factors
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_POOLED_RESOURCE_FACTOR_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Pooled resource script interface
- is_null_interface
- active_effect
- factors
- maximum_value
- minimum_value
- number_of_effect_types
- percentage_of_capacity
- record_key
- value
- enabled
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: active_effect
- Description: Active effect bundle record key for the given effect type. Zero based. Query number of effect types for max range
- Parameters: (card32 effect_type)
- Return: (String)
- Function: factors
- Description: All factors that make up this resource
- Parameters: ()
- Return: (RETURN_QUERY_POOLED_RESOURCE_FACTOR_LIST_SCRIPT_INTERFACE)
- Function: maximum_value
- Description: Maximum value
- Parameters: ()
- Return: (int32)
- Function: minimum_value
- Description: Minimum value
- Parameters: ()
- Return: (int32)
- Function: number_of_effect_types
- Description: Number of effect types available for active effect query. Zero based
- Parameters: ()
- Return: (card32)
- Function: percentage_of_capacity
- Description: Integer based capacity of maximum
- Parameters: ()
- Return: (int32)
- Function: record_key
- Description: Resource record key
- Parameters: ()
- Return: (String)
- Function: value
- Description: Total resource value of pool
- Parameters: ()
- Return: (int32)
- Function: enabled
- Description: Is pooled resource enabled
- Parameters: ()
- Return: (bool)
- Description: A list of pooled resources
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_POOLED_RESOURCE_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: A pooled resource manager attached to a campaign object
- is_null_interface
- can_afford_resource_transaction
- is_faction_scope
- is_faction_province_scope
- is_region_scope
- is_military_force_scope
- owning_faction
- resources
- resource
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: can_afford_resource_transaction
- Description: Can this resource manager afford the specified resource transaction
- Parameters: (String resource_transaction_key)
- Return: (bool)
- Function: is_faction_scope
- Description: Is this resource pool manager attached to a faction?
- Parameters: ()
- Return: (bool)
- Function: is_faction_province_scope
- Description: Is this resource pool manager attached to a faction province?
- Parameters: ()
- Return: (bool)
- Function: is_region_scope
- Description: Is this resource pool manager attached to a region?
- Parameters: ()
- Return: (bool)
- Function: is_military_force_scope
- Description: Is this resource pool manager attached to a military force?
- Parameters: ()
- Return: (bool)
- Function: owning_faction
- Description: Faction that owns this manager
- Parameters: ()
- Return: (RETURN_OPTIONAL_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: resources
- Description: All of the resource pools managed by this object
- Parameters: ()
- Return: (RETURN_QUERY_POOLED_RESOURCE_LIST_SCRIPT_INTERFACE)
- Function: resource
- Description: Find a specific resource by key. Can be a null interface if it not present
- Parameters: (String resource_key)
- Return: (RETURN_OPTIONAL_QUERY_POOLED_RESOURCE_SCRIPT_INTERFACE)
- Description: Faction management of their undercover chaarcters
- is_null_interface
- undercover_network_points_for_faction
- undercover_network_point_change_per_turn_for_faction
- factions_that_have_undercover_network_points_or_change_per_turn
- undercover_characters
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: undercover_network_points_for_faction
- Description: Undercover network points for this faction
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE * faction)
- Return: (card32)
- Function: undercover_network_point_change_per_turn_for_faction
- Description: Undercover network point change per turn for this faction
- Parameters: (QUERY_FACTION_SCRIPT_INTERFACE * faction)
- Return: (int32)
- Function: factions_that_have_undercover_network_points_or_change_per_turn
- Description: Which factions are involed in undercover network point state or changes
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_LIST_SCRIPT_INTERFACE)
- Function: undercover_characters
- Description: All the undercover characters for this faction
- Parameters: ()
- Return: (RETURN_QUERY_UNDERCOVER_CHARACTER_LIST_SCRIPT_INTERFACE)
- Description: An Undercover Character object, holds all the information about the undercover character origins and current state
- is_null_interface
- can_recall
- can_disown
- source_faction
- current_faction
- deployment_target_faction
- is_counter_undercover_character
- is_undiscovered
- is_discovered_waiting_resolve
- is_discovered_and_discovery_resolved
- is_in_source_faction
- is_returning_to_source_faction
- is_hired_by_non_source_faction
- upkeep_per_turn
- cover_points
- max_cover_points
- cover_point_change_per_turn
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: can_recall
- Description: Can the source faction recall the undercover character?
- Parameters: ()
- Return: (bool)
- Function: can_disown
- Description: Can the source faction disown the undercover character?
- Parameters: ()
- Return: (bool)
- Function: source_faction
- Description: Source faction of the udnercover character - who they spy for
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: current_faction
- Description: Current faction of the undercover character - which faction are they in at the moment
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: deployment_target_faction
- Description: Deployment faction of the undercover character - which faction are they being sent to
- Parameters: ()
- Return: (RETURN_QUERY_FACTION_SCRIPT_INTERFACE)
- Function: is_counter_undercover_character
- Description: Has the character been sent as a counterspy
- Parameters: ()
- Return: (bool)
- Function: is_undiscovered
- Description: Has never been discovered
- Parameters: ()
- Return: (bool)
- Function: is_discovered_waiting_resolve
- Description: Has been discovered and is waiting for the current faction to resolve it
- Parameters: ()
- Return: (bool)
- Function: is_discovered_and_discovery_resolved
- Description: Has been discovered and resolved
- Parameters: ()
- Return: (bool)
- Function: is_in_source_faction
- Description: Is the character in the source faction
- Parameters: ()
- Return: (bool)
- Function: is_returning_to_source_faction
- Description: Is the character returning to the source faction
- Parameters: ()
- Return: (bool)
- Function: is_hired_by_non_source_faction
- Description: Is the character recruited in a non-source faction
- Parameters: ()
- Return: (bool)
- Function: upkeep_per_turn
- Description: How much does the undercover character cost
- Parameters: ()
- Return: (card32)
- Function: cover_points
- Description: number of cover points
- Parameters: ()
- Return: (card32)
- Function: max_cover_points
- Description: max number of cover points
- Parameters: ()
- Return: (card32)
- Function: cover_point_change_per_turn
- Description: change in cover points per turn
- Parameters: ()
- Return: (int32)
- Description: A list of undercover character
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_UNDERCOVER_CHARACTER_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Character relationship, Defines relationship between characters
- is_null_interface
- relationship_record_key
- get_relationship_characters
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: relationship_record_key
- Description: Returns the relationship type database record key
- Parameters: ()
- Return: (String)
- Function: get_relationship_characters
- Description: Returns all characters associated with this relationship
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_LIST_SCRIPT_INTERFACE)
- Description: A list of character relationships
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_CHARACTER_RELATIONSHIP_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Character Post / Ministerial Position
- is_null_interface
- cqi
- ministerial_position_record_key
- maximum_post_holders
- current_post_holders
- post_holders
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: cqi
- Description: Return Command Queue Index of Character Post
- Parameters: ()
- Return: (card32)
- Function: ministerial_position_record_key
- Description: Return ministerial position key
- Parameters: ()
- Return: (String)
- Function: maximum_post_holders
- Description: Maximum number of characters that can hold this post at the same time
- Parameters: ()
- Return: (card32)
- Function: current_post_holders
- Description: Current number of character that hold this post
- Parameters: ()
- Return: (card32)
- Function: post_holders
- Description: List of characters that currently hold this post
- Parameters: ()
- Return: (RETURN_QUERY_CHARACTER_LIST_SCRIPT_INTERFACE)
- Description: List of character posts
- num_items
- item_at
- is_empty
- contains
- filter
- foreach
- find_if
- any_of
- all_of
- none_of
- count_if
- Function: num_items
- Description: Returns the number of items in the list
- Parameters: ()
- Return: int32
- Function: item_at
- Description: Returns the item at the index. Make sure the index is between 0 and (max items - 1)
- Parameters: ()
- Return: QUERY_CHARACTER_POST_SCRIPT_INTERFACE
- Function: is_empty
- Description: Returns true if there are 0 items in the list
- Parameters: ()
- Return: bool
- Function: contains
- Description: Returns true if the list contains the element passed as argument
- Parameters: (list_element)
- Return: bool
- Function: filter
- Description: Returns a new list of items matching the predicate
- Parameters: (lua_function)
- Return: list
- Function: foreach
- Description: Applies a function (with no return values) to each element in the list, returns the list for composition
- Parameters: (lua_function)
- Return: list
- Function: find_if
- Description: Returns the first element for which lua_function returns true, null interface if nothing found
- Parameters: (lua_function)
- Return: list_element
- Function: any_of
- Description: Returns true if lua_function returns true for any of list elements
- Parameters: (lua_function)
- Return: bool
- Function: all_of
- Description: Returns true if lua_function returns true for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: none_of
- Description: Returns true if lua_function returns false for all of list elements
- Parameters: (lua_function)
- Return: bool
- Function: count_if
- Description: Counts the elements for which lua_function returns true
- Parameters: (lua_function)
- Return: card32
- Description: Character Assignment
- is_null_interface
- assignment_record_key
- assignment_state
- rounds_until_state_transition
- is_idle_assignment
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: assignment_record_key
- Description: Record key this active assignment
- Parameters: ()
- Return: (String)
- Function: assignment_state
- Description: Stringified assignment state
- Parameters: ()
- Return: (String)
- Function: rounds_until_state_transition
- Description: Rounds remaining in this state
- Parameters: ()
- Return: (card32)
- Function: is_idle_assignment
- Description: Is this the characters idle assignment?
- Parameters: ()
- Return: (bool)
- Description: World Power Tokens
- is_null_interface
- owning_faction
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: owning_faction
- Description: Token record key
- Parameters: (String token_key)
- Return: (RETURN_OPTIONAL_QUERY_FACTION_SCRIPT_INTERFACE)
- Description: Game options
- is_null_interface
- timeless_characters
- auto_resolve_all_battles
- fight_human_vs_human_battles_allowed
- fight_human_vs_ai_battles_allowed
- spectate_battles_allowed
- use_auto_resolve_for_tiebreak
- remote_drop_in_battles_enabled
- hotseat_mode_enabled
- legendary_mode_enabled
- battle_time_limit_in_seconds
- campaign_turn_time_limit_in_seconds
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: timeless_characters
- Description: Returns if timeless characters are enabled in the campaign
- Parameters: ()
- Return: (bool)
- Function: auto_resolve_all_battles
- Description: Returns if auto_resolve_all_battles is enabled in the campaign
- Parameters: ()
- Return: (bool)
- Function: fight_human_vs_human_battles_allowed
- Description: Returns if fight_human_vs_human_battles_allowed is enabled in the campaign
- Parameters: ()
- Return: (bool)
- Function: fight_human_vs_ai_battles_allowed
- Description: Returns if fight_human_vs_ai_battles_allowed is enabled in the campaign
- Parameters: ()
- Return: (bool)
- Function: spectate_battles_allowed
- Description: Returns if spectate_battles_allowed is enabled in the campaign
- Parameters: ()
- Return: (bool)
- Function: use_auto_resolve_for_tiebreak
- Description: Returns if use_auto_resolve_for_tiebreak is enabled in the campaign
- Parameters: ()
- Return: (bool)
- Function: remote_drop_in_battles_enabled
- Description: Returns if remote_drop_in_battles_enabled is enabled in the campaign
- Parameters: ()
- Return: (bool)
- Function: hotseat_mode_enabled
- Description: Returns if hot seat mode is enabled
- Parameters: ()
- Return: (bool)
- Function: legendary_mode_enabled
- Description: Returns if legendary mode is enabled
- Parameters: ()
- Return: (bool)
- Function: battle_time_limit_in_seconds
- Description: Returns the battle time limit in seconds, -1 if not set
- Parameters: ()
- Return: (int32)
- Function: campaign_turn_time_limit_in_seconds
- Description: Returns the campaign time limit in seconds, -1 if not set
- Parameters: ()
- Return: (int32)
- Description: SharedStatesManager
- is_null_interface
- get_bool_value
- get_float_value
- get_string_value
- Function: is_null_interface
- Description: Is this the Null Interface?
- Parameters: ()
- Return: (bool)
- Function: get_bool_value
- Description: Returns the state for the given key as bool. false if not present
- Parameters: (String key)
- Return: (bool)
- Function: get_float_value
- Description: Returns the state for the given key as float. 0.0f if not present
- Parameters: (String key)
- Return: (float32)
- Function: get_string_value
- Description: Returns the state for the given key as string. empty string if not present
- Parameters: (String key)
- Return: (String)