H7AdventureHero¶

Class in MMH7Game · MMH7Game.H7AdventureHero · native, perobjectconfig

Object › Actor › SkeletalMeshActor › SkeletalMeshCinematicActor › SkeletalMeshActorMAT › H7Unit › H7EditorHero › H7AdventureHero

Implements: H7ITooltipable, H7IGUIListenable

Subclasses: H7Caravan

Using it from Lua

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

Properties¶

Name	Type	Notes
`mAiClaimedSite`	`H7VisitableSite`	protected
`mAiDesiredTradeResource`	`H7Resource`	protected
`mAiHasTradedToday`	`bool`	protected
`mAiLastScoreAction`	`H7AiActionBase`	protected
`mAiLastScoreActionCounter`	`int`	protected
`mAiLastScoreParams`	`H7AiActionParam`	protected
`mCanScout`	`bool`	protected
`mCurrentPath`	`array<H7AdventureMapCell>`	protected
`mFakeCell`	`H7AdventureMapCell`	protected
`mGovernedTown`	`H7Town`	protected
`mGovernorAbilities`	`array<H7BaseAbility>`	protected
`mHasCastedSpellThisTurn`	`bool`	protected
`mHasFinishedCurrentTurn`	`bool`	protected
`mHasTearOfAsha`	`bool`	protected
`mIsAlliedWithEverybody`	`bool`	protected
`mIsInCombat`	`bool`	protected
`mLastCellMovement`	`H7AdventureMapCell`	protected
`mMinimapColor`	`Color`	transient, protected
`mMinimapHidden`	`bool`	transient, protected
`mMoveControl`	`H7CreatureStackMovementControl`	protected
`mScoutingRadius`	`int`	protected
`mTerrainCostModifier`	`float`	protected

Functions¶

