H7CombatArmy¶

Class in MMH7Game · MMH7Game.H7CombatArmy · native, config

Object › Actor › SkeletalMeshActor › SkeletalMeshCinematicActor › SkeletalMeshActorMAT › H7EditorMapObject › H7EditorArmy › H7CombatArmy

Using it from Lua

h7.find_all("H7CombatArmy")            -- live instances
h7.find_class("MMH7Game.H7CombatArmy")   -- the class
h7.hook("MMH7Game.H7CombatArmy.AddCreatureStackOnMap", fn)

Structs¶

SAmbushDeploymentCircle

Field	Type
`Points`	`array<IntPoint>`

Defaults

Points=none

SClockwiseCircleDetectionPoint

Field	Type
`coord`	`IntPoint`
`distanceSq`	`float`
`relativeCoordToCenter`	`Vector2D`

Defaults

coord=(X=0,Y=0)
distanceSq=0.0000000
relativeCoordToCenter=(X=0.0000000,Y=0.0000000)

Properties¶

Name	Type	Notes
`AmbushDeployRelativeCellOffset_1x1`	`array<IntPoint>`	const
`mAdvHero`	`H7AdventureHero`	protected
`mCreatureStacks`	`array<H7CreatureStack>`	protected
`mFactionsInArmy`	`array<H7Faction>`	protected
`mHero`	`H7CombatHero`	protected
`mInitialTotalLife`	`int`	protected
`mIsAttacker`	`bool`	protected
`mIsForQuickCombat`	`bool`	protected
`mRuneUnits`	`array<H7RuneUnit>`	protected
`mTotalSelectionCount`	`int`	protected
`mTowers`	`array<H7TowerUnit>`	protected
`mWarUnits`	`array<H7WarUnit>`	protected
`mWonBattle`	`bool`	protected

Functions¶

