H7AreaOfControlSite¶

Class in MMH7Game · MMH7Game.H7AreaOfControlSite · native, perobjectconfig

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

Implements: H7IDefendable, H7IOwnable, H7IHideable

Subclasses: H7AreaOfControlSiteLord, H7AreaOfControlSiteVassal, H7CaravanOutpost, H7Garrison

Using it from Lua

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

Properties¶

Name	Type	Notes
`mAiThreateningArmy`	`H7AdventureArmy`	protectedwrite
`mAiThreatLevel`	`float`	protected
`mCaravanArmy`	`H7CaravanArmy`	protected
`mDisabledCreaturesInLocalGuard`	`array<H7Creature>`	protected
`mEditorArmy`	`H7AdventureArmy`	protected
`mFaction`	`H7Faction`
`mFlag`	`H7Flag`	protected
`mHasMinimapIcon`	`bool`	protected
`mHiddenBuilding`	`bool`	protected
`mIcon`	`Texture2D`	protected
`mInInit`	`bool`	protected
`mLocalGuard`	`array<H7DwellingCreatureData>`	protected
`mLocalGuardFactions`	`array<H7Faction>`	protected
`mLocalGuardOverride`	`bool`	protected
`mOnRepairSound`	`AkEvent`	protected
`mOnTakeOverSound`	`AkEvent`	protected
`mOnVisitSound`	`AkEvent`	protected
`mSightRadius`	`int`	protected
`mSiteOwner`	`H7StructsAndEnumsNative.EPlayerNumber`	protected
`mUseXPStrength`	`bool`	protected
`mXPStrength`	`int`	protected

Functions¶

