H7WarUnit¶

Class in MMH7Game · MMH7Game.H7WarUnit · native, perobjectconfig

Object › Actor › SkeletalMeshActor › SkeletalMeshCinematicActor › SkeletalMeshActorMAT › H7Unit › H7WarUnit

Implements: H7IGUIListenable, H7IOffGridDeployable

Using it from Lua

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

Properties¶

Name	Type	Notes
`CurrentDeathMaterialEffects`	`array<H7DeathMaterialEffect>`	protected
`mAIControlled`	`bool`	protected
`mAimingSkeletalMesh`	`SkeletalMeshComponent`	protectedwrite
`mAimingTime`	`float`	protected
`mAnimControl`	`H7WarUnitAnimControl`	protected
`mAnimControlEvents`	`array<H7WarfareEvent>`	protected
`mAttackCountThisRound`	`int`	protected
`mBaseAttack`	`int`	protected
`mBaseDefense`	`int`	protected
`mCombatController`	`H7CombatController`	protected
`mCombatGridController`	`H7CombatMapGridController`	protected
`mCurrentHitpoints`	`int`	protected
`mDamageSoundEvent`	`AkEvent`	protected
`mDeathMaterialFX`	`array<H7DeathMaterialEffect>`	protected
`mDefaultWarfareAbility`	`H7BaseAbility`	protected
`mDefaultWarfareSupportAbility`	`H7BaseAbility`	protected
`mDynamicLightEnv`	`DynamicLightEnvironmentComponent`	protected
`mFX`	`H7WarUnitFX`	protected
`mHitpoints`	`int`	protected
`mHitSoundEvent`	`AkEvent`	protected
`mIsDeployed`	`bool`	protected
`mIsHovering`	`bool`	protected
`mOrientedAttackAnimId`	`H7StructsAndEnums.EWarUnitAnimation`	protected
`mSkeletalMesh`	`SkeletalMeshComponent`	protectedwrite
`mSkeletalMeshAura`	`SkeletalMeshComponent`	const, protectedwrite
`mSkipAbility`	`H7BaseAbility`	protected
`mStartRot`	`Rotator`	protected
`mTargetLocation`	`Vector`	protected
`mTemplate`	`H7EditorWarUnit`	protected
`mWarUnitClass`	`H7StructsAndEnumsNative.EWarUnitClass`	protected
`mWarUnitMaterials`	`array<MaterialInstanceConstant>`	protected

Functions¶