Name	Declaration
`AddGovernorAbility`	`event AddGovernorAbility(H7BaseAbility newAbility)`
`AddSelfToMinimap`	`function AddSelfToMinimap()`
`AssignMaterials`	`event AssignMaterials()`
`CanBuildCaravanOutpost`	`function bool CanBuildCaravanOutpost(optional out string blockReason)`
`CanScout`	`function bool CanScout()`
`Convert`	`function H7CombatHero Convert(optional H7CombatArmy Army, optional name herotag, optional Vector heroLocation, optional Rotator heroRotation)`
`DataChanged`	`function DataChanged(optional string cause)`
`DebugLogSelf`	`protected function DebugLogSelf()`
`DecreaseBaseStatByID`	`function DecreaseBaseStatByID(H7StructsAndEnumsNative.EStat desiredStat, optional int Amount = 1)`
`DelayedPostLearnAbilityExplore`	`function DelayedPostLearnAbilityExplore()`
`DelayedTearOfAshaRevealMessageFail`	`function DelayedTearOfAshaRevealMessageFail()`
`DelayedTearOfAshaRevealMessageSuccess`	`function DelayedTearOfAshaRevealMessageSuccess()`
`Deserialize`	`function Deserialize(JsonObject Data)`
`DeserializeReferences`	`function DeserializeReferences(JsonObject Data, SaveGameState Savegame)`
`Destroyed`	`simulated event Destroyed()`
`DestroyTearOfAsha`	`function DestroyTearOfAsha()`
`DumpCurrentState`	`function DumpCurrentState()`
`EndMoving`	`function EndMoving(optional bool ignoreTargetNotReachedMessage = true)`
`ForceReapplyPlayerChanged`	`function ForceReapplyPlayerChanged()`
`GetAiLastScoreAction`	`function H7AiActionBase GetAiLastScoreAction()`
`GetAiLastScoreActionCounter`	`function int GetAiLastScoreActionCounter()`
`GetAiLastScoreParam`	`function H7AiActionParam GetAiLastScoreParam()`
`GetCell`	`function H7AdventureMapCell GetCell()`
`GetClaimedSite`	`function H7VisitableSite GetClaimedSite()`
`GetCurrentPath`	`function array<H7AdventureMapCell> GetCurrentPath()`
`GetDesiredTradeResource`	`function H7Resource GetDesiredTradeResource()`
`GetFakeCell`	`function H7AdventureMapCell GetFakeCell()`
`GetGovernedTown`	`function H7Town GetGovernedTown()`
`GetGovernorAbilities`	`function array<H7BaseAbility> GetGovernorAbilities()`
`GetGridPosition`	`function IntPoint GetGridPosition()`
`GetHasTradedToday`	`function bool GetHasTradedToday()`
`GetLastCellMovement`	`function H7AdventureMapCell GetLastCellMovement()`
`GetMinimapColor`	`function Color GetMinimapColor()`
`GetMinimapHidden`	`function bool GetMinimapHidden()`
`GetMoveControl`	`function H7CreatureStackMovementControl GetMoveControl()`
`GetScoutingRadius`	`function int GetScoutingRadius()`
`GetScoutingRadiusBase`	`function int GetScoutingRadiusBase()`
`GetSelectionFX`	`function H7HeroFX GetSelectionFX()`
`GetTerrainCostModifier`	`function float GetTerrainCostModifier()`
`GetTerrainCostModifierBase`	`function float GetTerrainCostModifierBase()`
`GetTooltipData`	`function H7TooltipData GetTooltipData(optional bool extendedVersion)`
`GUIAddListener`	`function GUIAddListener(GFxObject Data, optional H7StructsAndEnums.H7ListenFocus Focus)`
`HasCastedSpellThisTurn`	`function bool HasCastedSpellThisTurn()`
`HasFinishedCurrentTurn`	`function bool HasFinishedCurrentTurn()`
`HasGovernorEffect`	`function bool HasGovernorEffect()`
`HasTearOfAsha`	`function bool HasTearOfAsha()`
`IncreaseBaseStatByID`	`function float IncreaseBaseStatByID(H7StructsAndEnumsNative.EStat desiredStat, optional int Amount = 1)`
`Init`	`function Init(optional bool fromSave)`
`IsAlliedWithEverybody`	`function bool IsAlliedWithEverybody()`
`IsAttacker`	`function bool IsAttacker()`
`IsGovernourOfTown`	`event bool IsGovernourOfTown()`
`IsInCombat`	`function bool IsInCombat()`
`IsMoving`	`function bool IsMoving()`
`MoveHero`	`function MoveHero(array<H7BaseCell> Path, optional H7Unit targetUnit, optional bool followCam = true)`
`QuerySpellInstantRecall`	`function H7HeroAbility QuerySpellInstantRecall()`
`RecalculateAggressiveness`	`function RecalculateAggressiveness()`
`RemoveGovernorAbility`	`function RemoveGovernorAbility(H7BaseAbility Ability)`
`RestoreSavedPath`	`function RestoreSavedPath(SavegameHeroStruct SaveGameData)`
`RestoreState`	`function RestoreState(SavegameHeroStruct SaveGameData)`
`RotateHero`	`function RotateHero(int targetYaw)`
`Select`	`event Select(bool doSelect, optional bool doFocus = true)`
`Serialize`	`function JsonObject Serialize()`
`SetAiLastScoreAction`	`function SetAiLastScoreAction(H7AiActionBase ab)`
`SetAiLastScoreActionCounter`	`function SetAiLastScoreActionCounter(int ap)`
`SetAiLastScoreParam`	`function SetAiLastScoreParam(H7AiActionParam ap)`
`SetBaseStatByID`	`function SetBaseStatByID(H7StructsAndEnumsNative.EStat desiredStat, int NewValue)`
`SetCanScout`	`function SetCanScout(bool val)`
`SetCastedSpellThisTurn`	`function SetCastedSpellThisTurn(bool hasCasted)`
`SetClaimedSite`	`function SetClaimedSite(H7VisitableSite Site)`
`SetCurrentPath`	`function SetCurrentPath(array<H7AdventureMapCell> newPath)`
`SetDead`	`function SetDead(optional bool unequipItems = false)`
`SetDesiredTradeResource`	`function SetDesiredTradeResource(H7Resource res)`
`SetFakeCell`	`function SetFakeCell(H7AdventureMapCell cell)`
`SetFinishedCurrentTurn`	`function SetFinishedCurrentTurn(bool hasFinished)`
`SetGovernedTown`	`function SetGovernedTown(H7Town Town)`
`SetHasTearOfAsha`	`function SetHasTearOfAsha(bool val)`
`SetHasTradedToday`	`function SetHasTradedToday(bool hasTraded)`
`SetIsAlliedWithEverybody`	`function SetIsAlliedWithEverybody(bool val)`
`SetIsInCombat`	`function SetIsInCombat(bool IsInCombat)`
`SetLastCellMovement`	`function SetLastCellMovement(H7AdventureMapCell newCell)`
`SetMinimapColor`	`function SetMinimapColor(Color val)`
`SetMinimapHidden`	`function SetMinimapHidden(bool val)`
`SetPlayer`	`function SetPlayer(H7Player NewPlayer)`
`SetScoutingRadius`	`function SetScoutingRadius(int NewRadius)`
`StopMoving`	`function StopMoving()`
`UpdatePath`	`function bool UpdatePath()`
`UpdateSelectionFX`	`event UpdateSelectionFX()`
`UpdateSpells`	`function UpdateSpells()`

