H7EditorArmy¶

Class in MMH7Game · MMH7Game.H7EditorArmy · native, config

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

Implements: H7DynGridObjInterface, H7IOwnable, H7IAliasable

Subclasses: H7AdventureArmy, H7CombatArmy

Using it from Lua

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

Constants¶

Name	Value
`MAX_ARMY_SIZE`	`7`

Properties¶

Name	Type	Notes
`cMaxArmySize`	`int`	config, editconst, protected
`mAiIsBorderControl`	`bool`	protected
`mBaseCreatureStacks`	`array<H7BaseCreatureStack>`	protected
`mCreatureStackProperties`	`array<CreatureStackProperties>`	protected
`mCustomizeHeroArchetype`	`bool`	private
`mDeployment`	`H7Deployment`	protected
`mDisableFleeSurrender`	`bool`
`mEmitterPoolParticleComps`	`array`	protected
`mForceManualCombat`	`bool`
`mHeroArchetype`	`H7EditorHero`	protected
`mHorseMesh`	`SkeletalMeshComponent`	protectedwrite
`mIsAmbush`	`bool`
`mIsNPC`	`bool`
`mIsStarterHero`	`bool`	protected
`mIsTalking`	`bool`
`mLlamaAnims`	`AnimSet`
`mLlamaMesh`	`SkeletalMesh`
`mOnlyDynamicLights`	`bool`
`mPlayer`	`H7Player`	protected
`mPlayerNumber`	`H7StructsAndEnumsNative.EPlayerNumber`	protected
`mSiegeUnit`	`H7EditorWarUnit`	protected
`mUseXPStrength`	`bool`	protected
`mWarUnitTemplates`	`array<H7EditorWarUnit>`	protected
`mWeaponMesh`	`StaticMeshComponent`	protectedwrite
`mWeaponSkMesh`	`SkeletalMeshComponent`	protectedwrite
`mXPStrength`	`int`	protected

Functions¶

