H7CustomNeutralDwelling¶

Class in MMH7Game · MMH7Game.H7CustomNeutralDwelling · native, perobjectconfig

Object › Actor › SkeletalMeshActor › SkeletalMeshCinematicActor › SkeletalMeshActorMAT › H7EditorMapObject › H7AdventureObject › H7VisitableSite › H7AreaOfControlSite › H7AreaOfControlSiteVassal › H7Dwelling › H7CustomNeutralDwelling

Using it from Lua

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

Properties¶

Name	Type	Notes
`mAllowedFactions`	`array<H7Faction>`	protected
`mVisitedHeroes`	`array<H7AdventureArmy>`	protected
`mWeeklyGrowthBuffer`	`array`	protected

Functions¶

Name	Declaration
`GetBaseCreature`	`function H7Creature GetBaseCreature(string creatureName, out int indexSource)`
`GetCreaturePool`	`function array<H7DwellingCreatureData> GetCreaturePool()`
`GetFreeStackSlots`	`function int GetFreeStackSlots()`
`GetPossibleRecruitCount`	`native function int GetPossibleRecruitCount(H7Creature Creature, H7ResourceSet resourceSet, int maxCount)`
`GetRecruitAllData`	`function array<H7RecruitmentInfo> GetRecruitAllData(optional bool checkGarrison = false, optional int freeSlots = -1, optional H7AdventureArmy aiArmy)`
`GetRecruitAllDataSub`	`function array<H7RecruitmentInfo> GetRecruitAllDataSub(H7ResourceSet resourceSet, bool recruitBaseCreature)`
`GetTooltipData`	`function H7TooltipData GetTooltipData(optional bool extendedVersion)`
`HasCreature`	`function bool HasCreature(H7Creature Creature)`
`HasVisited`	`function bool HasVisited(H7AdventureHero Hero)`
`InitAdventureObject`	`event InitAdventureObject()`
`OnVisit`	`function OnVisit(out H7AdventureHero Hero)`
`ProduceUnits`	`function ProduceUnits()`
`Recruit`	`function bool Recruit(string creatureName, int Count, optional out int TargetIndex)`
`RecruitAll`	`function RecruitAll()`
`RecruitDirect`	`function RecruitDirect(string creatureName, int Amount)`
`SetCreaturePool`	`function SetCreaturePool(array<H7DwellingCreatureData> pool)`
`WillBenefitFromVisit`	`function bool WillBenefitFromVisit(H7AdventureHero Hero)`

Default values¶

mIsProductive=true
mMinimapIcon=Texture2D'H7TextureGUI.icon_Minimap_NeutralBuilding'

Inherited¶