Name	Declaration
`ApplyDamage`	`simulated function ApplyDamage(H7CombatResult Result, int resultIdx, bool isForecast, optional bool isRetaliation = false, optional bool raiseEvent = true)`
`ApplyHeroArmyBonusBuff`	`function ApplyHeroArmyBonusBuff()`
`BeginTurn`	`function bool BeginTurn()`
`ClearAttackCount`	`function ClearAttackCount()`
`DataChanged`	`event DataChanged(optional string cause)`
`DebugLogSelf`	`protected function DebugLogSelf()`
`DeHighlightWarfareUnit`	`event DeHighlightWarfareUnit()`
`doSkip`	`function doSkip()`
`EndTurn`	`function EndTurn()`
`FaceTargetObstacle`	`function FaceTargetObstacle(H7IEffectTargetable Target)`
`GetAnimControl`	`function H7WarUnitAnimControl GetAnimControl()`
`GetAttack`	`event int GetAttack()`
`GetAttackRange`	`function H7StructsAndEnumsNative.EAttackRange GetAttackRange()`
`GetBaseAttack`	`function int GetBaseAttack()`
`GetBaseDefense`	`function int GetBaseDefense()`
`GetCell`	`function H7CombatMapCell GetCell()`
`GetCurrentHitPoints`	`function int GetCurrentHitPoints()`
`GetDamageResult`	`function GetDamageResult(int dmg, out int currentHealth, optional bool isForecast = false)`
`GetDefaultAbility`	`function H7BaseAbility GetDefaultAbility()`
`GetEntityType`	`native function H7StructsAndEnumsNative.EUnitType GetEntityType()`
`GetFloatingTextLocation`	`function Vector GetFloatingTextLocation()`
`GetGridPosition`	`function IntPoint GetGridPosition()`
`GetHeight`	`function float GetHeight()`
`GetHitPoints`	`function int GetHitPoints()`
`GetHitPointsBase`	`function int GetHitPointsBase()`
`GetIcon`	`function Texture2D GetIcon()`
`GetInitialStackSize`	`function int GetInitialStackSize()`
`GetMaximumDamage`	`event float GetMaximumDamage()`
`GetMaximumDamageBase`	`event int GetMaximumDamageBase()`
`GetMeshCenter`	`native function Vector GetMeshCenter()`
`GetMinimumDamage`	`event float GetMinimumDamage()`
`GetMinimumDamageBase`	`event int GetMinimumDamageBase()`
`GetModifiersByID`	`native function GetModifiersByID(out array<H7MeModifiesStat> outStats, H7StructsAndEnumsNative.EStat desiredStat, optional H7StructsAndEnumsNative.EOperationType exclusiveFirstOT = 255, optional H7StructsAndEnumsNative.EOperationType exclusiveSecondOT = 255, optional bool nextRound)`
`GetMovementPoints`	`function int GetMovementPoints()`
`GetMovementType`	`function H7StructsAndEnumsNative.EMovementType GetMovementType()`
`GetName`	`function string GetName()`
`GetOrientationToTarget`	`function float GetOrientationToTarget(H7IEffectTargetable Target)`
`GetOrientedAttackAnimFromAim`	`function H7StructsAndEnums.EWarUnitAnimation GetOrientedAttackAnimFromAim(float Aim)`
`GetOrientedAttackAnimId`	`function H7StructsAndEnums.EWarUnitAnimation GetOrientedAttackAnimId()`
`GetSchool`	`function H7StructsAndEnumsNative.EAbilitySchool GetSchool()`
`GetSkipAbility`	`function H7BaseAbility GetSkipAbility()`
`GetSkipTurnAbility`	`function H7BaseAbility GetSkipTurnAbility()`
`GetSocketLocation`	`native function Vector GetSocketLocation(name SocketName)`
`GetStackSize`	`function int GetStackSize()`
`GetSupportAbility`	`function H7BaseAbility GetSupportAbility()`
`GetTemplate`	`function H7EditorWarUnit GetTemplate()`
`GetTemplateAsUnit`	`function H7Unit GetTemplateAsUnit()`
`GetUnitBaseSize`	`native function H7StructsAndEnumsNative.ECellSize GetUnitBaseSize()`
`GetUnitBaseSizeInt`	`function int GetUnitBaseSizeInt()`
`GetWarfareAttackAbilityTemplate`	`function H7BaseAbility GetWarfareAttackAbilityTemplate()`
`GetWarUnitClass`	`function H7StructsAndEnumsNative.EWarUnitClass GetWarUnitClass()`
`GUIAddListener`	`function GUIAddListener(GFxObject Data, optional H7StructsAndEnums.H7ListenFocus Focus)`
`GUIWriteInto`	`function GUIWriteInto(GFxObject Data, optional H7StructsAndEnums.H7ListenFocus Focus, optional H7GFxUIContainer flashFactory)`
`HasFullAction`	`function bool HasFullAction()`
`HideSlotFX`	`protected function HideSlotFX(H7CombatMapCell myCell)`
`HighlightWarfareUnit`	`function HighlightWarfareUnit()`
`IncrementAttackCount`	`function IncrementAttackCount()`
`Init`	`function Init(optional bool fromSave)`
`InitFX`	`protected function InitFX()`
`IsControlledByAI`	`function bool IsControlledByAI()`
`IsDead`	`native function bool IsDead()`
`IsDeployed`	`function bool IsDeployed()`
`OnFaceTargetObstacleFinishedFunc`	`delegate OnFaceTargetObstacleFinishedFunc()`
`PlayDeathEffect`	`function PlayDeathEffect()`
`PlayDeathMaterialEffects`	`function PlayDeathMaterialEffects(optional bool undo = false)`
`PostInitAnimTree`	`simulated event PostInitAnimTree(SkeletalMeshComponent SkelComp)`
`PrepareDefaultAbility`	`event PrepareDefaultAbility()`
`RecalculatePostAnimInput`	`function RecalculatePostAnimInput()`
`ReplaceAttackAbility`	`function ReplaceAttackAbility(H7BaseAbility A)`
`ReplaceDefaultAbility`	`function ReplaceDefaultAbility(H7BaseAbility A)`
`ReplaceSupportAbility`	`function ReplaceSupportAbility(H7BaseAbility A)`
`SetAIControled`	`function SetAIControled(bool B)`
`SetAnimEvents`	`function SetAnimEvents(array<H7WarfareEvent> E)`
`SetBaseAttack`	`function SetBaseAttack(int Attack)`
`SetBaseDefense`	`function SetBaseDefense(int Defense)`
`SetCurrentHitPoints`	`function SetCurrentHitPoints(int NewValue)`
`SetDamage`	`function SetDamage(int minDmg, int maxDmg)`
`SetDamageSoundEvent`	`function SetDamageSoundEvent(AkEvent Sound)`
`SetDeathMaterialEffects`	`function SetDeathMaterialEffects(array<H7DeathMaterialEffect> deathFX)`
`SetDefaultAbility`	`function SetDefaultAbility(H7BaseAbility A)`
`SetDeployed`	`function SetDeployed(bool val)`
`SetDestroyed`	`function SetDestroyed()`
`SetFaction`	`function SetFaction(H7Faction Faction)`
`SetGetHitSoundEvent`	`function SetGetHitSoundEvent(AkEvent Sound)`
`SetGridPosition`	`function SetGridPosition(IntPoint gp)`
`SetHitPointsBase`	`function SetHitPointsBase(int hp)`
`SetIcon`	`function SetIcon(Texture2D Icon)`
`SetMeshes`	`function SetMeshes(SkeletalMeshComponent SkelMesh, SkeletalMeshComponent AimingSkelMesh)`
`SetName`	`function SetName(string OverrideName)`
`SetRangedAttackAbility`	`function SetRangedAttackAbility(H7BaseAbility Ability)`
`SetSkipAbility`	`function SetSkipAbility(H7BaseAbility Ability)`
`SetSupportAbility`	`function SetSupportAbility(H7BaseAbility A)`
`SetTemplate`	`function SetTemplate(H7EditorWarUnit Template)`
`SetWarUnitClass`	`function SetWarUnitClass(H7StructsAndEnumsNative.EWarUnitClass C)`
`ShowSlotFXActive`	`protected function ShowSlotFXActive(H7CombatMapCell myCell)`
`ShowSlotFXAlly`	`protected function ShowSlotFXAlly(H7CombatMapCell myCell)`
`ShowSlotFXDeadAlly`	`protected function ShowSlotFXDeadAlly(H7CombatMapCell myCell)`
`ShowSlotFXEnemy`	`protected function ShowSlotFXEnemy(H7CombatMapCell myCell)`
`Tick`	`event Tick(float DeltaTime)`
`TurnChanged`	`function TurnChanged()`
`UpdateAbilitySlotFX`	`protected function UpdateAbilitySlotFX(H7CombatMapCell myCell, H7BaseAbility preparedAbility)`
`UpdateSlotFX`	`function UpdateSlotFX()`
`WillExceedAttackCount`	`function bool WillExceedAttackCount()`

