H7Unit¶

Class in MMH7Game · MMH7Game.H7Unit · native, perobjectconfig

Object › Actor › SkeletalMeshActor › SkeletalMeshCinematicActor › SkeletalMeshActorMAT › H7Unit

Implements: H7IEffectTargetable, H7ICaster

Subclasses: H7Creature, H7CreatureStack, H7EditorHero, H7EditorRuneUnit, H7EditorWarUnit, H7RuneUnit, H7TowerUnit, H7WarUnit

Using it from Lua

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

Constants¶

Name	Value
`DEFAULT_INITIATIVE`	`1`

Properties¶

Name	Type	Notes
`mAbilityManager`	`Object`	no declaration: type is approximate
`mAnimSoundSpeedManipulator`	`float`	protected
`mArmy`	`Object`	no declaration: type is approximate
`mArmyAdventure`	`Object`	no declaration: type is approximate
`mArtwork`	`DynLoadObject`	no declaration: type is approximate
`mAttack`	`int`	no declaration: type is approximate
`mAttackCount`	`int`	no declaration: type is approximate
`mAttackCountMod`	`int`	no declaration: type is approximate
`mBuffManager`	`Object`	no declaration: type is approximate
`mCasualtyStacks`	`array`	no declaration: type is approximate
`mCollider`	`CylinderComponent`	protected
`mColliderHeight`	`float`	protected
`mColliderRadius`	`float`	protected
`mCombatCtrl`	`Object`	no declaration: type is approximate
`mCurrentWave`	`Object`	no declaration: type is approximate
`mDefense`	`int`	no declaration: type is approximate
`mDestiny`	`int`	no declaration: type is approximate
`mDoStatusCheck`	`bool`	protected
`mEffectManager`	`Object`	no declaration: type is approximate
`mEmitterPoolParticleComps`	`array`	no declaration: type is approximate
`mEventManager`	`Object`	no declaration: type is approximate
`mFaction`	`Object`	no declaration: type is approximate
`mFactionSymbol`	`Object`	no declaration: type is approximate
`mFinishedCommand`	`bool`	protected
`mFlankingBonus`	`float`	no declaration: type is approximate
`mGhostWalkParticles`	`Object`	no declaration: type is approximate
`mGridPos`	`struct`	no declaration: type is approximate
`mHasBadMoral`	`bool`	protected
`mIcon`	`DynLoadObject`	no declaration: type is approximate
`Mid`	`int`	no declaration: type is approximate
`mIgnoreAllegiances`	`bool`	protected
`mInitiative`	`int`	no declaration: type is approximate
`mIsAdditionalTurn`	`bool`	protected
`mIsDoneForAI`	`bool`	protected
`mIsMoralTurn`	`bool`	protected
`mIsWaiting`	`bool`	protected
`mIsWaitTurn`	`bool`	protected
`mKillsOnCurrentTurn`	`int`	no declaration: type is approximate
`mLastPath`	`array`	no declaration: type is approximate
`mLastQueuePosition`	`int`	no declaration: type is approximate
`mLeadership`	`int`	no declaration: type is approximate
`mLore`	`string`	const, localized, protected
`mLoreInst`	`string`	protected
`mLuckAbility`	`Object`	no declaration: type is approximate
`mLuckType`	`byte`	no declaration: type is approximate
`mMagicAbs`	`int`	no declaration: type is approximate
`mMarkForSkipTurn`	`bool`	protected
`mMaximumDamage`	`int`	no declaration: type is approximate
`mMeleeAttackAbilityTemplate`	`Object`	no declaration: type is approximate
`mMinimumDamage`	`int`	no declaration: type is approximate
`mMoveCount`	`int`	no declaration: type is approximate
`mMovementPoints`	`int`	no declaration: type is approximate
`mName`	`string`	const, localized, protected
`mNameInst`	`string`	transient, protected
`mNeedsPrivileg`	`bool`	editconst, private
`mNewCreaturePosition`	`array`	no declaration: type is approximate
`mOverrideAutoCollider`	`bool`	protected
`mOverrideWithAI`	`bool`	protected
`mPrivilegID`	`int`	editconst, private
`mProjectileStartSocket`	`name`	no declaration: type is approximate
`mRange`	`int`	no declaration: type is approximate
`mRangedAttackAbilityTemplate`	`Object`	no declaration: type is approximate
`mRotateRandom`	`bool`	protected
`mSchoolType`	`byte`	no declaration: type is approximate
`mSkipTurn`	`bool`	protected
`mSkirmishAttack`	`int`	no declaration: type is approximate
`mSkirmishDefense`	`int`	no declaration: type is approximate
`mSkirmishDestiny`	`int`	no declaration: type is approximate
`mSkirmishInitiative`	`int`	no declaration: type is approximate
`mSkirmishLeadership`	`int`	no declaration: type is approximate
`mSkirmishMaximumDamage`	`int`	no declaration: type is approximate
`mSkirmishMinimumDamage`	`int`	no declaration: type is approximate
`mSkirmishMovementPoints`	`int`	no declaration: type is approximate
`mSkirmishSchoolType`	`byte`	no declaration: type is approximate
`mSkirmishUnitCost`	`array`	no declaration: type is approximate
`mStatCache`	`float`	no declaration: type is approximate
`mStatModSourceBuffer`	`array`	no declaration: type is approximate
`mSubstituteLuckAbility`	`Object`	no declaration: type is approximate
`mTeleportationEndSound`	`Object`	no declaration: type is approximate
`mTeleportationStartSound`	`Object`	no declaration: type is approximate
`mTeleportEndEffect`	`Object`	no declaration: type is approximate
`mTeleportStartEffect`	`Object`	no declaration: type is approximate
`mTriggerTurnEndEvents`	`bool`	protected
`mTriggerTurnStartEvents`	`bool`	protected
`mTsunamiCasterValues`	`interface`	no declaration: type is approximate
`mUnitCost`	`array`	no declaration: type is approximate
`mWaitAbility`	`Object`	no declaration: type is approximate
`mWaitClicked`	`bool`	protected
`mWaveSource`	`Object`	no declaration: type is approximate