From	Members
H7Dwelling	Properties: mCreaturePool, mDailyGrowthBuffer, mGrowthCycle, mIsProductive, mIsUpgraded, mOverrideUpgradeCost, mUpgradeCost Functions: AiUpgradeCreatures, Conquer, CreatureIsInPool, creatureStrength, GetAddBoniOnStatByID, GetBaseCreature, GetBaseStatByID, GetCreatureIncome, GetCreaturePool, GetDefaultUpgradeCost, GetEntityType, GetFreeStackSlots, GetGrowthBonus, GetModifiedStatByID, GetModifiersByID, GetMultiBoniOnStatByID, GetPossibleRecruitCount, GetRecruitAllBlockReason, GetRecruitAllData, GetRecruitAllDataSub, GetTooltipData, GetUpgradeCost, GetUpgradeInfo, HandleOwnership, HireUnits, InitAdventureObject, InitIsUpgraded, isRecruitingUpgradedVersionAlready, IsUpgraded, OnVisit, ProducesUnit, ProduceUnits, Recruit, RecruitAll, RecruitDirect, SetCreaturePool, SetProductive, Upgrade, UpgradeComplete, UpgradeUnit, UpgradeUnitAI, UpgradeUnitComplete
H7AreaOfControlSiteVassal	Properties: mLord Functions: GetLord, HandleOwnership, OnVisit, RenderDebugInfo, SpendPickupCostsOnVisit
H7AreaOfControlSite	Properties: mAiThreateningArmy, mAiThreatLevel, mCaravanArmy, mDisabledCreaturesInLocalGuard, mEditorArmy, mFaction, mFlag, mHasMinimapIcon, mHiddenBuilding, mIcon, mInInit, mLocalGuard, mLocalGuardFactions, mLocalGuardOverride, mOnRepairSound, mOnTakeOverSound, mOnVisitSound, mSightRadius, mSiteOwner, mUseXPStrength, mXPStrength Functions: AddArrivedCaravan, CalculateThreat, CanSendCaravanTo, ChangeFlag, CheckPathToSite, ClearLocalGuardReserve, Conquer, CreateEmptyCaravan, CreateEmptyGarrison, DeleteCaravan, GetAiThreatLevel, GetArrivedCaravanByIndexReadOnly, GetArrivedCaravans, GetCaravanArmy, GetColor, GetFaction, GetFlag, GetFlashIconPath, GetFlashMinimapPath, GetFreeStackSlots, GetGarrisonArmy, GetGuardCapacityFor, GetGuardIncomeFor, GetGuardingArmy, GetHasMinimap, GetHeightPos, GetIcon, GetIconPath, GetInitState, GetLevel, GetLocalGuard, GetLocalGuardAsBaseCreatureStacks, GetMinimapIcon, GetPlayer, GetPlayerNumber, GetRecruitAllBlockReason, GetRecruitAllData, GetSite, GetStrengthValue, GetUpgradeInfo, HandleOwnership, HandleSightRadius, HasStandingLocalGuard, HasUncheckedCaravans, HasWaitingCaravans, Hide, InitAdventureObject, InitSiteOwner, IsCaravanEmpty, IsCreatureDisabledInLocalGuard, IsHiddenX, IsInScoutingRangeOfLocalPlayer, MergeArmies, MergeArmiesComplete, OnTerrainChange, OnVisit, PostSerialize, ProduceDayUnits, ProduceUnits, RemoveCaravanArmy, RenderDebugInfo, RequestUnloadCaravan, Reveal, SetAiThreatLevel, SetArrivedCaravanStacks, SetCaravanArmy, SetFaction, SetGarrisonArmy, SetGuardingArmy, SetInitState, SetSiteOwner, SetUncheckedCaravans, SpawnFlag, TransferHero, TransferHeroComplete, UnloadCaravan, UnloadCaravans, UpdateLocalGuardByCreature, UpdateLocalGuardReserve
H7VisitableSite	Properties: mAbilityManager, mAdventureController, mAiBaseUtility, mAiOnIgnore, mBuffFlags, mBuffManager, mCliffMat, mClusterRef, mCustomNameInst, mEffectManager, mEntranceCell, mEntranceOffset, mEntranceSprite, mEventManager, mGlobalName, mHeroEventParam, mInitDone, mInitNameDone, mIsUnblockingEntrance, mLandscape, mLayer, mMinimapColor, mMinimapHidden, mMinimapIcon, mName, mQuestFlag, mReachabilityCheckDone, mSavedLocation, mSavedRotation, mUseCustomName, mVisitingArmy Functions: AdaptToLandscape, AddBuffFlag, AddQuestFlag, AddSelfToMinimap, ApplyDamage, ClearQuestFlag, DataChanged, Destroyed, GetAbilityManager, GetActionID, GetAiBaseUtility, GetAiOnIgnore, GetAttack, GetBuffFlags, GetBuffManager, GetColor, GetCombatArmy, GetCurrentPosition, GetCustomName, GetEffectManager, GetEntityType, GetEntranceCell, GetEntranceOffset, GetEventManager, GetFlashMinimapPath, GetGridPosition, GetHasMinimap, GetHeightAsVector, GetHitPoints, GetID, GetLocation, GetLuckDestiny, GetMagic, GetMaximumDamage, GetMinimapColor, GetMinimapHidden, GetMinimapIcon, GetMinimumDamage, GetName, GetOriginal, GetPlayer, GetPreparedAbility, GetResistanceModifierFor, GetSchool, GetStackSize, GetVisitingArmy, GetVisitString, GetWorldEntranceNative, GUIAddListener, GUIWriteInto, InitAdventureObject, IsDefaultAttackActive, IsHidden, IsMovable, IsNeutral, IsUnblockingEntrance, LocalizeCustomName, NotifyVisit, OnTerrainChange, OnVisit, OverrideName, PostSerialize, PrepareAbility, ReorderBuffFlags, SetAiOnIgnore, SetAiUtilityValue, SetMinimapColor, SetMinimapHidden, SetName, SetVisitingArmy, SpendPickupCostsOnVisit, TriggerEvents, UnregisterEventManageable, UsePreparedAbility
H7AdventureObject	Properties: frameCount, mFloatRotationIntensity, mFloatSwayIntensity, Mid, mIsFloating, mOriginalLocation, mPassabilityType Functions: AddQuestFlag, ClearQuestFlag, GetCellsUnderMe, GetCurrentPosition, GetName, GetQuestTargetID, InitAdventureObject, IsFloating, IsHidden, IsMovable, OnDoubleClick, OnLeftClick, OnRightClick, OnVisit, PostBeginPlay, ReferenceSelfToCells, SetFloating, UpdateFloating
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