Default values¶

mScoutingRadius=12
mTerrainCostModifier=1.0000000
mMinimapHidden=true

Inherited¶

From	Members
H7EditorHero	Properties: HeroMaterials, mAiAggressiveness, mAiControlType, mAiHomeRadius, mAiHomeSite, mAiInHibernation, mAiObjectiveArmy, mAiObjectiveSite, mAiOnPatrol, mAiPatrolController, mAiPreferedRole, mAiRole, mAiRolePriority, mAnimControl, mArcaneKnowledgeBase, mBattleRage, mBoardShipSounds, mCampaignTransitionHeroArchetype, mClass, mColor, mCombatPopUpScreenStartSounds, mCurrentMana, mCurrentMovementPoints, mCurrentPreviewAbility, mEndMountedIdleSound_Magic, mEndMountedIdleSound_Might, mEndMountedRandomMoveSounds, mEndShipIdleSounds, mEndShipRandomMoveSounds, mEngageManuallySounds, mEngageQuickCombatSounds, mEquipment, mFactionBGHeroWindow, mFactionSpecializationFrame, mFX, mGlobalName, mHeroBioData, mHeroEventParam, mHeroPediaOverwrite, mHeroSkeletalMesh, mHoHDefaultArmy, mHorseSkeletalMesh, mImage, mImageXOffset, mImageYOffset, mInventory, mIsHero, mIsPendingLevelUp, mIsPowerLeveling, mLevel, mLevelUpSounds, mMagic, mManaRegenBase, mMaxDamagePerLevel, mMaxDeploymentNumber, mMaxDeploymentRows, mMaxManaBonus, mMetamagic, mMinDamagePerLevel, mMountedAbilitySound_Magic, mMountedAbilitySound_Might, mMountedAttackSound_Magic, mMountedAttackSound_Might, mMountedCommandSound_Magic, mMountedCommandSound_Might, mMountedDefeatSound_Magic, mMountedDefeatSound_Might, mMountedRangeAttackSound_Magic, mMountedRangeAttackSound_Might, mMountedTurnLeftSounds, mMountedTurnRightSounds, mMountedVictorySound_Magic, mMountedVictorySound_Might, mOriginArchetype, mOverrideHeroClassSkills, mOverwriteIcon, mOwningPlayer, mPreLearnedSkills, mQuickBarAdventure, mQuickBarCombat, mSaveHeroProgress, mSaveMovementPoints, mScriptedBehaviour, mShipTurningSounds, mSkillManager, mSkillPoints, mSpirit, mStartingAbility, mStartingSpellArchetypes, mStartMountedIdleSound_Magic, mStartMountedIdleSound_Might, mStartMountedRandomMoveSounds, mStartShipIdleSounds, mStartShipRandomMoveSounds, mStartSkills, mTransientName, mVisuals, mWarfareSiege, mWeaponMesh, mXp, mXpProgress Functions: AddBuffsToDataObject, AddItemBoniToDataObject, AddMana, AddMaxManaBonus, AddSkillPoint, AddXp, BeginTurn, CheckQuickBar, ClampCurrentMana, ClampCurrentMovementPoints, ClearHeroMeshData, ClearScriptedBehaviour, CreateHero, DecreaseBaseStatByID, DeleteImage, Deserialize, DeserializeReferences, Destroyed, EnableAdventureIdleBridge, EndTurn, GetAbilities, GetAiAggressivness, GetAiControlType, GetAiHibernationState, GetAiHomeRadius, GetAiHomeSite, GetAiObjectiveArmy, GetAiObjectiveSite, GetAiOnPatrol, GetAiPatrolController, GetAiPreferedRole, GetAiRole, GetAiRolePriority, GetAmountOfWarcries, GetAnimControl, GetArcaneKnowledge, GetArcaneKnowledgeAsInt, GetArcaneKnowledgeBaseAsInt, GetArcangeKnowlageBase, GetArchetypeID, GetAttackBase, GetAttackRange, GetBaseStatByID, GetBattleRage, GetBoniFromItemSet, GetCampaignTransitionHeroArchetype, GetClampedCurrentMana, GetColor, GetCurrentMana, GetCurrentMovementPoints, GetCurrentXPForNextLevel, GetDamageRangeBase, GetDefenseBase, GetDiplomacyMod, GetEntityType, GetEquipment, GetExperiencePoints, GetFactionAuraInnerDecalTexture, GetFactionAuraOuterDecalTexture, GetFactionBGHeroWindow, GetFactionSpecializationFrame, GetFlashImagePath, GetFlashMinimapPath, GetHeightPos, GetHeroBioData, GetHeroClass, GetHeroFX, GetHeropediaOverwrite, GetHoHDefaultArmy, GetHorseRiderOffset, GetHPArchetypeID, GetIcon, GetInventory, GetIsOverrideHeroClass, GetIsScripted, GetLevel, GetLevelXPRange, GetLvl30XPNeeded, GetMagic, GetMagicBase, GetManaCostForSpell, GetManaRegen, GetManaRegenBase, GetMaxDeploymentNumber, GetMaxDeploymentRow, GetMaximumDamage, GetMaximumDamageBase, GetMaximumDamagePerLevel, GetMaxMana, GetMaxManaBase, GetMaxManaBonus, GetMeshCenter, GetMetamagic, GetMinimumDamage, GetMinimumDamageBase, GetMinimumDamagePerLevel, GetModifierByContainer, GetModifiersByID, GetMoveCostForTerrainType, GetMovementPoints, GetName, GetNextLevelXp, GetOriginArchetype, GetPlayer, GetPreLearnedHeroSkills, GetPrevLevelXp, GetProductionEffects, GetQuickBarSpells, GetQuickCombatSubstituteImpact, GetRelativeHeightPos, GetSaveProgress, GetSiegeWarUnitTemplate, GetSkillManager, GetSkillPoints, GetSkillsArchetype, GetSocketLocation, GetSourceArchetype, GetSpecialization, GetSpells, GetSpirit, GetSpiritBase, GetVisuals, GUIWriteInto, HandleLevelUpMessage, HasBuffFromAbility, HasPendingLevelUp, IncreaseBaseStatByID, Init, InitFX, InitSkillsAndAbilities, InvokeLevelUp, IsHero, IsMagicHero, IsMightHero, LearnItemAbilities, LevelUpStats, OverrideAbilityManager, OverrideBuffManager, OverrideSkillManager, PlayHeroSound, PlayParticleEffect, RegenMana, RestoreSavedMovementPoints, Serialize, SetAiAggressivness, SetAiControlType, SetAiHibernationState, SetAiHomeRadius, SetAiHomeSite, SetAiPreferedRole, SetAiRole, SetAiRolePriority, SetArcangeKnowlageBase, SetAttack, SetBaseStatByID, SetBattleRage, SetCampaignTransitionHeroArchetype, SetClass, SetCurrentMana, SetCurrentMovementPoints, SetCurrentPreviewAbility, SetDefense, SetDestiny, SetEquipment, SetFaction, SetFactionBGHeroWindow, SetFactionSpecializationFrame, SetHeropediaOverwrite, SetHoHDefaultArmy, SetIcon, SetImage, SetImageXOffset, SetImageYOffset, SetInitiative, SetInventory, SetIsHero, SetLeadership, SetLevel, SetMagic, SetManaRegeneration, SetMaximumDamage, SetMaxManaBonus, SetMaxMovementPoints, SetMeshes, SetMinimumDamage, SetMovementAudioType, SetOriginArchetype, SetOverrideHeroClass, SetPendingLevelUp, SetPlayer, SetPreLearnedSkills, SetQuickBarSpells, SetSaveProgress, SetScriptedBehaviour, SetSiegeWarUnitTemplate, SetSkillPoints, SetSpecialization, SetSpirit, SetStartingSpellArchetypes, SetStartSkills, SetTransientName, SetVisuals, SetXp, SpawnAnimControl, SpendSkillPoint, TriggerEvents, UpdateOutline, UseMana, UseMovementPoints
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