Name	Declaration
`AddCreatureStackOnMap`	`function AddCreatureStackOnMap(H7CreatureStack Stack)`
`AddTower`	`function AddTower(H7TowerUnit tower)`
`AreAllCreaturesDead`	`function bool AreAllCreaturesDead()`
`AutodeployCreatures`	`function AutodeployCreatures()`
`AutoplaceUnits`	`function bool AutoplaceUnits()`
`AutoplaceUnitsAmbush`	`function bool AutoplaceUnitsAmbush()`
`CalculateInitialTotalLife`	`function CalculateInitialTotalLife()`
`Check2x2CellIdxValid`	`function bool Check2x2CellIdxValid(int x_topleft, int y_topleft, int W, int H)`
`CheckOccupationFree2x2`	`function bool CheckOccupationFree2x2(out array<H7CreatureStack> occupation, int X, int Y, int W)`
`CleanAllUnitsAbilitiesAfterCombat`	`function CleanAllUnitsAbilitiesAfterCombat()`
`CreateStacks`	`protected function CreateStacks(array<H7BaseCreatureStack> baseStacks)`
`CreatureRangedFirstSort`	`delegate int CreatureRangedFirstSort(H7CreatureStack A, H7CreatureStack B)`
`CreatureVerticalPositionSort`	`delegate int CreatureVerticalPositionSort(H7CreatureStack A, H7CreatureStack B)`
`DeployCreatures`	`function DeployCreatures()`
`Destroyed`	`simulated event Destroyed()`
`DestroyStackGhosts`	`function DestroyStackGhosts()`
`DoVictory`	`function DoVictory()`
`FlushAllAbilityFX`	`function FlushAllAbilityFX()`
`GenerateAmbushDeployCellOffset2x2`	`function array<IntPoint> GenerateAmbushDeployCellOffset2x2(int W, int H)`
`GenerateClockwiseCirclesFromArea`	`function array<SAmbushDeploymentCircle> GenerateClockwiseCirclesFromArea(out int Size)`
`GetAdventureHero`	`function H7AdventureHero GetAdventureHero()`
`GetArmyDamagePool`	`native function int GetArmyDamagePool()`
`GetArmyGoldValue`	`function int GetArmyGoldValue()`
`GetArmyMeleeDamage`	`native function int GetArmyMeleeDamage()`
`GetArmyRangedDamage`	`native function int GetArmyRangedDamage()`
`GetBaseStackBySpawnedStack`	`function H7BaseCreatureStack GetBaseStackBySpawnedStack(H7CreatureStack spawnedStack)`
`GetCombatHero`	`function H7CombatHero GetCombatHero()`
`GetCreatureStackFromDeployment`	`function H7CreatureStack GetCreatureStackFromDeployment(H7StackDeployment deploymentStack)`
`GetCreatureStackIndex`	`function int GetCreatureStackIndex(H7CreatureStack Stack)`
`GetCreatureStacks`	`function array<H7CreatureStack> GetCreatureStacks()`
`GetDeployedCreatureStacks`	`function array<H7CreatureStack> GetDeployedCreatureStacks()`
`GetEditorHero`	`function H7EditorHero GetEditorHero()`
`GetFactionsInArmyCount`	`function int GetFactionsInArmyCount(optional bool checkForDeployed = false)`
`GetHero`	`function H7CombatHero GetHero()`
`GetHeroTag`	`protected function name GetHeroTag()`
`GetInitialTotalLife`	`function int GetInitialTotalLife()`
`GetKilledCreatureStacks`	`function GetKilledCreatureStacks(out array<H7CreatureStack> killedStacks)`
`GetKilledCreaturesXP`	`function int GetKilledCreaturesXP()`
`GetOffGridDeployables`	`function array<H7IOffGridDeployable> GetOffGridDeployables()`
`GetPercentTotalLife`	`function int GetPercentTotalLife(bool inverted)`
`GetRuneUnits`	`function array<H7RuneUnit> GetRuneUnits()`
`GetRuneUnitTag`	`protected function name GetRuneUnitTag()`
`GetStackBySourceSlotId`	`function H7CreatureStack GetStackBySourceSlotId(int baseStackindex)`
`GetStackOrientation`	`function Rotator GetStackOrientation()`
`GetStackPower`	`function float GetStackPower(H7CreatureStack Stack)`
`GetSurrenderPrice`	`function int GetSurrenderPrice()`
`GetSurvivingCreatureStacks`	`function GetSurvivingCreatureStacks(out array<H7CreatureStack> livingStacks)`
`GetTotalHealth`	`function int GetTotalHealth()`
`GetTotalSelectionCount`	`function int GetTotalSelectionCount()`
`GetTowers`	`function array<H7TowerUnit> GetTowers()`
`GetWarUnits`	`function array<H7WarUnit> GetWarUnits()`
`GetWarUnitTag`	`protected function name GetWarUnitTag()`
`HideStacks`	`function HideStacks()`
`InitStacksHeroEffects`	`protected function InitStacksHeroEffects()`
`IsAttacker`	`native function bool IsAttacker()`
`isForQuickCombat`	`function bool isForQuickCombat()`
`IsOwnedByPlayerMP`	`function bool IsOwnedByPlayerMP()`
`KillRemainingStacks`	`function KillRemainingStacks()`
`LoadAllAbilityFX`	`function LoadAllAbilityFX()`
`PlaceCreaturesAmbush`	`function PlaceCreaturesAmbush()`
`PlaceCreaturesBeingAmbushed`	`function PlaceCreaturesBeingAmbushed()`
`PlaceHero`	`protected function PlaceHero()`
`PlaceRuneUnits`	`protected function PlaceRuneUnits()`
`PlaceStackOnGrid`	`function bool PlaceStackOnGrid(int slotID)`
`PlaceWarUnits`	`protected function PlaceWarUnits()`
`RefreshAllUnits`	`function bool RefreshAllUnits()`
`RememberDeployStateOffGridUnit`	`function RememberDeployStateOffGridUnit(H7IOffGridDeployable Unit, bool deployed)`
`RemoveDeadCreatureStackDeploymentSlotID`	`function RemoveDeadCreatureStackDeploymentSlotID()`
`RemoveStackFromGrid`	`function RemoveStackFromGrid(int slotID)`
`RemoveStacks`	`protected function RemoveStacks(array<H7BaseCreatureStack> baseStacks)`
`RemoveTower`	`function RemoveTower(H7TowerUnit tower)`
`ResetCreatureDeployPos`	`function ResetCreatureDeployPos(H7BaseCreatureStack Stack)`
`SaveTacticsDeployment`	`function SaveTacticsDeployment()`
`SetAdventureHero`	`function SetAdventureHero(H7AdventureHero Value)`
`SetCreatureStackCell`	`function SetCreatureStackCell(H7CreatureStack Stack, int cellX, int cellY)`
`SetCreatureStacks`	`function SetCreatureStacks(array<H7CreatureStack> stacks)`
`SetHero`	`function SetHero(H7CombatHero Value)`
`SetIsAttacker`	`function SetIsAttacker(bool IsAttacker)`
`SetIsForQuickCombat`	`function SetIsForQuickCombat(bool val)`
`SetOccupation2x2`	`function SetOccupation2x2(out array<H7CreatureStack> occupation, int X, int Y, int W, H7CreatureStack Stack)`
`SetWonBattle`	`function SetWonBattle(bool Value)`
`ShowStacks`	`function ShowStacks(optional bool updateHealthAfterCombatStart = false)`
`SortPointsByAngle12OClock`	`delegate int SortPointsByAngle12OClock(SClockwiseCircleDetectionPoint P1, SClockwiseCircleDetectionPoint P2)`
`SortPointsByDistance`	`delegate int SortPointsByDistance(SClockwiseCircleDetectionPoint P1, SClockwiseCircleDetectionPoint P2)`
`SpawnRuneUnit`	`protected function SpawnRuneUnit(H7CombatMapGridController Grid, H7EditorRuneUnit Template)`
`SpawnStack`	`function H7CreatureStack SpawnStack(H7BaseCreatureStack templateStack)`
`SpawnWarfareUnit`	`protected function SpawnWarfareUnit(H7CombatMapGridController Grid, H7EditorWarUnit Template)`
`TeleportSpellWasCanceled`	`function TeleportSpellWasCanceled()`
`TriggerOnArmy`	`function TriggerOnArmy(H7StructsAndEnumsNative.ETrigger eventTrigger, bool simulate)`
`TurnChanged`	`function TurnChanged()`
`UndeployOffGridUnits`	`function UndeployOffGridUnits()`
`UpdateCreaturesDeployedState`	`function UpdateCreaturesDeployedState(optional bool removeUndeployed = true)`
`UpdateCreatureStacksGUI`	`function UpdateCreatureStacksGUI()`
`UpdatedAlliesAndEnemies`	`function UpdatedAlliesAndEnemies()`
`UpdateHealthpoints`	`protected function UpdateHealthpoints()`
`UpdateOffGridUnitDeployedState`	`function UpdateOffGridUnitDeployedState()`
`WonBattle`	`function bool WonBattle()`