Name	Declaration
`AddCreatureStack`	`function AddCreatureStack(H7BaseCreatureStack Stack, optional bool isInit = false)`
`AddWarUnit`	`function AddWarUnit(H7EditorWarUnit warUnit)`
`AddWarUnitTemplate`	`function AddWarUnitTemplate(H7EditorWarUnit warUnit)`
`AllocatePooledEmitter`	`native function AllocatePooledEmitter(ParticleSystemComponent PSC)`
`CacheAnimNodes`	`simulated function CacheAnimNodes()`
`CanFleeOrSurrender`	`function bool CanFleeOrSurrender()`
`CheckFreeArmySlot`	`function bool CheckFreeArmySlot()`
`CleanComponents`	`native function CleanComponents()`
`CleanupEmitterPools`	`event CleanupEmitterPools()`
`ClearCreatureStackProperties`	`function ClearCreatureStackProperties()`
`ClearMeshData`	`native function ClearMeshData()`
`CreateBaseCreatureStack`	`function CreateBaseCreatureStack()`
`CreateCombatArmy`	`function H7CombatArmy CreateCombatArmy()`
`CreateCombatArmyUsingAdventureArmy`	`function H7CombatArmy CreateCombatArmyUsingAdventureArmy(H7AdventureArmy Army, bool IsAttacker, optional bool isForQuickCombat = false)`
`CreateCreatureStackProperies`	`function CreateCreatureStackProperies()`
`CreateHero`	`function CreateHero(optional SavegameHeroStruct SaveGameData)`
`CreateStackPropertyFromBase`	`function CreatureStackProperties CreateStackPropertyFromBase(H7BaseCreatureStack Stack)`
`EnsureBaseStackSlotExistence`	`function EnsureBaseStackSlotExistence(int Length)`
`GetAiIsBorderControl`	`function bool GetAiIsBorderControl()`
`GetBaseCreatureStackIndex`	`function int GetBaseCreatureStackIndex(H7BaseCreatureStack Stack)`
`GetBaseCreatureStackLength`	`function int GetBaseCreatureStackLength()`
`GetBaseCreatureStacks`	`function array<H7BaseCreatureStack> GetBaseCreatureStacks()`
`GetBaseCreatureStacksDereferenced`	`function array<H7BaseCreatureStack> GetBaseCreatureStacksDereferenced()`
`GetBaseStackBySourceSlotId`	`function H7BaseCreatureStack GetBaseStackBySourceSlotId(int Id)`
`GetCreatureAmount`	`function int GetCreatureAmount(H7Creature Creature)`
`GetCreatureAmountOfTier`	`function int GetCreatureAmountOfTier(H7StructsAndEnumsNative.ECreatureTier Tier)`
`GetCreatureAmountTotal`	`function int GetCreatureAmountTotal()`
`GetCreaturePropertyStrength`	`native function float GetCreaturePropertyStrength(CreatureStackProperties stackProperty)`
`GetCreatureStackProperties`	`function array<CreatureStackProperties> GetCreatureStackProperties()`
`GetDeployment`	`function H7Deployment GetDeployment()`
`GetEditorHero`	`function H7EditorHero GetEditorHero()`
`GetExperienceForDefeating`	`function int GetExperienceForDefeating()`
`GetHeroPower`	`function float GetHeroPower()`
`GetHeroStrengthValue`	`static native function float GetHeroStrengthValue(int HeroLevel)`
`GetHeroTemplate`	`function H7EditorHero GetHeroTemplate()`
`GetHeroTemplateSource`	`event H7EditorHero GetHeroTemplateSource()`
`GetIndexOfStack`	`function int GetIndexOfStack(H7BaseCreatureStack compareStack)`
`GetMaxArmySize`	`function int GetMaxArmySize()`
`GetNumberOfFilledSlots`	`function int GetNumberOfFilledSlots()`
`GetNumberOfMeleeStacks`	`event int GetNumberOfMeleeStacks()`
`GetPlayer`	`native function H7Player GetPlayer()`
`GetPlayerNumber`	`function H7StructsAndEnumsNative.EPlayerNumber GetPlayerNumber()`
`GetRandomCreatureStackSize`	`function int GetRandomCreatureStackSize(H7Creature Creature, float xpToUse)`
`GetStackByIDString`	`function H7BaseCreatureStack GetStackByIDString(string creatureName)`
`GetStackByName`	`function H7BaseCreatureStack GetStackByName(string creatureName)`
`GetStrengthValue`	`native function float GetStrengthValue(optional bool withHero = false, optional array<H7BaseCreatureStack> additionalStacks)`
`GetStrongestCreature`	`native function H7Creature GetStrongestCreature()`
`GetStrongestPropertyCreature`	`native function H7Creature GetStrongestPropertyCreature()`
`GetWarUnitByType`	`function H7EditorWarUnit GetWarUnitByType(H7StructsAndEnumsNative.EWarUnitClass unitClass)`
`GetWarUnitTemplates`	`function array<H7EditorWarUnit> GetWarUnitTemplates()`
`HasHybridWarUnit`	`function bool HasHybridWarUnit()`
`HasWarUnitType`	`function bool HasWarUnitType(H7StructsAndEnumsNative.EWarUnitClass unitClass)`
`Init`	`event Init(H7Player PlayerOwner, optional H7AdventureMapCell StartPos, optional Vector garrisonLocation, optional bool pruneStacks)`
`InitRandomValues`	`function InitRandomValues()`
`InsertCreatureStack`	`function InsertCreatureStack(int Index, H7BaseCreatureStack Stack)`
`IsForcingManualCombat`	`function bool IsForcingManualCombat()`
`IsNPC`	`function bool IsNPC()`
`IsStarterHero`	`function bool IsStarterHero()`
`IsTalking`	`function bool IsTalking()`
`LoadMeshes`	`native function LoadMeshes(optional bool useStrongestCreature)`
`OnPooledAttachedParticleSystemFinished`	`simulated function OnPooledAttachedParticleSystemFinished(ParticleSystemComponent PSC)`
`OverrideDeploymentFromBaseStacks`	`function OverrideDeploymentFromBaseStacks(optional bool markAllStacksAsUndeployed = true)`
`PlayParticleEffect`	`event bool PlayParticleEffect(const AnimNotify_PlayParticleEffect AnimNotifyData)`
`PostBeginPlay`	`simulated event PostBeginPlay()`
`PostCreateHero`	`function PostCreateHero()`
`PrintStateToLog`	`function PrintStateToLog(optional string armyName)`
`PruneStackProperties`	`native function PruneStackProperties()`
`PutCreatureStackToEmptySlot`	`function int PutCreatureStackToEmptySlot(H7BaseCreatureStack Stack)`
`RecyclePooledEmitter`	`simulated function RecyclePooledEmitter(ParticleSystemComponent PSC)`
`RemoveWarUnit`	`function RemoveWarUnit(H7EditorWarUnit warUnit)`
`SetAiIsBorderControl`	`function SetAiIsBorderControl(bool Enable)`
`SetArmyIsAmbush`	`function SetArmyIsAmbush(bool Value)`
`SetBaseCreatureStacks`	`function SetBaseCreatureStacks(array<H7BaseCreatureStack> stacks)`
`SetBaseCreatureStacksToCopy`	`function SetBaseCreatureStacksToCopy(array<H7BaseCreatureStack> stacks)`
`SetCell`	`function SetCell(H7AdventureMapCell newCellPos, optional bool updateHeroWorldLocation = true, optional bool registerCell = true, optional bool isInit = true)`
`SetCreatureStackProperties`	`function SetCreatureStackProperties(array<CreatureStackProperties> stackProperties)`
`SetDeployment`	`function SetDeployment(H7Deployment Value)`
`SetForcingManualCombat`	`function SetForcingManualCombat(bool Value)`
`SetHeroTemplate`	`function SetHeroTemplate(H7EditorHero Hero)`
`SetNPC`	`function SetNPC(bool IsNPC)`
`SetPlayer`	`function SetPlayer(H7Player NewPlayer)`
`SetStarterHero`	`function SetStarterHero(bool NewValue)`
`SetTalking`	`function SetTalking(bool IsTalking)`
`SetWarUnitTemplates`	`function SetWarUnitTemplates(array<H7EditorWarUnit> warUnitTemplates)`
`SplitCreatureStackToEmptySlot`	`static function SplitCreatureStackToEmptySlot(H7EditorArmy sourceArmy, H7EditorArmy targetArmy, int SourceIndex, int splitCount, optional int TargetIndex = -1, optional bool forceTransferToTargetArmy = false)`
`SplitCreatureStackToEmptySlotComplete`	`static function bool SplitCreatureStackToEmptySlotComplete(H7EditorArmy sourceArmy, H7EditorArmy altArmy, int indexSource, int splitCount, out int TargetIndex, bool forceTransferToTargetArmy)`
`SyncBaseStackStartingSizeToCurrentSize`	`function SyncBaseStackStartingSizeToCurrentSize()`
`TransferCreatureStacksByArmy`	`static function TransferCreatureStacksByArmy(H7EditorArmy requesterArmy, H7EditorArmy sourceArmy, H7EditorArmy targetArmy, int indexSource, int indexTarget, optional int splitAmount, optional bool forceTransferToTargetArmy)`
`TransferCreatureStacksByArmyComplete`	`static function bool TransferCreatureStacksByArmyComplete(H7EditorArmy sourceArmy, H7EditorArmy targetArmy, int indexSource, int indexTarget, optional int splitAmount)`
`UpdateMeshes`	`native function UpdateMeshes(optional H7Creature Creature)`
`UpdateWeaponAttachments`	`native function UpdateWeaponAttachments()`
`UseLlamaMesh`	`event bool UseLlamaMesh()`

Default values¶

cMaxArmySize=7

Inherited¶

From	Members
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