Logo
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Yukar.Engine.AbstractLayoutState Class Reference

Concrete class in layout condition More...

Inheritance diagram for Yukar.Engine.AbstractLayoutState:
Yukar.Engine.LayoutStateItemTrash

Public Types

enum  SetVariableSituation { SELECT , DECIDE , CANCEL }
 Enumeration type representing variable setting status More...
 

Public Member Functions

 AbstractLayoutState (LayoutManager layoutManager)
 Constructor for AbstractLayoutState class More...
 
void Initialize ()
 Initialization process More...
 
void InitializeConfig ()
 Initialize setting values More...
 
void InitializeConfigAll ()
 Initialize all setting values More...
 
virtual void Terminate ()
 End processing More...
 
void Update ()
 Update process (also called when locked) More...
 
virtual void BeforeSelect ()
 Perform pre-selection processing More...
 
virtual bool Select ()
 Selected behavior (called every frame) More...
 
void AfterSelect ()
 Performs post-selection processing More...
 
virtual bool Decide ()
 Behavior when pressing the OK button More...
 
virtual double GetSelectedVariableValue ()
 Get the value of the selected variable More...
 
virtual void AutoSort (Common.Rom.MenuSettings.MenuItem.SortTypes sortType)
 perform automatic sorting More...
 
void SortItem (Common.Rom.MenuSettings.MenuItem.SortTypes sortType)
 sort items More...
 
void SortSkill (Common.Rom.MenuSettings.MenuItem.SortTypes sortType)
 Sort skills More...
 
void SetVariableValue (SetVariableSituation situation)
 
virtual bool Cancel ()
 Behavior when pressing the cancel button More...
 
bool IsRunningEvent ()
 Determine if event is running More...
 
void UpdateGameContent ()
 Update display information (previous layout is also updated) More...
 
void ConfigureContentProperty ()
 Set number of containers (updates previous layout) More...
 
void ChangeRenderStatus ()
 Update color information such as disabled (updates previous layout) More...
 
virtual void SetBattleDisplay (bool isBattle)
 Set the battle display state More...
 
virtual IEnumerable< MenuSettings.MenuItem.ActionType > GetAvailableLayoutActions ()
 

Static Public Member Functions

static void SetVariableValueImpl (SetVariableSituation situation, LayoutDrawer layoutDrawer, Common.GameData.SystemData system, double value)
 
static IEnumerable< MenuSettings.MenuItem.ActionType > GetConfigActions ()
 
static IEnumerable< MenuSettings.MenuItem.ActionType > GetShortcutActions ()
 
static IEnumerable< MenuSettings.MenuItem.ActionType > GetOtherActions (IEnumerable< MenuSettings.MenuItem.ActionType > actions, bool removeConfigAndShortcut)
 

Public Attributes

LayoutItemListGenerator items = new LayoutItemListGenerator()
 Layout item list generator More...
 

Protected Member Functions

virtual void InitializeCallback ()
 Initialization callback More...
 
virtual void UpdateGameContentCallBack ()
 
virtual void UpdateGameContentEndCallBack ()
 
virtual void ConfigureContentPropertyCallBack ()
 
virtual void ChangeRenderStatusCallBack ()
 
virtual void CreateItems ()
 Process to generate selection items More...
 
bool OpenSelectLayout ()
 
void HideAllLayout ()
 hide all layouts including children More...
 
void BackToPrevious ()
 Return to previous open layout More...
 
void SetSelectPropertyForSaveData ()
 
void SetSelectPropertyForItemDictionary ()
 
void SetSelectPropertyForSkillDictionary ()
 
void SetSelectPropertyForCastDictionary ()
 
void SetSelectPropertyForCasts ()
 TODO: Filter compatible More...
 
void SetSelectPropertyForReserves ()
 
void SetSelectPropertyForItem ()
 
void SetSelectPropertyForSkill ()
 
bool ProcessAfterSkillEffect ()
 Processes when it is necessary to exit the menu as a result of activating a skill effect on the map More...
 
IEnumerable< MenuSettings.MenuItem.ActionType > GetAvailableLayoutActions (bool supportOpenLayout, bool supportExecCommon)
 

Protected Attributes

LayoutManager layoutManager
 
bool skipBattleReplace = false
 

Properties

LayoutDrawer LayoutDrawer [get]
 
AbstractRenderObject.GameContent GameContent [get]
 
AbstractRenderObject.RenderStatus RenderStatus [get]
 
AbstractRenderObject.RenderStatus RenderStatusSub [get]
 
LayoutManager.SelectProperty SelectProperty [get, set]
 
GameMain GameMain [get]
 

Detailed Description

Concrete class in layout condition

Member Enumeration Documentation

