H7AreaOfControlSiteLord¶

Class in MMH7Game · MMH7Game.H7AreaOfControlSiteLord · native, perobjectconfig

Object › Actor › SkeletalMeshActor › SkeletalMeshCinematicActor › SkeletalMeshActorMAT › H7EditorMapObject › H7AdventureObject › H7VisitableSite › H7AreaOfControlSite › H7AreaOfControlSiteLord

Subclasses: H7Fort, H7Town

Using it from Lua

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

Properties¶

Name	Type	Notes
`mAoCCreaturePool`	`array<H7DwellingCreatureData>`	protected
`mAreaOfControlID`	`int`	protected
`mArrivedCaravans`	`array<ArrivedCaravan>`	protected
`mBorderCells`	`array<H7AdventureMapCell>`	protected
`mCanCreateCaravanThisTurn`	`bool`	protected
`mDefenseData`	`RandomLordDefenseData`	protected
`mGarrisonArmy`	`H7AdventureArmy`	protected
`mGuardingArmy`	`H7AdventureArmy`	protected
`mHasRequiredDwellingFor`	`array<H7Creature>`	protected
`mHasUncheckedCaravans`	`bool`	protected
`mLevel`	`int`	protected
`mVassals`	`array<H7AreaOfControlSiteVassal>`	protected

Functions¶