States¶

State code replaces the class's functions while the object is in that state. Hook a state's version as MMH7Game.H7WarUnit.<State>.<Function>.

State	Functions
Aiming	`BeginState`, `GetOptimalTargetRotation`, `Tick`
Waiting

Default values¶

mIsDeployed=true

Inherited¶

From	Members
H7Unit	Properties: mAbilityManager, mAnimSoundSpeedManipulator, mArmy, mArmyAdventure, mArtwork, mAttack, mAttackCount, mAttackCountMod, mBuffManager, mCasualtyStacks, mCollider, mColliderHeight, mColliderRadius, mCombatCtrl, mCurrentWave, mDefense, mDestiny, mDoStatusCheck, mEffectManager, mEmitterPoolParticleComps, mEventManager, mFaction, mFactionSymbol, mFinishedCommand, mFlankingBonus, mGhostWalkParticles, mGridPos, mHasBadMoral, mIcon, Mid, mIgnoreAllegiances, mInitiative, mIsAdditionalTurn, mIsDoneForAI, mIsMoralTurn, mIsWaiting, mIsWaitTurn, mKillsOnCurrentTurn, mLastPath, mLastQueuePosition, mLeadership, mLore, mLoreInst, mLuckAbility, mLuckType, mMagicAbs, mMarkForSkipTurn, mMaximumDamage, mMeleeAttackAbilityTemplate, mMinimumDamage, mMoveCount, mMovementPoints, mName, mNameInst, mNeedsPrivileg, mNewCreaturePosition, mOverrideAutoCollider, mOverrideWithAI, mPrivilegID, mProjectileStartSocket, mRange, mRangedAttackAbilityTemplate, mRotateRandom, mSchoolType, mSkipTurn, mSkirmishAttack, mSkirmishDefense, mSkirmishDestiny, mSkirmishInitiative, mSkirmishLeadership, mSkirmishMaximumDamage, mSkirmishMinimumDamage, mSkirmishMovementPoints, mSkirmishSchoolType, mSkirmishUnitCost, mStatCache, mStatModSourceBuffer, mSubstituteLuckAbility, mTeleportationEndSound, mTeleportationStartSound, mTeleportEndEffect, mTeleportStartEffect, mTriggerTurnEndEvents, mTriggerTurnStartEvents, mTsunamiCasterValues, mUnitCost, mWaitAbility, mWaitClicked, mWaveSource Functions: AllocatePooledEmitter, ApplyDamage, BeforeEndTurn, BeginAction, BeginTurn, CanAttack, CanDefend, CanMakeAction, CanMove, ChangeUnitAnimationSoundSpeed, CleanupEmitterPools, ClearStatCache, ClearTurns, DataChanged, DecreaseBaseStatByID, Defend, DeleteImage, Deserialize, DeserializeReferences, Destroyed, DisplayStatChangeFloat, DisplayStatChangeLog, DoDeathMaterialEffectFading, DoLuckRoll, DumpModifiers, EnableUnitMoveSound, EnableUnitSound, EndAction, EndMoving, EndTurn, FinishedCommand, GetAbilityManager, GetActionID, GetAddBoniOnStatByID, GetAdventureArmy, GetAllShieldEffects, GetAnimSoundSpeedManipulator, GetArmy, GetAttack, GetAttackCount, GetAttackType, GetBaseStatByID, GetBuffManager, GetColliderHeight, GetColliderRadius, GetCombatArmy, GetCurrentLuckType, GetDefense, GetDefenseBase, GetDestiny, GetDestinyBase, GetDoneForAI, GetEffectContainerForStat, GetEffectManager, GetEndTeleportFXSound, GetEntityType, GetEventManager, GetFaction, GetFlashArtworkPath, GetFlashIconPath, GetForeignMoralePenaltyModifier, GetGhostWalkParticleFX, GetGridPosition, GetHeightPos, GetHitPoints, GetIcon, GetID, GetIDString, GetIgnoreAllegiances, GetInitiative, GetKillsOnCurrentTurn, GetLastQueuePosition, GetLastWalkedPath, GetLastWalkedPathLength, GetLeadership, GetLeadershipBase, GetLocation, GetLore, GetLuckAbility, GetLuckDestiny, GetMagic, GetMaximumDamage, GetMaximumDamageBase, GetMeleeAttackAbility, GetMeshCenter, GetMeshComponent, GetMinimumDamage, GetMinimumDamageBase, GetModifiedStatByID, GetModifiersByID, GetMoveCount, GetMovementPoints, GetMovementPointsBase, GetMultiBoniOnStatByID, GetName, GetNegotiationChance, GetNextInitiative, GetOriginal, GetPlayer, GetPreparedAbility, GetProjectileStartSocketName, GetRangedAttackAbility, GetResistanceModifierFor, GetResistanceModifierForTag, GetSchool, GetSkipTurnAbility, GetSocketLocation, GetStackSize, GetStartTeleportFXSound, GetStatModSourceList, GetSurrenderCostModifier, GetTeleportEndParticleFX, GetTeleportStartParticleFX, GetUnitBaseSize, GetUnitBaseSizeInt, GetUnitCost, GetUnitName, GetWaitAbility, HasBadMoral, HasFullAction, HasPreparedAbility, HasPreparedAbilityId, HasTeleportEndFX, HasTeleportStartFX, HasWaitClicked, HitUnit, IncreaseBaseStatByID, Init, InitCurrentWave, IsAdditionalTurn, IsAttacker, IsAutoColliderOverridden, IsCasting, IsControlledByAI, IsDead, IsDefaultAttackActive, IsMarkedForTurnSkip, IsMoralTurn, IsMoving, IsMyDefaultAbility, IsOverridenByAI, IsRanged, IsUnderAttack, IsWaiting, IsWaitTurn, LoadIcon, MakeTurn, MarkForTurnSkip, MPIsYourTurn, NextWaveStep, OnGetBuffed, OnPooledAttachedParticleSystemFinished, PlayParticleEffect, PostBeginPlay, PrepareAbility, PrepareDefaultAbility, RecalculatePostAnimInput, RecyclePooledEmitter, ResetLuckType, ResetPreparedAbility, ResetTurnCount, Serialize, SetAdditionalTurn, SetArmy, SetBaseStatByID, SetCommandFinished, SetCurrentLuckType, SetDoneForAI, SetIgnoreAllegiances, SetInitiative, SetKillsOnCurrentTurn, SetLastQueuePosition, SetLastWalkedPath, SetMeleeAttackAbility, SetMoralTurn, SetNewCreaturePosition, SetOverrideByAI, SetRangedAttackAbility, SetSchoolType, SetSkipTurn, SetSubstituteLuckAbilty, SetTriggerStartTurnEvents, SetUnitCosts, SetWaitAbility, SetWaitClick, SetWaiting, ShowFloatingText, StatusChanged, Think, TriggerEvents, TriggerStartTurnEvents, UndoDeathMaterialFX, UpdateParticleTranslucency, UseAttack, UseMove, UsePreparedAbility, Wait, WaveCatchCreatureStack
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