H7PlayerProfile¶

Class in MMH7Game · MMH7Game.H7PlayerProfile · native

Object › H7PlayerProfile

Using it from Lua

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

Constants¶

Name	Value
`PLAYERPROFILE_REVISION`	`5`

Properties¶

Name	Type	Notes
`mAchievementManager`	`H7AchievementManager`	transient
`mCampaignsProgress`	`array<CampaignProgress>`
`mCampaignTransManager`	`H7CampaignTransitionManager`	transient
`mCheckedThisTick`	`bool`	transient
`mCheckTaskSucceeded`	`bool`	transient
`mContinueSaveGames`	`array<H7MapSaveMapping>`	protected
`mCurrentMapFile`	`string`	transient, protected
`mCurrentNormalMapID`	`int`	transient, protected
`mDuelMapSec`	`float`	transient, protected
`mDuelMapTime`	`int`	transient, protected
`mFleeTrackingStatus`	`int`	transient
`mGameplayTimeSec`	`float`	protected
`mHasEnteredAddon`	`bool`	protected
`mHasEnteredCouncil`	`bool`	protected
`mHasEnteredCouncilForTheFirstTime`	`bool`	transient, protected
`mLoadedThisTick`	`bool`	transient
`mLoadTaskSucceeded`	`bool`	transient
`mLookingForCampTransData`	`bool`	transient
`mName`	`string`	protected
`mNormalMapsData`	`array<BaseMapProgress>`	protected
`mNumOfStartedMaps`	`int`	protected
`mPlayedBIKCinematic`	`array<MovieData>`	protected
`mPlayedCampaignID`	`int`	protected
`mReloadProfile`	`bool`	transient
`mRewardsPulled`	`bool`	transient
`mSavedThisTick`	`bool`	transient
`mSavedTransThisTick`	`bool`	transient
`mSaveGameScanner`	`H7ListingSavegame`	transient
`mSaveLoadTasks`	`array<H7SavegameTask_Base>`	transient
`mSaveTaskSucceeded`	`bool`	transient
`mScannedSaves`	`array<H7ListingSavegameDataScene>`	transient
`mScanningCampaigns`	`bool`	transient
`mScanningSaves`	`bool`	transient
`mSelectedDifficulty`	`H7DifficultyParameters`	protected
`mTotalGameplayTimeMin`	`int`	protected
`mUPlayActions`	`array<H7UPlayAction>`
`mUPlayRewards`	`array<H7UPlayReward>`
`mUserCampaignDefinitions`	`array<H7CampaignDefinition>`	transient
`mUserCampaignScanner`	`H7ListingCampaign`	transient
`mUserName`	`string`	protected
`mUserPrivileges`	`array`	transient, protected

Functions¶