◆ SetVariableSituation

enum Yukar.Engine.AbstractLayoutState.SetVariableSituation

Enumeration type representing variable setting status

Enumerator
SELECT 
DECIDE 
CANCEL 

Constructor & Destructor Documentation

◆ AbstractLayoutState()

Yukar.Engine.AbstractLayoutState.AbstractLayoutState ( LayoutManager  layoutManager)

Constructor for AbstractLayoutState class

Parameters
layoutManagerlayout manager

Member Function Documentation

◆ AfterSelect()

void Yukar.Engine.AbstractLayoutState.AfterSelect ( )

Performs post-selection processing

◆ AutoSort()

virtual void Yukar.Engine.AbstractLayoutState.AutoSort ( Common.Rom.MenuSettings.MenuItem.SortTypes  sortType)
virtual

perform automatic sorting

Parameters
sortTypeSort type

◆ BackToPrevious()

void Yukar.Engine.AbstractLayoutState.BackToPrevious ( )
protected

Return to previous open layout

◆ BeforeSelect()

virtual void Yukar.Engine.AbstractLayoutState.BeforeSelect ( )
virtual

Perform pre-selection processing

◆ Cancel()

virtual bool Yukar.Engine.AbstractLayoutState.Cancel ( )
virtual

Behavior when pressing the cancel button

Returns

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ ChangeRenderStatus()

void Yukar.Engine.AbstractLayoutState.ChangeRenderStatus ( )

Update color information such as disabled (updates previous layout)

◆ ChangeRenderStatusCallBack()

virtual void Yukar.Engine.AbstractLayoutState.ChangeRenderStatusCallBack ( )
protectedvirtual

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ ConfigureContentProperty()

void Yukar.Engine.AbstractLayoutState.ConfigureContentProperty ( )

Set number of containers (updates previous layout)

◆ ConfigureContentPropertyCallBack()

virtual void Yukar.Engine.AbstractLayoutState.ConfigureContentPropertyCallBack ( )
protectedvirtual

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ CreateItems()

virtual void Yukar.Engine.AbstractLayoutState.CreateItems ( )
protectedvirtual

Process to generate selection items

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ Decide()

virtual bool Yukar.Engine.AbstractLayoutState.Decide ( )
virtual

Behavior when pressing the OK button

Returns
true Processing of the decision button can be continued. false Processing of the decision button should be finished.

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ GetAvailableLayoutActions() [1/2]

virtual IEnumerable< MenuSettings.MenuItem.ActionType > Yukar.Engine.AbstractLayoutState.GetAvailableLayoutActions ( )
virtual

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ GetAvailableLayoutActions() [2/2]

IEnumerable< MenuSettings.MenuItem.ActionType > Yukar.Engine.AbstractLayoutState.GetAvailableLayoutActions ( bool  supportOpenLayout,
bool  supportExecCommon 
)
protected

◆ GetConfigActions()

static IEnumerable< MenuSettings.MenuItem.ActionType > Yukar.Engine.AbstractLayoutState.GetConfigActions ( )
static

◆ GetOtherActions()

static IEnumerable< MenuSettings.MenuItem.ActionType > Yukar.Engine.AbstractLayoutState.GetOtherActions ( IEnumerable< MenuSettings.MenuItem.ActionType >  actions,
bool  removeConfigAndShortcut 
)
static

◆ GetSelectedVariableValue()

virtual double Yukar.Engine.AbstractLayoutState.GetSelectedVariableValue ( )
virtual

Get the value of the selected variable

Returns
Value of selected variable

◆ GetShortcutActions()

static IEnumerable< MenuSettings.MenuItem.ActionType > Yukar.Engine.AbstractLayoutState.GetShortcutActions ( )
static

◆ HideAllLayout()

void Yukar.Engine.AbstractLayoutState.HideAllLayout ( )
protected

hide all layouts including children

◆ Initialize()

void Yukar.Engine.AbstractLayoutState.Initialize ( )

Initialization process

◆ InitializeCallback()

virtual void Yukar.Engine.AbstractLayoutState.InitializeCallback ( )
protectedvirtual

Initialization callback

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ InitializeConfig()

void Yukar.Engine.AbstractLayoutState.InitializeConfig ( )

Initialize setting values

◆ InitializeConfigAll()

void Yukar.Engine.AbstractLayoutState.InitializeConfigAll ( )

Initialize all setting values

◆ IsRunningEvent()

bool Yukar.Engine.AbstractLayoutState.IsRunningEvent ( )

Determine if event is running

Returns
true if the event is running, false otherwise

◆ OpenSelectLayout()

bool Yukar.Engine.AbstractLayoutState.OpenSelectLayout ( )
protected