Name	Declaration
`AddArrivedCaravan`	`function AddArrivedCaravan(ArrivedCaravan Value)`
`AiPickupCreatures`	`function AiPickupCreatures()`
`AIRecruitAllFromDwelling`	`function AIRecruitAllFromDwelling(H7Dwelling Dwelling)`
`AIRecruitAllFromTown`	`function AIRecruitAllFromTown()`
`AIRecruitAllFromTownIntoCaravan`	`function AIRecruitAllFromTownIntoCaravan(H7AreaOfControlSite caravanTarget)`
`AiUpgradeCreatures`	`function AiUpgradeCreatures()`
`CalculateLocalGuard`	`function CalculateLocalGuard(H7TownGuardBuilding responsibleBuilding)`
`CalculateRecruitmentCosts`	`native function CalculateRecruitmentCosts(H7Creature Creature, int Count, out array<H7ResourceQuantity> Costs, optional bool Upgrade, optional H7Creature baseCreature)`
`CanAcceptCaravan`	`function bool CanAcceptCaravan(optional H7AreaOfControlSiteLord sourceLord)`
`CanCreateCaravan`	`function bool CanCreateCaravan()`
`CanHaveCaravan`	`function bool CanHaveCaravan()`
`CaravanLeaveTown`	`function CaravanLeaveTown()`
`Conquer`	`function Conquer(H7AdventureHero conqueror)`
`CreateDefaultGarrison`	`function CreateDefaultGarrison()`
`CreateEmptyGarrison`	`function CreateEmptyGarrison(optional bool synchronise = false)`
`CreateNewCaravan`	`function CreateNewCaravan()`
`DbgDumpArmies`	`function DbgDumpArmies()`
`DeleteCaravan`	`function DeleteCaravan(int caravanIndex)`
`DowngradeLocalGuard`	`function DowngradeLocalGuard(H7TownGuardBuilding responsibleBuilding, optional H7TownGuardGrowthEnhancer guardEnhancer)`
`getAllCreaturesFromTown`	`function getAllCreaturesFromTown(out array<H7RecruitmentInfo> tempRecInfo)`
`getAllCreaturesFromVassels`	`function getAllCreaturesFromVassels(out array<H7RecruitmentInfo> tempRecInfo)`
`GetAoCCreaturePool`	`function array<H7DwellingCreatureData> GetAoCCreaturePool()`
`GetAreaOfControlID`	`function int GetAreaOfControlID()`
`GetArrivedCaravanByIndexReadOnly`	`function ArrivedCaravan GetArrivedCaravanByIndexReadOnly(int Index)`
`GetArrivedCaravans`	`function array<ArrivedCaravan> GetArrivedCaravans()`
`GetCreaturePool`	`function array<H7DwellingCreatureData> GetCreaturePool()`
`GetFreeSlotIndexOfArmy`	`static function int GetFreeSlotIndexOfArmy(H7AdventureArmy targetArmy, optional H7BaseCreatureStack transferStack)`
`GetFreeStackSlots`	`function int GetFreeStackSlots()`
`GetGarrisonArmy`	`event H7AdventureArmy GetGarrisonArmy()`
`GetGarrisonStacks`	`function array<H7BaseCreatureStack> GetGarrisonStacks()`
`GetGuardingArmy`	`event H7AdventureArmy GetGuardingArmy()`
`GetLevel`	`function int GetLevel()`
`GetLocalCreatureStackByIndex`	`function H7BaseCreatureStack GetLocalCreatureStackByIndex(int Index)`
`GetLocalStacks`	`function array<H7BaseCreatureStack> GetLocalStacks()`
`GetOutsideDwellings`	`function array<H7Dwelling> GetOutsideDwellings()`
`GetPossibleRecruitCount`	`native function int GetPossibleRecruitCount(H7Creature Creature, H7ResourceSet resourceSet, int maxCount)`
`GetRecruitAllBlockReason`	`function string GetRecruitAllBlockReason(optional int freeSlots = -1)`
`GetRecruitAllBlockReasonForCaravan`	`function string GetRecruitAllBlockReasonForCaravan()`
`GetRecruitAllData`	`function array<H7RecruitmentInfo> GetRecruitAllData(optional bool checkGarrison = false, optional int freeSlots = -1, optional H7AdventureArmy aiArmy)`
`GetRecruitAllDataForCaravan`	`function array<H7RecruitmentInfo> GetRecruitAllDataForCaravan()`
`getRecruitAllDataFromTownForCaravan`	`function getRecruitAllDataFromTownForCaravan(bool recruitBaseVersion, out H7ResourceSet resourceSet, out int freeSlots, out array<H7RecruitmentInfo> recruitmentInfos)`
`GetRecruitmentCostModifier`	`function float GetRecruitmentCostModifier()`
`GetStrongestStack`	`function H7BaseCreatureStack GetStrongestStack(ArrivedCaravan aCaravan)`
`GetUniqueStackTypeCount`	`static function int GetUniqueStackTypeCount(H7AdventureArmy army1, H7AdventureArmy army2)`
`GetUpgradedCreature`	`function H7Creature GetUpgradedCreature(string creatureName)`
`GetUpgradeInfo`	`function array<H7ResourceQuantity> GetUpgradeInfo(bool isVisitingArmy, out int numOfUpgCreatures, optional H7BaseCreatureStack Creature = none, optional int slotID = -1, optional out array<H7ResourceQuantity> singleUpgCost, optional bool lockNum = false)`
`GetVassals`	`function array<H7AreaOfControlSiteVassal> GetVassals()`
`GetVisitorStacks`	`function array<H7BaseCreatureStack> GetVisitorStacks()`
`HandleOwnership`	`protected function HandleOwnership(H7AdventureHero visitingHero)`
`HasRequiredDwelling`	`function bool HasRequiredDwelling(H7Creature upgradedCreature)`
`HasRequiredDwellingTier`	`protected function bool HasRequiredDwellingTier(H7StructsAndEnumsNative.ECreatureTier Tier)`
`HasUncheckedCaravans`	`function bool HasUncheckedCaravans()`
`HasWaitingCaravans`	`function bool HasWaitingCaravans()`
`InitAdventureObject`	`event InitAdventureObject()`
`InitBorderCells`	`simulated function InitBorderCells()`
`IsCaravanEmpty`	`function bool IsCaravanEmpty(int caravanIndex)`
`isRecruitingCreatureAlready`	`function bool isRecruitingCreatureAlready(array<H7RecruitmentInfo> recruitmentInfos, H7Creature Creature)`
`isRecruitingUpgradedVersionFromDwelling`	`function bool isRecruitingUpgradedVersionFromDwelling(array<H7RecruitmentInfo> recruitmentInfos, H7RecruitmentInfo recruitmentInfoToTest, optional bool checkDwelling = false)`
`MergeArmies`	`function MergeArmies(H7StructsAndEnums.EArmyNumber fromArmy, H7StructsAndEnums.EArmyNumber toArmy)`
`MergeArmiesComplete`	`function bool MergeArmiesComplete(H7StructsAndEnums.EArmyNumber fromArmy, H7StructsAndEnums.EArmyNumber toArmy)`
`OnVisit`	`function OnVisit(out H7AdventureHero Hero)`
`Recruit`	`function Recruit(string creatureName, int Count, bool isHiringFromAoC, optional H7Dwelling OriginDwelling, optional bool recruitToCaravan = false, optional bool recruitToDwellingVisitor, optional H7AreaOfControlSite caravanTarget, optional bool updateGui = true)`
`RecruitAll`	`function RecruitAll(bool fromAoC, optional bool toDwellingVisitor, optional out array recruitmentSlotIndixes, optional out array<H7StructsAndEnums.EArmyNumber> reenforcedArmies)`
`RecruitComplete`	`function bool RecruitComplete(string creatureName, int Count, bool isHiringFromAoC, optional out int TargetIndex, optional H7Dwelling OriginDwelling, optional out H7StructsAndEnums.EArmyNumber targetArmy, optional bool recruitToCaravan = false, optional bool recruitToDwellingVisitor, optional H7AreaOfControlSite caravanTarget)`
`RenderDebugInfo`	`function RenderDebugInfo(Canvas myCanvas)`
`RequestUnloadCaravan`	`function RequestUnloadCaravan(int caravanIndex, optional bool automatic = true)`
`RequestUnloadCaravans`	`function RequestUnloadCaravans()`
`SetArmy`	`function SetArmy(H7AdventureArmy Army)`
`SetArrivedCaravanStacks`	`function SetArrivedCaravanStacks(int Index, array<H7BaseCreatureStack> stacks)`
`SetGarrisonArmy`	`function SetGarrisonArmy(H7AdventureArmy Army)`
`SetGuardingArmy`	`event SetGuardingArmy(H7AdventureArmy Army)`
`SetLevel`	`function SetLevel(int Level)`
`SetSiteOwner`	`function SetSiteOwner(H7StructsAndEnumsNative.EPlayerNumber NewOwner, optional bool showPopup = true)`
`SetUncheckedCaravans`	`function SetUncheckedCaravans(bool val)`
`sortRecDataInArray`	`function sortRecDataInArray(H7RecruitmentInfo recData, out array<H7RecruitmentInfo> tempRecInfo)`
`SortStackPoolMerge`	`function int SortStackPoolMerge(H7BaseCreatureStack A, H7BaseCreatureStack B)`
`SpawnGarrisonedArmy`	`private final function SpawnGarrisonedArmy()`
`SpendPickupCostsOnVisit`	`function bool SpendPickupCostsOnVisit(H7AdventureHero visitingHero)`
`TransferHero`	`function TransferHero(H7StructsAndEnums.EArmyNumber fromArmy, H7StructsAndEnums.EArmyNumber toArmy)`
`TransferHeroComplete`	`function bool TransferHeroComplete(H7StructsAndEnums.EArmyNumber fromArmy, H7StructsAndEnums.EArmyNumber toArmy)`
`UnloadCaravan`	`function bool UnloadCaravan(int caravanIndex, optional bool automatic = true)`
`UnloadCaravans`	`function UnloadCaravans()`
`UpdateLocalGuardGUI`	`function UpdateLocalGuardGUI()`
`UpgradeUnit`	`function UpgradeUnit(int slotID, bool isVisitingArmy, int Count)`
`UpgradeUnitAI`	`function bool UpgradeUnitAI(H7AdventureArmy Army, H7BaseCreatureStack crStack, optional bool doSynchronise = true)`
`UpgradeUnitComplete`	`function UpgradeUnitComplete(int slotID, bool isVisitingArmy, int Count)`
`writeActualRecruitmentDataForCaravan`	`function writeActualRecruitmentDataForCaravan(out array<H7RecruitmentInfo> actualRecruitmentData, array<H7RecruitmentInfo> tempRecInfos, H7ResourceSet resourceSet, int freeSlots)`
`writeActualRecuitmentData`	`function writeActualRecuitmentData(out array<H7RecruitmentInfo> actualRecruitmentData, array<H7RecruitmentInfo> tempRecInfos, H7ResourceSet resourceSet, int freeSlots, optional bool checkGarrisonArmy = false)`

Default values¶

mDefenseData=(mUseThis=false,mMinStackNumber=3,mMaxStackNumber=7,mAllowedFactions=none,mFactionType=ERandomSiteFaction.E_H7_RSF_AS_ANOTHER_TOWN,mReferenceLord=none,mUseFactionOfLord=true,mUseCreatureLevel=true,mAllowedLevels=(Allowed=true),mAllowedLevels[1]=(Allowed=true),mAllowedLevels[2]=(Allow...

Inherited¶

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