Name	Declaration
`AddArrivedCaravan`	`function AddArrivedCaravan(ArrivedCaravan Value)`
`CalculateThreat`	`native function CalculateThreat()`
`CanSendCaravanTo`	`function bool CanSendCaravanTo(H7VisitableSite targetSite)`
`ChangeFlag`	`protected function ChangeFlag()`
`CheckPathToSite`	`function float CheckPathToSite(optional H7AreaOfControlSite Site)`
`ClearLocalGuardReserve`	`function ClearLocalGuardReserve()`
`Conquer`	`function Conquer(H7AdventureHero conqueror)`
`CreateEmptyCaravan`	`function CreateEmptyCaravan()`
`CreateEmptyGarrison`	`function CreateEmptyGarrison(optional bool synchronise = false)`
`DeleteCaravan`	`function DeleteCaravan(int caravanIndex)`
`GetAiThreatLevel`	`function float GetAiThreatLevel()`
`GetArrivedCaravanByIndexReadOnly`	`function ArrivedCaravan GetArrivedCaravanByIndexReadOnly(int Index)`
`GetArrivedCaravans`	`function array<ArrivedCaravan> GetArrivedCaravans()`
`GetCaravanArmy`	`function H7CaravanArmy GetCaravanArmy()`
`GetColor`	`function Color GetColor()`
`GetFaction`	`function H7Faction GetFaction()`
`GetFlag`	`function H7Flag GetFlag()`
`GetFlashIconPath`	`function string GetFlashIconPath()`
`GetFlashMinimapPath`	`function string GetFlashMinimapPath()`
`GetFreeStackSlots`	`function int GetFreeStackSlots()`
`GetGarrisonArmy`	`event H7AdventureArmy GetGarrisonArmy()`
`GetGuardCapacityFor`	`function int GetGuardCapacityFor(H7DwellingCreatureData Data)`
`GetGuardIncomeFor`	`function int GetGuardIncomeFor(H7DwellingCreatureData Data)`
`GetGuardingArmy`	`event H7AdventureArmy GetGuardingArmy()`
`GetHasMinimap`	`function bool GetHasMinimap()`
`GetHeightPos`	`function Vector GetHeightPos(float Offset)`
`GetIcon`	`function Texture2D GetIcon()`
`GetIconPath`	`function string GetIconPath()`
`GetInitState`	`function bool GetInitState()`
`GetLevel`	`function int GetLevel()`
`GetLocalGuard`	`function array<H7DwellingCreatureData> GetLocalGuard()`
`GetLocalGuardAsBaseCreatureStacks`	`event array<H7BaseCreatureStack> GetLocalGuardAsBaseCreatureStacks()`
`GetMinimapIcon`	`function Texture2D GetMinimapIcon()`
`GetPlayer`	`native function H7Player GetPlayer()`
`GetPlayerNumber`	`function H7StructsAndEnumsNative.EPlayerNumber GetPlayerNumber()`
`GetRecruitAllBlockReason`	`function string GetRecruitAllBlockReason(optional int freeSlots = -1)`
`GetRecruitAllData`	`function array<H7RecruitmentInfo> GetRecruitAllData(optional bool checkGarrison, optional int freeSlots = -1, optional H7AdventureArmy aiArmy)`
`GetSite`	`function H7VisitableSite GetSite()`
`GetStrengthValue`	`function float GetStrengthValue()`
`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)`
`HandleOwnership`	`protected function HandleOwnership(H7AdventureHero visitingHero)`
`HandleSightRadius`	`native function HandleSightRadius(optional bool isInit)`
`HasStandingLocalGuard`	`native function bool HasStandingLocalGuard()`
`HasUncheckedCaravans`	`function bool HasUncheckedCaravans()`
`HasWaitingCaravans`	`function bool HasWaitingCaravans()`
`Hide`	`function Hide()`
`InitAdventureObject`	`event InitAdventureObject()`
`InitSiteOwner`	`function InitSiteOwner(H7StructsAndEnumsNative.EPlayerNumber initialOwner)`
`IsCaravanEmpty`	`function bool IsCaravanEmpty(int caravanIndex)`
`IsCreatureDisabledInLocalGuard`	`function bool IsCreatureDisabledInLocalGuard(H7Creature Creature)`
`IsHiddenX`	`native function bool IsHiddenX()`
`IsInScoutingRangeOfLocalPlayer`	`function bool IsInScoutingRangeOfLocalPlayer()`
`MergeArmies`	`function MergeArmies(H7StructsAndEnums.EArmyNumber fromArmy, H7StructsAndEnums.EArmyNumber toArmy)`
`MergeArmiesComplete`	`function bool MergeArmiesComplete(H7StructsAndEnums.EArmyNumber fromArmy, H7StructsAndEnums.EArmyNumber toArmy)`
`OnTerrainChange`	`native function OnTerrainChange(LandscapeLayerInfoObject newLayer, LandscapeProxy newLandscape)`
`OnVisit`	`function OnVisit(out H7AdventureHero Hero)`
`PostSerialize`	`event PostSerialize()`
`ProduceDayUnits`	`function ProduceDayUnits()`
`ProduceUnits`	`function ProduceUnits()`
`RemoveCaravanArmy`	`function RemoveCaravanArmy()`
`RenderDebugInfo`	`function RenderDebugInfo(Canvas myCanvas)`
`RequestUnloadCaravan`	`function RequestUnloadCaravan(int caravanIndex, optional bool automatic = true)`
`Reveal`	`function Reveal()`
`SetAiThreatLevel`	`function SetAiThreatLevel(float F)`
`SetArrivedCaravanStacks`	`function SetArrivedCaravanStacks(int Index, array<H7BaseCreatureStack> stacks)`
`SetCaravanArmy`	`function SetCaravanArmy(H7CaravanArmy Army)`
`SetFaction`	`function SetFaction(H7Faction fac)`
`SetGarrisonArmy`	`function SetGarrisonArmy(H7AdventureArmy Army)`
`SetGuardingArmy`	`event SetGuardingArmy(H7AdventureArmy Army)`
`SetInitState`	`function SetInitState(bool val)`
`SetSiteOwner`	`function SetSiteOwner(H7StructsAndEnumsNative.EPlayerNumber NewOwner, optional bool showMessage = true)`
`SetUncheckedCaravans`	`function SetUncheckedCaravans(bool val)`
`SpawnFlag`	`function SpawnFlag()`
`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()`
`UpdateLocalGuardByCreature`	`function UpdateLocalGuardByCreature(H7BaseCreatureStack Creature, int diff)`
`UpdateLocalGuardReserve`	`function UpdateLocalGuardReserve(H7DwellingCreatureData Data, int maxReserve)`

Default values¶

mSightRadius=8
mHasMinimapIcon=true
mMinimapIcon=Texture2D'H7TextureGUI.icon_Minimap_Town'

Inherited¶

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