◆ ProcessAfterSkillEffect()

bool Yukar.Engine.AbstractLayoutState.ProcessAfterSkillEffect ( )
protected

Processes when it is necessary to exit the menu as a result of activating a skill effect on the map

Returns

◆ Select()

virtual bool Yukar.Engine.AbstractLayoutState.Select ( )
virtual

Selected behavior (called every frame)

Returns

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ SetBattleDisplay()

virtual void Yukar.Engine.AbstractLayoutState.SetBattleDisplay ( bool  isBattle)
virtual

Set the battle display state

Parameters
isBattleIs it in battle?

◆ SetSelectPropertyForCastDictionary()

void Yukar.Engine.AbstractLayoutState.SetSelectPropertyForCastDictionary ( )
protected

◆ SetSelectPropertyForCasts()

void Yukar.Engine.AbstractLayoutState.SetSelectPropertyForCasts ( )
protected

TODO: Filter compatible

◆ SetSelectPropertyForItem()

void Yukar.Engine.AbstractLayoutState.SetSelectPropertyForItem ( )
protected

◆ SetSelectPropertyForItemDictionary()

void Yukar.Engine.AbstractLayoutState.SetSelectPropertyForItemDictionary ( )
protected

◆ SetSelectPropertyForReserves()

void Yukar.Engine.AbstractLayoutState.SetSelectPropertyForReserves ( )
protected

◆ SetSelectPropertyForSaveData()

void Yukar.Engine.AbstractLayoutState.SetSelectPropertyForSaveData ( )
protected

◆ SetSelectPropertyForSkill()

void Yukar.Engine.AbstractLayoutState.SetSelectPropertyForSkill ( )
protected

◆ SetSelectPropertyForSkillDictionary()

void Yukar.Engine.AbstractLayoutState.SetSelectPropertyForSkillDictionary ( )
protected

◆ SetVariableValue()

void Yukar.Engine.AbstractLayoutState.SetVariableValue ( SetVariableSituation  situation)

◆ SetVariableValueImpl()

static void Yukar.Engine.AbstractLayoutState.SetVariableValueImpl ( SetVariableSituation  situation,
LayoutDrawer  layoutDrawer,
Common.GameData.SystemData  system,
double  value 
)
static

◆ SortItem()

void Yukar.Engine.AbstractLayoutState.SortItem ( Common.Rom.MenuSettings.MenuItem.SortTypes  sortType)

sort items

Parameters
sortTypeSort type

◆ SortSkill()

void Yukar.Engine.AbstractLayoutState.SortSkill ( Common.Rom.MenuSettings.MenuItem.SortTypes  sortType)

Sort skills

Parameters
sortTypeSort type

◆ Terminate()

virtual void Yukar.Engine.AbstractLayoutState.Terminate ( )
virtual

End processing

◆ Update()

void Yukar.Engine.AbstractLayoutState.Update ( )

Update process (also called when locked)

◆ UpdateGameContent()

void Yukar.Engine.AbstractLayoutState.UpdateGameContent ( )

Update display information (previous layout is also updated)

◆ UpdateGameContentCallBack()

virtual void Yukar.Engine.AbstractLayoutState.UpdateGameContentCallBack ( )
protectedvirtual

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

◆ UpdateGameContentEndCallBack()

virtual void Yukar.Engine.AbstractLayoutState.UpdateGameContentEndCallBack ( )
protectedvirtual

Reimplemented in Yukar.Engine.LayoutStateItemTrash.

Member Data Documentation

◆ items

LayoutItemListGenerator Yukar.Engine.AbstractLayoutState.items = new LayoutItemListGenerator()

Layout item list generator

◆ layoutManager

LayoutManager Yukar.Engine.AbstractLayoutState.layoutManager
protected

◆ skipBattleReplace

bool Yukar.Engine.AbstractLayoutState.skipBattleReplace = false
protected

Property Documentation

◆ GameContent

AbstractRenderObject.GameContent Yukar.Engine.AbstractLayoutState.GameContent
getprotected

◆ GameMain

GameMain Yukar.Engine.AbstractLayoutState.GameMain
getprotected

◆ LayoutDrawer

LayoutDrawer Yukar.Engine.AbstractLayoutState.LayoutDrawer
getprotected

◆ RenderStatus

AbstractRenderObject.RenderStatus Yukar.Engine.AbstractLayoutState.RenderStatus
getprotected

◆ RenderStatusSub

AbstractRenderObject.RenderStatus Yukar.Engine.AbstractLayoutState.RenderStatusSub
getprotected

◆ SelectProperty

LayoutManager.SelectProperty Yukar.Engine.AbstractLayoutState.SelectProperty
getsetprotected
Generated by doxygen 1.9.4