H7AdventureArmy¶
Class in MMH7Game · MMH7Game.H7AdventureArmy · native, config, perobjectconfig
Object › Actor › SkeletalMeshActor › SkeletalMeshCinematicActor › SkeletalMeshActorMAT › H7EditorMapObject › H7EditorArmy › H7AdventureArmy
Implements: H7ITooltipable, H7IGUIListenable, H7IQuestTarget, H7IStackContainer, H7ILocaParamizable
Subclasses: H7AdventureArmySpawnable, H7CaravanArmy
Using it from Lua
Constants¶
| Name | Value |
|---|---|
ADVENTURE_ARMY_NAME_KEY | "mName" |
CREATURE_FLAG_OFFSET | 550.0f |
HERO_FLAG_OFFSET | 550.0f |
NEUTRAL_ARMY_KEY | "TT_NEUTRAL_ARMY" |
NEUTRAL_ARMY_SECTION | "H7GFxActorTooltip" |
Properties¶
| Name | Type | Notes |
|---|---|---|
mAiControlUnits | array<H7Creature> | protected |
mAiDisableTrade | bool | protected |
mAiFollowUpSite | H7VisitableSite | |
mAiLiberatedSites | array<H7VisitableSite> | |
mAiOnIgnore | bool | protected |
mAIReplenishResouceStash | H7ResourceSet | protected |
mAiStayInAoC | int | protected |
mAiTension | array | protected |
mCalculatingReachability | bool | protected |
mCell | H7AdventureMapCell | protected |
mCellCoords | AdventureMapCellCoords | |
mCustomNameInst | string | transient, protected |
mDangerCells | array<H7AdventureMapCell> | protected |
mDiplomaticDisposition | H7StructsAndEnumsNative.EDispositionType | protected |
mDispositionTowardsPlayers | array<H7StructsAndEnumsNative.EPlayerNumber> | protected |
mFlag | H7Flag | protected |
mGarrisonedSite | H7VisitableSite | protected |
mGrowthOverwrite | int | protected |
mHero | H7AdventureHero | protected |
mHeroAbilityArchetypes | array<H7BaseAbility> | |
mHeroAbilityIDs | array | |
mHeroArchetypeReference | string | protected |
mHeroEventParam | H7HeroEventParam | protected |
mHeroSpellArchetypes | array<H7BaseAbility> | |
mHeroSpellIDs | array | |
mHeroStruct | SavegameHeroStruct | protected |
mHeroVolatileSpellArchetypes | array<H7BaseAbility> | |
mHeroVolatileSpellIDs | array | |
mIndexInArmiesList | int | |
mIsAttacker | bool | protected |
mIsBeingRemoved | bool | protected |
mIsChilling | bool | protected |
mIsCustomNameAvailable | bool | transient, editconst, private |
mIsDead | bool | protected |
mIsDefender | bool | protected |
mIsHidden | bool | protected |
mIsInCombat | bool | protected |
mLocked | bool | protected |
mMergePools | array<H7MergePool> | protected |
mName | string | const, localized, protected |
mNegotiatedArmies | array<NegotiationData> | protected |
mNumTimesAlreadyRetreated | int | protected |
mPathfinder | H7AdventureMapPathfinder | protected |
mPlayerEventParam | H7PlayerEventParam | protected |
mQuestFlag | H7Flag | protected |
mReachabilityCheckDone | bool | protected |
mReachableArmies | array<H7AdventureArmy> | protected |
mReachableArmiesDistances | array | protectedwrite |
mReachableSites | array<H7VisitableSite> | protected |
mReachableSitesDistances | array | protectedwrite |
mSaveRotation | Rotator | protected |
mShip | H7Ship | protected |
mSuppressCritterGrowth | bool | |
mTempStackArray | array<H7BaseCreatureStack> | protected |
mTimeOut | int | protected |
mUseCustomName | bool | protected |
mVisitableSite | H7VisitableSite | protected |
mVisitedAdventureCells | int | protected |
Functions¶
| Name | Declaration |
|---|---|
AddAbilityArchetypeRefs | native function AddAbilityArchetypeRefs(H7BaseAbility Ability, string ref, int Id) |
AddAiControlUnit | function AddAiControlUnit(H7Creature Creature) |
AddAiLiberatedSite | function AddAiLiberatedSite(H7VisitableSite S) |
AddNegotiatedArmy | function AddNegotiatedArmy(NegotiationData Data) |
AddQuestFlag | function AddQuestFlag() |
AddRestUnits | function AddRestUnits(H7BaseCreatureStack Stack, optional int Value) |
AddSpellArchetypeRefs | native function AddSpellArchetypeRefs(H7BaseAbility Ability, string ref, int Id) |
AddStack | function AddStack(int Index, H7BaseCreatureStack Stack) |
AddStackToMergePool | function AddStackToMergePool(H7BaseCreatureStack addedStack, string PoolKey) |
AddVolatileSpellArchetypeRefs | native function AddVolatileSpellArchetypeRefs(H7BaseAbility Ability, string ref, int Id) |
Attila | native function Attila() |
CalculateReachability | function CalculateReachability() |
CanMergeArmy | function bool CanMergeArmy(H7AdventureArmy Army) |
CanMergeStacks | function bool CanMergeStacks(array<H7BaseCreatureStack> stacks) |
CanRetreat | function bool CanRetreat() |
ChangeFlag | function ChangeFlag() |
CleanAllCombatMergePools | function CleanAllCombatMergePools() |
ClearAiLiberatedSites | function ClearAiLiberatedSites(H7VisitableSite S) |
ClearNegotiationData | native function ClearNegotiationData() |
ClearQuestFlag | function ClearQuestFlag() |
CreateHero | function CreateHero(optional SavegameHeroStruct SaveGameData) |
CreateMergePool | private final function int CreateMergePool(string PoolKey) |
DataChanged | function DataChanged(optional string cause) |
DecrementTimeOut | function DecrementTimeOut() |
DeleteMergePool | function DeleteMergePool(string PoolKey) |
Destroyed | simulated event Destroyed() |
DistributeUnits | function DistributeUnits(H7BaseCreatureStack Stack) |
DumpCurrentState | function DumpCurrentState() |
EnableAdventureIdleBridge | native function EnableAdventureIdleBridge() |
EnqueueInterruptCommand | function EnqueueInterruptCommand() |
GetAiFollowUpSite | function H7VisitableSite GetAiFollowUpSite() |
GetAiOnIgnore | function bool GetAiOnIgnore() |
GetAIReplenishStash | function H7ResourceSet GetAIReplenishStash() |
GetAiStayInAoC | function int GetAiStayInAoC() |
GetAiTensionValue | function float GetAiTensionValue(H7StructsAndEnumsNative.EAdvActionID aid) |
GetAMergePool | function H7MergePool GetAMergePool() |
GetAreaOfControlID | function int GetAreaOfControlID() |
GetArmyCost | function array<H7ResourceQuantity> GetArmyCost(float mod) |
GetBaseCreatureStacksAfterCombat | function array<H7BaseCreatureStack> GetBaseCreatureStacksAfterCombat(H7CombatArmy combatArmy, H7StructsAndEnumsNative.EPlayerNumber enemyPlayer, out array<H7CreatureCounter> creatureLosses, out int Losses, optional bool useDereferencedStack = false) |
GetCell | function H7AdventureMapCell GetCell() |
GetCurrentPosition | function H7AdventureMapCell GetCurrentPosition() |
GetDiplomaticDisposition | function H7StructsAndEnumsNative.EDispositionType GetDiplomaticDisposition() |
GetEditorHero | function H7EditorHero GetEditorHero() |
GetEmptySlotIndex | function int GetEmptySlotIndex() |
GetFlag | function H7Flag GetFlag() |
GetFreeSlotCount | function int GetFreeSlotCount() |
GetGarrisonedSite | function H7VisitableSite GetGarrisonedSite() |
GetGarrisonedSiteIconPath | function string GetGarrisonedSiteIconPath() |
GetHero | function H7AdventureHero GetHero() |
GetHeroFlagLocation | event Vector GetHeroFlagLocation() |
GetHeroPower | function float GetHeroPower() |
GetLocalGuardAfterCombatAsString | function string GetLocalGuardAfterCombatAsString(H7CombatArmy combatArmy) |
GetMergePoolIndex | private final function int GetMergePoolIndex(string PoolKey) |
GetName | function string GetName() |
GetPathfinder | function H7AdventureMapPathfinder GetPathfinder() |
GetPlayerDispositions | function GetPlayerDispositions(out array<H7StructsAndEnumsNative.EPlayerNumber> playerDisposition) |
GetPoolCount | function int GetPoolCount() |
GetQuestTargetID | function int GetQuestTargetID() |
GetReachableArmies | function array<H7AdventureArmy> GetReachableArmies() |
GetReachableArmiesDistances | function array |
GetReachableArmyDistance | function float GetReachableArmyDistance(H7AdventureArmy Army) |
GetReachableSiteDistance | function float GetReachableSiteDistance(H7VisitableSite Site) |
GetReachableSites | function array<H7VisitableSite> GetReachableSites() |
GetReachableSitesDistances | function array |
GetShip | function H7Ship GetShip() |
GetStackByIndex | function H7BaseCreatureStack GetStackByIndex(int Index) |
GetStackCount | function int GetStackCount(H7BaseCreatureStack Stack) |
GetStackTypeIndex | function int GetStackTypeIndex(H7BaseCreatureStack Stack) |
GetTooltipData | function H7TooltipData GetTooltipData(optional bool extendedVersion) |
GetVisitableSite | function H7VisitableSite GetVisitableSite() |
GetVisitedCellCount | function int GetVisitedCellCount() |
GetWarUnitKillListWhenBuying | function array<H7EditorWarUnit> GetWarUnitKillListWhenBuying(bool attackHybrid, H7Town Town) |
GrowCritterArmy | function GrowCritterArmy() |
GrowEveryCritterArmy | static function GrowEveryCritterArmy() |
GUIAddListener | function GUIAddListener(GFxObject Data, optional H7StructsAndEnums.H7ListenFocus Focus) |
GUIWriteInto | function GUIWriteInto(GFxObject Data, optional H7StructsAndEnums.H7ListenFocus Focus, optional H7GFxUIContainer flashFactory) |
HandleAddToMap | function HandleAddToMap() |
HandleScouting | event HandleScouting(optional int R = -1, optional H7AdventureMapCell cell, optional bool isInit = false) |
HandleVisitSlotLeaving | function HandleVisitSlotLeaving() |
HasCreature | function bool HasCreature(optional H7Creature Creature) |
HasEmptySlot | function bool HasEmptySlot() |
HasLocalGuardBacking | function bool HasLocalGuardBacking() |
HasNegotiatedWith | function bool HasNegotiatedWith(H7AdventureArmy Army, out int lastNegotiationResult) |
HasShip | function bool HasShip() |
HasStackType | function bool HasStackType(H7BaseCreatureStack Stack) |
HasUnits | native function bool HasUnits(optional bool excludeLocalGuard) |
HeroMoved | event HeroMoved(bool isInit) |
HideArmy | native function HideArmy(optional bool noHero) |
IncNumTimesAlreadyRetreated | function IncNumTimesAlreadyRetreated() |
Init | event Init(H7Player PlayerOwner, optional H7AdventureMapCell StartPos, optional Vector garrisonLocation, optional bool pruneStacks = true) |
IsACaravan | event bool IsACaravan() |
IsAiLiberatedSite | function bool IsAiLiberatedSite(H7VisitableSite S) |
IsAITimeOut | function bool IsAITimeOut() |
IsAITradeDisabled | function bool IsAITradeDisabled() |
IsAllyOf | native function bool IsAllyOf(H7Player ply) |
IsArmyReachable | function bool IsArmyReachable(H7AdventureArmy Army) |
IsAttacker | function bool IsAttacker() |
IsBeingRemoved | function bool IsBeingRemoved() |
IsChilling | function bool IsChilling() |
IsDead | function bool IsDead() |
IsDefender | function bool IsDefender() |
IsEnemyOf | function bool IsEnemyOf(H7Player ply) |
IsGarrisoned | native function bool IsGarrisoned() |
IsGarrisonedButOutside | function bool IsGarrisonedButOutside() |
IsHidden | function bool IsHidden() |
IsInCombat | function bool IsInCombat() |
IsInScoutingRangeOfLocalPlayer | function bool IsInScoutingRangeOfLocalPlayer() |
IsInShelter | function bool IsInShelter() |
IsLocked | function bool IsLocked() |
IsMovable | function bool IsMovable() |
IsSiteReachable | function bool IsSiteReachable(H7VisitableSite Site) |
IsTheFirstStackOfItsKind | function bool IsTheFirstStackOfItsKind(H7BaseCreatureStack Stack) |
IsUnitControlledByAi | function bool IsUnitControlledByAi(H7Creature Creature) |
JoinArmy | function JoinArmy(H7AdventureArmy armyJoiner, bool join, bool canMerge) |
JoinArmyComplete | function JoinArmyComplete(H7AdventureArmy armyJoiner, bool join, bool canMerge) |
LocalizeName | function LocalizeName() |
MergeArmiesAI | function MergeArmiesAI(H7AdventureArmy receivingArmy) |
MergeArmiesAIComplete | function MergeArmiesAIComplete(H7AdventureArmy receivingArmy, int Threshold) |
MergeArmy | function MergeArmy(H7AdventureArmy Army, optional bool transferOnly) |
MergeStacks | function MergeStacks(array<H7BaseCreatureStack> stacks) |
MergeToTargetStackCount | function MergeToTargetStackCount(int Count) |
ModAiTensionValue | function ModAiTensionValue(H7StructsAndEnumsNative.EAdvActionID aid, H7AiTensionParameter tp) |
OnAttackArmy | function OnAttackArmy(H7SeqAct_AttackArmy Action) |
OnInteractWithBuilding | function OnInteractWithBuilding(H7SeqAct_InteractWithBuilding Action) |
OnInterruptAction | function OnInterruptAction(H7SeqAct_InterruptAction Action) |
OnMoveTo | function OnMoveTo(H7AdventureMapCell Target, bool UseMovementPoints, bool Teleport, bool moveNear, bool camFollow) |
OnMoveToArmy | function OnMoveToArmy(H7SeqAct_MoveToArmy Action) |
OnMoveToBuilding | function OnMoveToBuilding(H7SeqAct_MoveToBuilding Action) |
OnMoveToTile | function OnMoveToTile(H7SeqAct_MoveToTile Action) |
OnRotateArmy | function OnRotateArmy(H7SeqAct_RotateArmy Action) |
OnStartNpcScene | function OnStartNpcScene(H7SeqAct_StartNpcScene Action) |
OnTeleport | simulated function OnTeleport(SeqAct_Teleport Action) |
OnToggleHidden | simulated function OnToggleHidden(SeqAct_ToggleHidden Action) |
PackStacks | function PackStacks() |
PostBeginPlay | simulated function PostBeginPlay() |
PostCreateHero | function PostCreateHero() |
PostSerialize | event PostSerialize() |
RemoveAbilityArchetypeRefs | native function RemoveAbilityArchetypeRefs(H7BaseAbility Ability, string ref, int Id) |
RemoveAiLiberatedSite | function RemoveAiLiberatedSite(H7VisitableSite S) |
RemoveAllCreatureStacks | function RemoveAllCreatureStacks() |
RemoveAllCreatureStacksComplete | function RemoveAllCreatureStacksComplete() |
RemoveArmyAfterCombat | function RemoveArmyAfterCombat() |
RemoveCreatureStackByIndex | function RemoveCreatureStackByIndex(int Index) |
RemoveCreatureStackByIndexComplete | function RemoveCreatureStackByIndexComplete(int Index) |
RemoveSpellArchetypeRefs | native function RemoveSpellArchetypeRefs(H7BaseAbility Ability, string ref, int Id) |
RemoveVolatileSpellArchetypeRefs | native function RemoveVolatileSpellArchetypeRefs(H7BaseAbility Ability, string ref, int Id) |
ResetAIReplenishStash | function ResetAIReplenishStash() |
ResetAllCreatureStack | function ResetAllCreatureStack() |
ResetNumTimesAlreadyRetreated | function ResetNumTimesAlreadyRetreated() |
RestoreTransform | event RestoreTransform() |
SaveTransform | event SaveTransform() |
Select | native function Select(bool doSelect, optional bool doFocus) |
SetAiFollowUpSite | function SetAiFollowUpSite(H7VisitableSite S) |
SetAiOnIgnore | function SetAiOnIgnore(bool val) |
SetAiStayInAoC | function SetAiStayInAoC(int val) |
SetAiTensionValue | function SetAiTensionValue(H7StructsAndEnumsNative.EAdvActionID aid, float val) |
SetAITradeDisabled | function SetAITradeDisabled(bool val) |
SetArmyLocked | function SetArmyLocked(bool Value) |
SetCell | native function SetCell(H7AdventureMapCell newCellPos, optional bool updateHeroWorldLocation = true, optional bool registerCell = true, optional bool isInit = false) |
SetChilling | function SetChilling(bool val) |
SetDiplomaticDisposition | function SetDiplomaticDisposition(H7StructsAndEnumsNative.EDispositionType Value) |
SetGarrisonedSite | function SetGarrisonedSite(H7VisitableSite Value) |
SetHoverHighlight | function SetHoverHighlight(bool Active) |
SetIndexOfArmy | function SetIndexOfArmy(int NewIndex) |
SetIsAttacker | function SetIsAttacker(bool Value) |
SetIsBeingRemoved | function SetIsBeingRemoved(bool Value) |
SetIsDead | event SetIsDead(bool newIsDead, optional bool spamEvent = true) |
SetIsDefender | function SetIsDefender(bool Value) |
SetIsInCombat | function SetIsInCombat(bool Value) |
SetNPC | function SetNPC(bool IsNPC) |
SetPlayer | function SetPlayer(H7Player NewPlayer) |
SetReachableArmies | function SetReachableArmies(array<H7AdventureArmy> armies) |
SetReachableArmiesDistances | function SetReachableArmiesDistances(array |
SetReachableSites | function SetReachableSites(array<H7VisitableSite> sites) |
SetReachableSitesDistances | function SetReachableSitesDistances(array |
SetShip | function SetShip(H7Ship shippity) |
SetTimeOut | function SetTimeOut(int val) |
SetVisibility | function SetVisibility(bool show) |
SetVisitableSite | function SetVisitableSite(H7VisitableSite Site) |
ShipMoved | event ShipMoved() |
ShowArmy | native function ShowArmy() |
SortArmyListByStrength | static native function SortArmyListByStrength(out array<H7AdventureArmy> alist) |
SortStackPoolByCreaturePower | function int SortStackPoolByCreaturePower(H7BaseCreatureStack A, H7BaseCreatureStack B) |
SortStackPoolMerge | function int SortStackPoolMerge(H7BaseCreatureStack A, H7BaseCreatureStack B) |
SpawnHeroFlag | function SpawnHeroFlag() |
StartCalculateReachability | function StartCalculateReachability() |
StartRemoveEffect | function StartRemoveEffect() |
SwitchToBoatVisuals | native function SwitchToBoatVisuals() |
Tick | event Tick(float DeltaTime) |
ToggleVisibility | function ToggleVisibility() |
TransferItems | function TransferItems(H7AdventureArmy receivingArmy) |
UnGarrison | function UnGarrison() |
UnifyStacks | function UnifyStacks() |
UnifyStacksComplete | function UnifyStacksComplete() |
UpdateAfterCombat | function int UpdateAfterCombat(H7CombatArmy combatArmy, H7StructsAndEnumsNative.EPlayerNumber enemyPlayer, optional bool isQuickCombat = false) |
UpdateArmyCameraFocus | event UpdateArmyCameraFocus() |
UpdateAurasByArmy | event UpdateAurasByArmy(H7AdventureMapCell oldCellPos, H7AdventureMapCell newCellPos) |
UpdateLocalGuardAfterCombat | function UpdateLocalGuardAfterCombat(H7CombatArmy combatArmy) |
UpdateLocalGuardAfterCombatByBaseCreatureStacks | function UpdateLocalGuardAfterCombatByBaseCreatureStacks(H7CombatArmy combatArmy) |
UpdateMergePool | function UpdateMergePool(string PoolKey, array<H7BaseCreatureStack> PoolStacks) |
Default values¶
mCellCoords=(Coordinates=(X=-1,Y=-1),GridIndex=-1)
mHeroStruct=(HasData=false,Level=0,XP=0,Spirit=0,Magic=0,AttackBase=0,DefenseBase=0,ArcaneKnowledgeBase=0,CurrentMovementPoints=0.0000000,CurrentMana=0,MaxManaBonus=0,ManaRegenBase=0,SkillPoints=0,IsHero=false,PlayerNumber=0,Id=0,HasTearOfAsha=false,HasFinishedTurn=false,HasCastedSpellThisTurn=fa...
mGrowthOverwrite=-1
mAiStayInAoC=-1
mIndexInArmiesList=-1