H7CampaignDefinition¶

Class in MMH7Game · MMH7Game.H7CampaignDefinition · native, perobjectconfig

Object › H7CampaignDefinition

Using it from Lua

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

Structs¶

H7MapEntry

Field	Type
`mFallbackName`	`string`
`mFileName`	`string`
`mMapInfoNumber`	`int`
`mNameInst`	`string`
`mPixel`	`int`
`mUnlockCutscenes`	`array`
`mYear`	`int`

Properties¶

Name	Type	Notes
`mAuthor`	`string`
`mBonusDescription`	`string`	const, localized
`mBonusDescriptionInst`	`string`	transient
`mCampaignMaps`	`array<H7MapEntry>`
`mContainerObjectName`	`string`	no declaration: type is approximate
`mContinueCampaignText`	`string`	const, localized
`mCouncillor`	`H7EditorHero`
`mDescription`	`string`	const, localized
`mDescriptionFallback`	`string`	no declaration: type is approximate
`mDescriptionInst`	`string`	transient
`mEndMatineeName`	`string`
`mEndYear`	`int`
`mFaction`	`H7Faction`
`mFileName`	`string`	no declaration: type is approximate
`mIsCouncilCampaign`	`bool`
`mIsIvan`	`bool`
`mIvanCampaignSelectText`	`array`	const, localized
`mLoadScreenBackground`	`DynLoadObject`	no declaration: type is approximate
`mName`	`string`	const, localized
`mNameFallback`	`string`	no declaration: type is approximate
`mNameInst`	`string`	transient
`mQuickInfo`	`string`	const, localized
`mRestartCampaignText`	`string`
`mRevision`	`int`
`mStartCampaignText`	`string`	const, localized
`mStartMatineeName`	`string`
`mStartYear`	`int`

Functions¶

Name	Declaration
`GetAID`	`function string GetAID()`
`GetAuthor`	`function string GetAuthor()`
`GetBonusDescription`	`function string GetBonusDescription()`
`GetCouncillor`	`function H7EditorHero GetCouncillor()`
`GetCurrentCharacterText`	`function string GetCurrentCharacterText()`
`GetDescription`	`function string GetDescription()`
`GetFaction`	`function H7Faction GetFaction()`
`GetFilename`	`function string GetFilename()`
`GetFirstMap`	`function string GetFirstMap()`
`GetLastMap`	`function string GetLastMap()`
`GetLoadscreenBackground`	`function MaterialInterface GetLoadscreenBackground()`
`GetMapByIndex`	`function string GetMapByIndex(int Index)`
`GetMapByNumber`	`function string GetMapByNumber(int Number)`
`GetMapEntry`	`function H7MapEntry GetMapEntry(string MapFilename)`
`GetMapEntryByIndex`	`function H7MapEntry GetMapEntryByIndex(int I)`
`GetMapIndex`	`function int GetMapIndex(string MapFilename)`
`GetMapInfoNumberOfMap`	`function int GetMapInfoNumberOfMap(string MapName)`
`GetMapLocaName`	`function string GetMapLocaName(string MapFilename)`
`GetMaps`	`function array GetMaps()`
`GetMapsNum`	`function int GetMapsNum()`
`GetMaxMaps`	`function int GetMaxMaps()`
`GetName`	`function string GetName()`
`GetNextMap`	`function string GetNextMap(string MapFilename)`
`GetPixelOfMap`	`function int GetPixelOfMap(string MapName)`
`GetPrevMap`	`function string GetPrevMap(string MapFilename)`
`GetQuickInfo`	`function string GetQuickInfo()`
`GetYearOfMap`	`function int GetYearOfMap(string MapName)`
`InitFromCampaignData`	`function InitFromCampaignData(H7CampaignData Data)`
`InitFromCampaignDataParams`	`function InitFromCampaignDataParams(int revision, string campaignName, string Filename, string Author, string Description, array inCampaignMaps, array inCampaignMapNames, array inCampaignMapInfoNumbers, string containerObjectName)`
`InitFromRawData`	`function InitFromRawData(H7RawCampaignData RawData)`
`IsAddon`	`function bool IsAddon()`
`IsAddonIvan`	`function bool IsAddonIvan()`
`IsCouncilCampaign`	`function bool IsCouncilCampaign()`
`IsFortress`	`function bool IsFortress()`
`IsIvanCampaign`	`function bool IsIvanCampaign()`
`IsLastMap`	`function bool IsLastMap(string MapFilename)`
`IsLocked`	`function bool IsLocked(optional out int contentLock, optional out string lockReason)`
`IsSameCampaign`	`native function bool IsSameCampaign(H7CampaignDefinition otherCampaign)`
`Load`	`native function Load(string Filename)`
`LogUserCampaign`	`function LogUserCampaign()`
`RequiresFactionPrivilege`	`function bool RequiresFactionPrivilege()`
`Save`	`native function Save(string Filename)`
`SetFileName`	`function SetFileName(string Filename)`
`SetMapPixel`	`function SetMapPixel(string MapName, int pixel)`
`VisibleInCouncil`	`function bool VisibleInCouncil(H7StructsAndEnums.ECouncilCampaignType currentCampaignType)`

Default values¶

mAuthor="Unknown"

Inherited¶

From	Members
Object	13 properties, 308 functions