Default values¶

AmbushDeployRelativeCellOffset_1x1(0)=none
AmbushDeployRelativeCellOffset_1x1(1)=none
AmbushDeployRelativeCellOffset_1x1(2)=none
AmbushDeployRelativeCellOffset_1x1(3)=none
AmbushDeployRelativeCellOffset_1x1(4)=none
AmbushDeployRelativeCellOffset_1x1(5)=(mHorseMesh=begin object name=Mesh_2 class=SkeletalMeshComponent
ReplacementPrimitive=none
LightEnvironment=DynamicLightEnvironmentComponent'Default__H7CombatArmy.LightEnvironment0'
mHorseMesh=Mesh_2,mWeaponMesh=begin object name=Mesh_3 class=StaticMeshComponent
ReplacementPrimitive=none
LightEnvironment=DynamicLightEnvironmentComponent'Default__H7CombatArmy.LightEnvironment0'
mWeaponMesh=Mesh_3,mWeaponSkMesh=begin object name=Mesh_4 class=SkeletalMeshComponent
ReplacementPrimitive=none
LightEnvironment=DynamicLightEnvironmentComponent'Default__H7CombatArmy.LightEnvironment0'
mWeaponSkMesh=Mesh_4,AnimNodeSeqComp=AnimNodeSequence'Default__H7CombatArmy.AnimNode',mMesh=begin object name=Mesh class=StaticMeshComponent
ReplacementPrimitive=none
mMesh=Mesh,mFX=begin object name=ParticleSystem class=ParticleSystemComponent
ReplacementPrimitive=none
mFX=ParticleSystem,mDynamicLightEnv=DynamicLightEnvironmentComponent'Default__H7CombatArmy.LightEnvironment0',SkeletalMeshComponent=begin object name=SkeletalMeshComponent0 class=SkeletalMeshComponent
ReplacementPrimitive=none
LightEnvironment=DynamicLightEnvironmentComponent'Default__H7CombatArmy.LightEnvironment0'
HiddenGame=true
HiddenEditor=true
SkeletalMeshComponent=SkeletalMeshComponent0,LightEnvironment=DynamicLightEnvironmentComponent'Default__H7CombatArmy.LightEnvironment0',FacialAudioComp=AudioComponent'Default__H7CombatArmy.FaceAudioComponent',Components=Components(0)=AudioComponent'Default__H7CombatArmy.FaceAudioComponent'
Components(1)=DynamicLightEnvironmentComponent'Default__H7CombatArmy.LightEnvironment0'

Inherited¶

From	Members
H7EditorArmy	Properties: cMaxArmySize, mAiIsBorderControl, mBaseCreatureStacks, mCreatureStackProperties, mCustomizeHeroArchetype, mDeployment, mDisableFleeSurrender, mEmitterPoolParticleComps, mForceManualCombat, mHeroArchetype, mHorseMesh, mIsAmbush, mIsNPC, mIsStarterHero, mIsTalking, mLlamaAnims, mLlamaMesh, mOnlyDynamicLights, mPlayer, mPlayerNumber, mSiegeUnit, mUseXPStrength, mWarUnitTemplates, mWeaponMesh, mWeaponSkMesh, mXPStrength Functions: AddCreatureStack, AddWarUnit, AddWarUnitTemplate, AllocatePooledEmitter, CacheAnimNodes, CanFleeOrSurrender, CheckFreeArmySlot, CleanComponents, CleanupEmitterPools, ClearCreatureStackProperties, ClearMeshData, CreateBaseCreatureStack, CreateCombatArmy, CreateCombatArmyUsingAdventureArmy, CreateCreatureStackProperies, CreateHero, CreateStackPropertyFromBase, EnsureBaseStackSlotExistence, GetAiIsBorderControl, GetBaseCreatureStackIndex, GetBaseCreatureStackLength, GetBaseCreatureStacks, GetBaseCreatureStacksDereferenced, GetBaseStackBySourceSlotId, GetCreatureAmount, GetCreatureAmountOfTier, GetCreatureAmountTotal, GetCreaturePropertyStrength, GetCreatureStackProperties, GetDeployment, GetEditorHero, GetExperienceForDefeating, GetHeroPower, GetHeroStrengthValue, GetHeroTemplate, GetHeroTemplateSource, GetIndexOfStack, GetMaxArmySize, GetNumberOfFilledSlots, GetNumberOfMeleeStacks, GetPlayer, GetPlayerNumber, GetRandomCreatureStackSize, GetStackByIDString, GetStackByName, GetStrengthValue, GetStrongestCreature, GetStrongestPropertyCreature, GetWarUnitByType, GetWarUnitTemplates, HasHybridWarUnit, HasWarUnitType, Init, InitRandomValues, InsertCreatureStack, IsForcingManualCombat, IsNPC, IsStarterHero, IsTalking, LoadMeshes, OnPooledAttachedParticleSystemFinished, OverrideDeploymentFromBaseStacks, PlayParticleEffect, PostBeginPlay, PostCreateHero, PrintStateToLog, PruneStackProperties, PutCreatureStackToEmptySlot, RecyclePooledEmitter, RemoveWarUnit, SetAiIsBorderControl, SetArmyIsAmbush, SetBaseCreatureStacks, SetBaseCreatureStacksToCopy, SetCell, SetCreatureStackProperties, SetDeployment, SetForcingManualCombat, SetHeroTemplate, SetNPC, SetPlayer, SetStarterHero, SetTalking, SetWarUnitTemplates, SplitCreatureStackToEmptySlot, SplitCreatureStackToEmptySlotComplete, SyncBaseStackStartingSizeToCurrentSize, TransferCreatureStacksByArmy, TransferCreatureStacksByArmyComplete, UpdateMeshes, UpdateWeaponAttachments, UseLlamaMesh
H7EditorMapObject	Properties: AnimNodeSeqComp, mDynamicLightEnv, mFX, mHideMeshAndFX, mMesh, mShouldOutlineSkelMesh, mSnapToGroundType, mSnapType, mTerrainOffset Functions: GetFX, GetMesh, GetMeshComp, SetMesh, SetShouldHideMeshAndFX, SetVisibility, ToggleVisibility
SkeletalMeshActorMAT	1 properties, 13 functions
SkeletalMeshCinematicActor	0 properties, 0 functions
SkeletalMeshActor	15 properties, 28 functions
Actor	156 properties, 262 functions
Object	13 properties, 308 functions