Functions¶

Name	Declaration
`AllocatePooledEmitter`	`simulated function AllocatePooledEmitter(ParticleSystemComponent PSC)`
`ApplyDamage`	`simulated function ApplyDamage(H7CombatResult Result, int resultIdx, bool isForecast, optional bool isRetaliation = false, optional bool raiseEvent = true)`
`BeforeEndTurn`	`function BeforeEndTurn()`
`BeginAction`	`function BeginAction()`
`BeginTurn`	`function bool BeginTurn()`
`CanAttack`	`native function bool CanAttack()`
`CanDefend`	`function bool CanDefend()`
`CanMakeAction`	`native function bool CanMakeAction()`
`CanMove`	`native function bool CanMove()`
`ChangeUnitAnimationSoundSpeed`	`native function ChangeUnitAnimationSoundSpeed(optional float additionalSpeedMod)`
`CleanupEmitterPools`	`function CleanupEmitterPools()`
`ClearStatCache`	`native function ClearStatCache()`
`ClearTurns`	`function ClearTurns()`
`DataChanged`	`event DataChanged(optional string cause)`
`DecreaseBaseStatByID`	`function DecreaseBaseStatByID(H7StructsAndEnumsNative.EStat desiredStat, optional int Amount = 1)`
`Defend`	`function Defend()`
`DeleteImage`	`function DeleteImage()`
`Deserialize`	`function Deserialize(JsonObject Data)`
`DeserializeReferences`	`function DeserializeReferences(JsonObject Data, SaveGameState Savegame)`
`Destroyed`	`simulated event Destroyed()`
`DisplayStatChangeFloat`	`function DisplayStatChangeFloat(H7StructsAndEnumsNative.EStat Stat, H7StructsAndEnumsNative.EOperationType Op, float Amount, optional H7EffectContainer Source)`
`DisplayStatChangeLog`	`function DisplayStatChangeLog(H7StructsAndEnumsNative.EStat Stat, H7StructsAndEnumsNative.EOperationType Op, float Amount, optional H7EffectContainer Source)`
`DoDeathMaterialEffectFading`	`function DoDeathMaterialEffectFading(array<H7DeathMaterialEffect> deathMaterialEffects, optional array<MaterialInstanceConstant> unitMaterials)`
`DoLuckRoll`	`function H7StructsAndEnums.ELuckType DoLuckRoll(H7EventContainerStruct container)`
`DumpModifiers`	`native function DumpModifiers()`
`EnableUnitMoveSound`	`function EnableUnitMoveSound(bool Enable)`
`EnableUnitSound`	`function EnableUnitSound(bool Enable)`
`EndAction`	`function EndAction()`
`EndMoving`	`function EndMoving(optional bool ignoreTargetNotReachedMessage = true)`
`EndTurn`	`function EndTurn()`
`FinishedCommand`	`function bool FinishedCommand()`
`GetAbilityManager`	`native function H7AbilityManager GetAbilityManager()`
`GetActionID`	`function H7StructsAndEnumsNative.ECommandTag GetActionID(H7BaseAbility Ability)`
`GetAddBoniOnStatByID`	`native function float GetAddBoniOnStatByID(H7StructsAndEnumsNative.EStat desiredStat, optional bool nextRound = false)`
`GetAdventureArmy`	`native function H7AdventureArmy GetAdventureArmy()`
`GetAllShieldEffects`	`native function GetAllShieldEffects(out array<H7EffectSpecialShieldEffect> shieldEffects)`
`GetAnimSoundSpeedManipulator`	`function float GetAnimSoundSpeedManipulator()`
`GetArmy`	`function H7EditorArmy GetArmy()`
`GetAttack`	`event int GetAttack()`
`GetAttackCount`	`native function int GetAttackCount()`
`GetAttackType`	`function H7StructsAndEnumsNative.EAttackType GetAttackType()`
`GetBaseStatByID`	`native function float GetBaseStatByID(H7StructsAndEnumsNative.EStat desiredStat)`
`GetBuffManager`	`native function H7BuffManager GetBuffManager()`
`GetColliderHeight`	`function float GetColliderHeight()`
`GetColliderRadius`	`function float GetColliderRadius()`
`GetCombatArmy`	`native function H7CombatArmy GetCombatArmy()`
`GetCurrentLuckType`	`function H7StructsAndEnums.ELuckType GetCurrentLuckType()`
`GetDefense`	`function int GetDefense()`
`GetDefenseBase`	`function int GetDefenseBase()`
`GetDestiny`	`function int GetDestiny()`
`GetDestinyBase`	`function int GetDestinyBase()`
`GetDoneForAI`	`function bool GetDoneForAI()`
`GetEffectContainerForStat`	`function array<H7EffectContainer> GetEffectContainerForStat(H7StructsAndEnumsNative.EStat Stat)`
`GetEffectManager`	`function H7EffectManager GetEffectManager()`
`GetEndTeleportFXSound`	`function AkEvent GetEndTeleportFXSound()`
`GetEntityType`	`native function H7StructsAndEnumsNative.EUnitType GetEntityType()`
`GetEventManager`	`native function H7EventManager GetEventManager()`
`GetFaction`	`function H7Faction GetFaction()`
`GetFlashArtworkPath`	`function string GetFlashArtworkPath()`
`GetFlashIconPath`	`function string GetFlashIconPath()`
`GetForeignMoralePenaltyModifier`	`function float GetForeignMoralePenaltyModifier()`
`GetGhostWalkParticleFX`	`function ParticleSystem GetGhostWalkParticleFX()`
`GetGridPosition`	`native function IntPoint GetGridPosition()`
`GetHeightPos`	`function Vector GetHeightPos(float Offset)`
`GetHitPoints`	`function int GetHitPoints()`
`GetIcon`	`native function Texture2D GetIcon()`
`GetID`	`native function int GetID()`
`GetIDString`	`function string GetIDString()`
`GetIgnoreAllegiances`	`function bool GetIgnoreAllegiances()`
`GetInitiative`	`function int GetInitiative()`
`GetKillsOnCurrentTurn`	`function int GetKillsOnCurrentTurn()`
`GetLastQueuePosition`	`function int GetLastQueuePosition()`
`GetLastWalkedPath`	`function array<H7BaseCell> GetLastWalkedPath()`
`GetLastWalkedPathLength`	`function int GetLastWalkedPathLength()`
`GetLeadership`	`event int GetLeadership()`
`GetLeadershipBase`	`function int GetLeadershipBase()`
`GetLocation`	`native function Vector GetLocation()`
`GetLore`	`function string GetLore()`
`GetLuckAbility`	`event H7BaseAbility GetLuckAbility()`
`GetLuckDestiny`	`native function int GetLuckDestiny()`
`GetMagic`	`event int GetMagic()`
`GetMaximumDamage`	`event float GetMaximumDamage()`
`GetMaximumDamageBase`	`function int GetMaximumDamageBase()`
`GetMeleeAttackAbility`	`native function H7BaseAbility GetMeleeAttackAbility()`
`GetMeshCenter`	`native function Vector GetMeshCenter()`
`GetMeshComponent`	`native function SkeletalMeshComponent GetMeshComponent()`
`GetMinimumDamage`	`event float GetMinimumDamage()`
`GetMinimumDamageBase`	`function int GetMinimumDamageBase()`
`GetModifiedStatByID`	`native function float GetModifiedStatByID(H7StructsAndEnumsNative.EStat desiredStat, optional bool nextRound = false)`
`GetModifiersByID`	`native function GetModifiersByID(out array<H7MeModifiesStat> outStats, H7StructsAndEnumsNative.EStat desiredStat, optional H7StructsAndEnumsNative.EOperationType exclusiveFirstOT = 255, optional H7StructsAndEnumsNative.EOperationType exclusiveSecondOT = 255, optional bool nextRound)`
`GetMoveCount`	`native function int GetMoveCount()`
`GetMovementPoints`	`native function int GetMovementPoints()`
`GetMovementPointsBase`	`function int GetMovementPointsBase()`
`GetMultiBoniOnStatByID`	`native function float GetMultiBoniOnStatByID(H7StructsAndEnumsNative.EStat desiredStat, optional bool nextRound = false)`
`GetName`	`function string GetName()`
`GetNegotiationChance`	`function float GetNegotiationChance()`
`GetNextInitiative`	`function int GetNextInitiative()`
`GetOriginal`	`native function H7ICaster GetOriginal()`
`GetPlayer`	`native function H7Player GetPlayer()`
`GetPreparedAbility`	`function H7BaseAbility GetPreparedAbility()`
`GetProjectileStartSocketName`	`function name GetProjectileStartSocketName()`
`GetRangedAttackAbility`	`native function H7BaseAbility GetRangedAttackAbility()`
`GetResistanceModifierFor`	`native function float GetResistanceModifierFor(H7StructsAndEnumsNative.EAbilitySchool school, array<H7StructsAndEnumsNative.ESpellTag> tags, optional bool checkOnlyBuffs = false, optional bool forcedResistanceOnly = false)`
`GetResistanceModifierForTag`	`function float GetResistanceModifierForTag(H7StructsAndEnumsNative.ESpellTag SearchTag)`
`GetSchool`	`event H7StructsAndEnumsNative.EAbilitySchool GetSchool()`
`GetSkipTurnAbility`	`function H7BaseAbility GetSkipTurnAbility()`
`GetSocketLocation`	`native function Vector GetSocketLocation(name SocketName)`
`GetStackSize`	`function int GetStackSize()`
`GetStartTeleportFXSound`	`function AkEvent GetStartTeleportFXSound()`
`GetStatModSourceList`	`function array<H7StatModSource> GetStatModSourceList(H7StructsAndEnumsNative.EStat Stat)`
`GetSurrenderCostModifier`	`function float GetSurrenderCostModifier()`
`GetTeleportEndParticleFX`	`function ParticleSystem GetTeleportEndParticleFX()`
`GetTeleportStartParticleFX`	`function ParticleSystem GetTeleportStartParticleFX()`
`GetUnitBaseSize`	`native function H7StructsAndEnumsNative.ECellSize GetUnitBaseSize()`
`GetUnitBaseSizeInt`	`function int GetUnitBaseSizeInt()`
`GetUnitCost`	`native function array<H7ResourceQuantity> GetUnitCost()`
`GetUnitName`	`event string GetUnitName()`
`GetWaitAbility`	`function H7BaseAbility GetWaitAbility()`
`HasBadMoral`	`function bool HasBadMoral()`
`HasFullAction`	`function bool HasFullAction()`
`HasPreparedAbility`	`function bool HasPreparedAbility()`
`HasPreparedAbilityId`	`function bool HasPreparedAbilityId(H7BaseAbility aid)`
`HasTeleportEndFX`	`function bool HasTeleportEndFX()`
`HasTeleportStartFX`	`function bool HasTeleportStartFX()`
`HasWaitClicked`	`function bool HasWaitClicked()`
`HitUnit`	`function HitUnit(H7IEffectTargetable Target)`
`IncreaseBaseStatByID`	`function float IncreaseBaseStatByID(H7StructsAndEnumsNative.EStat desiredStat, optional int Amount = 1)`
`Init`	`function Init(optional bool fromSave)`
`InitCurrentWave`	`function InitCurrentWave(H7Wave myWave, Vector StartPos, Vector targetPos, array<H7IEffectTargetable> Targets, H7BaseAbility Source, bool rotateRandom, H7ICaster initiatorSnapShot)`
`IsAdditionalTurn`	`function bool IsAdditionalTurn()`
`IsAttacker`	`native function bool IsAttacker()`
`IsAutoColliderOverridden`	`function bool IsAutoColliderOverridden()`
`IsCasting`	`function bool IsCasting()`
`IsControlledByAI`	`function bool IsControlledByAI()`
`IsDead`	`native function bool IsDead()`
`IsDefaultAttackActive`	`native function bool IsDefaultAttackActive()`
`IsMarkedForTurnSkip`	`function bool IsMarkedForTurnSkip()`
`IsMoralTurn`	`function bool IsMoralTurn()`
`IsMoving`	`function bool IsMoving()`
`IsMyDefaultAbility`	`function bool IsMyDefaultAbility(H7BaseAbility Ability)`
`IsOverridenByAI`	`function bool IsOverridenByAI()`
`IsRanged`	`function bool IsRanged()`
`IsUnderAttack`	`function IsUnderAttack(bool isSimulated)`
`IsWaiting`	`function bool IsWaiting()`
`IsWaitTurn`	`function bool IsWaitTurn()`
`LoadIcon`	`native function LoadIcon()`
`MakeTurn`	`function bool MakeTurn(optional bool usedAttack = true, optional bool usedMove = true)`
`MarkForTurnSkip`	`function MarkForTurnSkip(bool mark)`
`MPIsYourTurn`	`function bool MPIsYourTurn()`
`NextWaveStep`	`function NextWaveStep(array<H7CombatMapCell> Cells)`
`OnGetBuffed`	`native function OnGetBuffed()`
`OnPooledAttachedParticleSystemFinished`	`simulated function OnPooledAttachedParticleSystemFinished(ParticleSystemComponent PSC)`
`PlayParticleEffect`	`event bool PlayParticleEffect(const AnimNotify_PlayParticleEffect AnimNotifyData)`
`PostBeginPlay`	`simulated function PostBeginPlay()`
`PrepareAbility`	`function PrepareAbility(H7BaseAbility Ability)`
`PrepareDefaultAbility`	`event PrepareDefaultAbility()`
`RecalculatePostAnimInput`	`function RecalculatePostAnimInput()`
`RecyclePooledEmitter`	`simulated function RecyclePooledEmitter(ParticleSystemComponent PSC)`
`ResetLuckType`	`function ResetLuckType()`
`ResetPreparedAbility`	`function ResetPreparedAbility()`
`ResetTurnCount`	`function ResetTurnCount()`
`Serialize`	`function JsonObject Serialize()`
`SetAdditionalTurn`	`function SetAdditionalTurn(bool boool)`
`SetArmy`	`function SetArmy(H7EditorArmy Army)`
`SetBaseStatByID`	`native function SetBaseStatByID(H7StructsAndEnumsNative.EStat desiredStat, int NewValue)`
`SetCommandFinished`	`function SetCommandFinished(bool isFinished)`
`SetCurrentLuckType`	`function SetCurrentLuckType(H7StructsAndEnums.ELuckType Luck)`
`SetDoneForAI`	`function SetDoneForAI(bool val)`
`SetIgnoreAllegiances`	`function SetIgnoreAllegiances(bool Value)`
`SetInitiative`	`function SetInitiative(int val)`
`SetKillsOnCurrentTurn`	`function SetKillsOnCurrentTurn(int Kills)`
`SetLastQueuePosition`	`function SetLastQueuePosition(int pos)`
`SetLastWalkedPath`	`function SetLastWalkedPath(array<H7BaseCell> Path)`
`SetMeleeAttackAbility`	`function SetMeleeAttackAbility(H7BaseAbility Ability)`
`SetMoralTurn`	`function SetMoralTurn(bool boool)`
`SetNewCreaturePosition`	`function SetNewCreaturePosition(array<CreaturePositon> pos)`
`SetOverrideByAI`	`function SetOverrideByAI(bool val)`
`SetRangedAttackAbility`	`function SetRangedAttackAbility(H7BaseAbility Ability)`
`SetSchoolType`	`function SetSchoolType(H7StructsAndEnumsNative.EAbilitySchool school)`
`SetSkipTurn`	`function SetSkipTurn(bool newSkipTurn)`
`SetSubstituteLuckAbilty`	`function SetSubstituteLuckAbilty(H7BaseAbility Ability)`
`SetTriggerStartTurnEvents`	`function SetTriggerStartTurnEvents(bool should)`
`SetUnitCosts`	`function SetUnitCosts(array<H7ResourceQuantity> Costs)`
`SetWaitAbility`	`function SetWaitAbility(H7BaseAbility Ability)`
`SetWaitClick`	`function SetWaitClick(bool Value)`
`SetWaiting`	`function SetWaiting(bool IsWaiting)`
`ShowFloatingText`	`function ShowFloatingText(string Text)`
`StatusChanged`	`function StatusChanged()`
`Think`	`function Think()`
`TriggerEvents`	`native function TriggerEvents(H7StructsAndEnumsNative.ETrigger triggerEvent, bool simulate, optional H7EventContainerStruct container)`
`TriggerStartTurnEvents`	`function bool TriggerStartTurnEvents()`
`UndoDeathMaterialFX`	`function UndoDeathMaterialFX(array<H7DeathMaterialEffect> deathMaterialEffects, optional array<MaterialInstanceConstant> unitMaterials)`
`UpdateParticleTranslucency`	`simulated function UpdateParticleTranslucency(ParticleSystemComponent PSC)`
`UseAttack`	`function UseAttack()`
`UseMove`	`function UseMove()`
`UsePreparedAbility`	`function UsePreparedAbility(H7IEffectTargetable Target)`
`Wait`	`function Wait()`
`WaveCatchCreatureStack`	`private final function WaveCatchCreatureStack(H7IEffectTargetable Unit)`

Default values¶

mTriggerTurnStartEvents=true
mTriggerTurnEndEvents=true
mPrivilegID=-1
mProjectileStartSocket="ProjectileStartPos"
mInitiative=1
mLuckType=ELuckType.NOTHING_LUCK
mFlankingBonus=1.0000000
mAttackCount=1
mMoveCount=1

Inherited¶

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