Name	Declaration
`AddPlayedCinematic`	`function AddPlayedCinematic(string cinematicName, bool WasSkipped, float PlayTime)`
`AreRewardsPulled`	`function bool AreRewardsPulled()`
`CacheSaves`	`function CacheSaves()`
`CampaignFinishedCouncilMatinee`	`function CampaignFinishedCouncilMatinee(H7CampaignDefinition CampaignRef, bool introMatinee)`
`CampaignMapToBase`	`function BaseMapProgress CampaignMapToBase(CampaignMapProgress CampaignData)`
`CanCountinueLastCampaign`	`function bool CanCountinueLastCampaign()`
`ChangeCurrentCampaign`	`function ChangeCurrentCampaign(H7CampaignDefinition CampaignRef)`
`Cheat_CompleteMapForCampaign`	`function Cheat_CompleteMapForCampaign(H7CampaignDefinition CampaignRef)`
`Cheat_PrintProfileData`	`function Cheat_PrintProfileData()`
`Cheat_WipePlayerProfile`	`function Cheat_WipePlayerProfile(bool areYouSure)`
`CheckCampaignTransitionSlot`	`function CheckCampaignTransitionSlot()`
`CheckCampaignUPlayID`	`function bool CheckCampaignUPlayID(H7CampaignDefinition CampaignRef)`
`CheckProfileSlot`	`function CheckProfileSlot()`
`ClearSavesCache`	`function ClearSavesCache()`
`CompleteCurrentMap`	`function CompleteCurrentMap(H7CampaignDefinition CampaignRef)`
`ContinueLastCampaign`	`function ContinueLastCampaign()`
`FindLastCampaignSave`	`native function H7ListingSavegameDataScene FindLastCampaignSave(array<H7ListingSavegameDataScene> savesList, optional H7CampaignDefinition CampaignRef, optional string MapFilename)`
`GetAchievementManager`	`function H7AchievementManager GetAchievementManager()`
`GetBasicMapData`	`function BaseMapProgress GetBasicMapData(string MapFilename)`
`GetCampaignDataByDef`	`function CampaignProgress GetCampaignDataByDef(H7CampaignDefinition CampaignRef)`
`GetCampaignFinishedMapsNum`	`function int GetCampaignFinishedMapsNum(H7CampaignDefinition CampaignRef)`
`GetCampaignGameplayTimeMin`	`function int GetCampaignGameplayTimeMin(optional H7CampaignDefinition CampaignRef)`
`GetCampaignID`	`native function int GetCampaignID(H7CampaignDefinition CampaignRef)`
`GetCampaignMapData`	`function CampaignMapProgress GetCampaignMapData(string MapFilename)`
`GetCampaignMapGameplayTimeMin`	`function int GetCampaignMapGameplayTimeMin(string MapFilename)`
`GetCampaignMapIndex`	`function int GetCampaignMapIndex(H7CampaignDefinition CampaignRef, string MapFilename)`
`GetCampTransManager`	`function H7CampaignTransitionManager GetCampTransManager()`
`GetContinueSave`	`function H7ListingSavegameDataScene GetContinueSave(optional H7CampaignDefinition theCampaign, optional string MapFilename)`
`GetCurrentCampaign`	`function CampaignProgress GetCurrentCampaign()`
`GetCurrentCampaignID`	`function int GetCurrentCampaignID()`
`GetCurrentMapName`	`function string GetCurrentMapName(int PlayedCampaignID)`
`GetDifficulty`	`function H7StructsAndEnumsNative.EDifficulty GetDifficulty(H7DifficultyParameters difficultyParams)`
`GetDuelMapTimeMin`	`function int GetDuelMapTimeMin()`
`GetFilename`	`static function string GetFilename(string ProfileName)`
`GetInstance`	`static function H7PlayerProfile GetInstance()`
`GetNormalMapGameplayTimeMin`	`function int GetNormalMapGameplayTimeMin(optional string MapFilename)`
`GetNormalMapsList`	`function array<BaseMapProgress> GetNormalMapsList()`
`GetNumCompletedCampaigns`	`function int GetNumCompletedCampaigns(optional bool includeCurrent = true, optional bool onlyVanilla)`
`GetNumCompletedMaps`	`function int GetNumCompletedMaps(optional H7CampaignDefinition CampaignRef)`
`GetNumCustomCampaign`	`function int GetNumCustomCampaign()`
`GetNumOfMapStarts`	`function int GetNumOfMapStarts()`
`GetNumStartedCampaigns`	`function int GetNumStartedCampaigns(optional bool includeCurrent = true)`
`GetPlayedCinematics`	`function array<MovieData> GetPlayedCinematics()`
`GetPlayedCinematicsNum`	`function int GetPlayedCinematicsNum()`
`GetPlayedMapFileNames`	`function GetPlayedMapFileNames(out array mapNames, optional H7CampaignDefinition CampaignRef)`
`GetPreviousMapInCampaign`	`function CampaignMapProgress GetPreviousMapInCampaign(H7CampaignDefinition CampaignRef)`
`GetPrivilegeName`	`native function string GetPrivilegeName(int privilege)`
`GetRawCampaign`	`function H7RawCampaignData GetRawCampaign(H7CampaignDefinition campRef)`
`GetSanitizedMinutes`	`function string GetSanitizedMinutes(int minutes)`
`GetSeenMatinees`	`function array GetSeenMatinees()`
`GetSelectedDifficulty`	`function H7DifficultyParameters GetSelectedDifficulty()`
`GetSelectedDifficultyConverted`	`function H7StructsAndEnumsNative.EDifficulty GetSelectedDifficultyConverted()`
`GetStoryPointsByMap`	`function array GetStoryPointsByMap(string MapFilename)`
`GetTotalGameplayTimeMin`	`function int GetTotalGameplayTimeMin()`
`GetTurnsCampaignCompletion`	`function int GetTurnsCampaignCompletion(int campaignIndex)`
`GetUserPrivileges`	`native function GetUserPrivileges(out array userPrivileges, bool onlyOwned)`
`HandleCampaignMapRestart`	`function HandleCampaignMapRestart(string MapFilename, H7CampaignDefinition CampaignRef)`
`HandleMapFinish`	`function HandleMapFinish(bool isCampaign)`
`HandleMapStart`	`function HandleMapStart(string MapFilename, optional H7CampaignDefinition CampaignRef)`
`HasCampaignProgress`	`function bool HasCampaignProgress()`
`HasCurrentCampaign`	`function bool HasCurrentCampaign()`
`HasEnteredAddon`	`function bool HasEnteredAddon()`
`HasEnteredCouncil`	`function bool HasEnteredCouncil()`
`HasFinishedMap`	`function bool HasFinishedMap(string MapName)`
`HasPrivileg`	`native function bool HasPrivileg(int privileg)`
`HasStartedMap`	`function bool HasStartedMap(string MapName)`
`InitPlayerProfile`	`static function InitPlayerProfile(string ProfileName)`
`IsAddonIvanCampaignFinished`	`function bool IsAddonIvanCampaignFinished()`
`IsAReplay`	`function bool IsAReplay(H7CampaignDefinition campeignRef, string MapFilename)`
`IsCampaignComplete`	`function bool IsCampaignComplete(H7CampaignDefinition CampaignRef)`
`IsCampaignEverStarted`	`function bool IsCampaignEverStarted(H7CampaignDefinition CAMPAIGN)`
`IsCampaignStarted`	`function bool IsCampaignStarted(H7CampaignDefinition CampaignRef)`
`IsFortressCampaignFinished`	`function bool IsFortressCampaignFinished()`
`IsHigherDifficulty`	`function bool IsHigherDifficulty(H7DifficultyParameters diffParamCheck, H7DifficultyParameters diffParamCompare)`
`IsIvanCampaignFinished`	`function bool IsIvanCampaignFinished()`
`IsMapCompletedInCampaign`	`function bool IsMapCompletedInCampaign(H7CampaignDefinition campaignDef, int MapIndexInCampaign)`
`IsPartOfCurrentCampaign`	`function bool IsPartOfCurrentCampaign(string MapFilename)`
`LoadCampaignTransData`	`function LoadCampaignTransData()`
`LoadProfileFile`	`function LoadProfileFile()`
`OverrideMapProgress`	`function OverrideMapProgress(CampaignMapProgress newMapProgress)`
`OwnsFortress`	`native function bool OwnsFortress()`
`OwnsVanilla`	`native function bool OwnsVanilla()`
`ProgressScenePlayed`	`function ProgressScenePlayed()`
`RecreateCustomCampaignDefinitions`	`function RecreateCustomCampaignDefinitions()`
`ResetCampaignProgress`	`function ResetCampaignProgress(H7CampaignDefinition CampaignRef)`
`ResetDuelTimers`	`function ResetDuelTimers()`
`Save`	`function Save()`
`SaveCampaignTransition`	`function SaveCampaignTransition()`
`SelectedDifficultyEqualsLastPlayedDifficulty`	`function bool SelectedDifficultyEqualsLastPlayedDifficulty(H7CampaignDefinition CampaignRef, string MapFilename, out H7StructsAndEnumsNative.EDifficulty lastPlayedDifficulty)`
`SetContinueSave`	`function SetContinueSave(string saveName, string MapFilename, H7CampaignDefinition CampaignRef)`
`SetFleeSurrenderTracking`	`native function SetFleeSurrenderTracking()`
`SetHasEnteredAddon`	`function SetHasEnteredAddon()`
`SetHasEnteredCouncil`	`function SetHasEnteredCouncil()`
`SetSelectedDifficulty`	`function SetSelectedDifficulty(H7DifficultyParameters newDifficultyParams)`
`ShouldDisplayAdvice`	`function bool ShouldDisplayAdvice()`
`StartCampaignMap`	`function StartCampaignMap(H7CampaignDefinition CampaignRef, optional string MapFilename = "", optional bool checkPrivilege = true, optional bool restartCurrentMap = false)`
`TickCampaignTime`	`function TickCampaignTime(float DeltaTime, H7CampaignDefinition campaignDef)`
`TickDuelMapTime`	`function TickDuelMapTime(float DeltaTime)`
`TickGameplayTime`	`function TickGameplayTime(float DeltaTime)`
`TickMapTime`	`function TickMapTime(float DeltaTime)`
`TickSave`	`event TickSave(float DeltaTime)`
`TrackFleeSurrender`	`native function TrackFleeSurrender()`
`TrackingCampaignComplete`	`function TrackingCampaignComplete()`
`TrackingCutScenePlayed`	`function TrackingCutScenePlayed(MovieData Data)`
`UnlockStorypoint`	`function UnlockStorypoint(int storypointIndex)`
`UpdateFromUPlay`	`function UpdateFromUPlay()`
`WasCinematicPlayed`	`function bool WasCinematicPlayed(string cinematicName)`
`WasCouncilIntroPlayed`	`function bool WasCouncilIntroPlayed(H7CampaignDefinition CampaignRef)`
`WasCouncilOutroPlayed`	`function bool WasCouncilOutroPlayed(H7CampaignDefinition CampaignRef)`
`WasMapCompletedBefore`	`function bool WasMapCompletedBefore(int PlayedCampaignID)`
`WasMapPlayed`	`function bool WasMapPlayed(H7CampaignDefinition CampaignRef, string MapFilename)`
`WasNormalMapPlayed`	`function int WasNormalMapPlayed(string MapFilename)`

Default values¶

mFleeTrackingStatus=72
mSelectedDifficulty=(mStartResources=EDifficultyStartResources.DSR_AVERAGE,mCritterStartSize=EDifficultyCritterStartSize.DCSS_AVERAGE,mCritterGrowthRate=EDifficultyCritterGrowthRate.DCGR_AVERAGE,mAiEcoStrength=EDifficultyAIEcoStrength.DAIES_AVERAGE)

Inherited¶

From	Members
Object	13 properties, 308 functions