Table of Contents

Class GameMenu

Namespace
TaleWorlds.CampaignSystem.GameMenus
Assembly
TaleWorlds.CampaignSystem.dll
public class GameMenu
Inheritance
GameMenu
Inherited Members

Fields

LastSelectedMenuObject

public object LastSelectedMenuObject

Field Value

object

MenuRepeatObjects

public List<object> MenuRepeatObjects

Field Value

List<object>

OnInit

public OnInitDelegate OnInit

Field Value

OnInitDelegate

Properties

AutoSelectFirst

public bool AutoSelectFirst { get; }

Property Value

bool

CurrentRepeatableIndex

public int CurrentRepeatableIndex { get; set; }

Property Value

int

CurrentRepeatableObject

public object CurrentRepeatableObject { get; }

Property Value

object

IsEmpty

public bool IsEmpty { get; }

Property Value

bool

IsReady

public bool IsReady { get; }

Property Value

bool

IsWaitActive

public bool IsWaitActive { get; }

Property Value

bool

IsWaitMenu

public bool IsWaitMenu { get; }

Property Value

bool

MenuItemAmount

public int MenuItemAmount { get; }

Property Value

int

MenuOptions

public IEnumerable<GameMenuOption> MenuOptions { get; }

Property Value

IEnumerable<GameMenuOption>

MenuTitle

public TextObject MenuTitle { get; }

Property Value

TextObject

OnCondition

public OnConditionDelegate OnCondition { get; }

Property Value

OnConditionDelegate

OnConsequence

public OnConsequenceDelegate OnConsequence { get; }

Property Value

OnConsequenceDelegate

OnTick

public OnTickDelegate OnTick { get; }

Property Value

OnTickDelegate

OverlayType

public GameOverlays.MenuOverlayType OverlayType { get; }

Property Value

GameOverlays.MenuOverlayType

Progress

public float Progress { get; }

Property Value

float

RelatedObject

public object RelatedObject { get; }

Property Value

object

StringId

public string StringId { get; }

Property Value

string

TargetWaitHours

public float TargetWaitHours { get; }

Property Value

float

Type

public GameMenu.MenuAndOptionType Type { get; }

Property Value

GameMenu.MenuAndOptionType

Methods

ActivateGameMenu(string)

public static void ActivateGameMenu(string menuId)

Parameters

menuId string

AfterInit(MenuContext)

public void AfterInit(MenuContext menuContext)

Parameters

menuContext MenuContext

EndWait()

public void EndWait()

ExitToLast()

public static void ExitToLast()

GetGameMenuOption(int)

public GameMenuOption GetGameMenuOption(int menuItemNumber)

Parameters

menuItemNumber int

Returns

GameMenuOption

GetLeaveMenuOption(Game, MenuContext)

public GameMenuOption GetLeaveMenuOption(Game game, MenuContext menuContext)

Parameters

game Game
menuContext MenuContext

Returns

GameMenuOption

GetMenuOptionConditionsHold(Game, MenuContext, int)

public bool GetMenuOptionConditionsHold(Game game, MenuContext menuContext, int menuItemNumber)

Parameters

game Game
menuContext MenuContext
menuItemNumber int

Returns

bool

GetMenuOptionIdString(int)

public string GetMenuOptionIdString(int menuItemNumber)

Parameters

menuItemNumber int

Returns

string

GetMenuOptionIsLeave(int)

public bool GetMenuOptionIsLeave(int menuItemNumber)

Parameters

menuItemNumber int

Returns

bool

GetMenuOptionText(int)

public TextObject GetMenuOptionText(int menuItemNumber)

Parameters

menuItemNumber int

Returns

TextObject

GetMenuOptionText2(int)

public TextObject GetMenuOptionText2(int menuItemNumber)

Parameters

menuItemNumber int

Returns

TextObject

GetMenuOptionTooltip(int)

public TextObject GetMenuOptionTooltip(int menuItemNumber)

Parameters

menuItemNumber int

Returns

TextObject

GetText()

public TextObject GetText()

Returns

TextObject

PreInit(MenuContext)

public void PreInit(MenuContext menuContext)

Parameters

menuContext MenuContext

RunMenuOptionConsequence(MenuContext, int)

public void RunMenuOptionConsequence(MenuContext menuContext, int menuItemNumber)

Parameters

menuContext MenuContext
menuItemNumber int

RunOnInit(Game, MenuContext)

public void RunOnInit(Game game, MenuContext menuContext)

Parameters

game Game
menuContext MenuContext

RunOnTick(MenuContext, float)

public void RunOnTick(MenuContext menuContext, float dt)

Parameters

menuContext MenuContext
dt float

RunWaitMenuCondition(MenuContext)

public bool RunWaitMenuCondition(MenuContext menuContext)

Parameters

menuContext MenuContext

Returns

bool

RunWaitMenuConsequence(MenuContext)

public void RunWaitMenuConsequence(MenuContext menuContext)

Parameters

menuContext MenuContext

SetProgressOfWaitingInMenu(float)

public void SetProgressOfWaitingInMenu(float progress)

Parameters

progress float

SetTargetedWaitingTimeAndInitialProgress(float, float)

public void SetTargetedWaitingTimeAndInitialProgress(float targetedWaitingTime, float initialProgress)

Parameters

targetedWaitingTime float
initialProgress float

StartWait()

public void StartWait()

SwitchToMenu(string)

public static void SwitchToMenu(string menuId)

Parameters

menuId string

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).