Yukar.Engine.ChoiceWindowDrawer Class Reference

Window management/drawing class with options More...

Classes
struct	ChoiceItemData
	Choice data More...

Public Types
enum	ItemType { Item , Cancel }
	Choice type More...
enum	ItemSortOrientation { Scroll_Z , Scroll_MirrorN , PageTurn_Z , PageTurn_MirrorN }
	How to arrange selection items / Scroll is scroll type, PageTurn is page type, Z is horizontal priority, N is vertical priority More...
enum	HeaderStyle { None }
	Whether to add an explanation column on the window (not used) More...
enum	FooterStyle { None , InfoDescription , PageText }
	Whether to add an explanation column at the bottom of the window More...

Public Member Functions
List< ChoiceItemData >	GetChoicesData ()
	ChoiceWindowDrawer (GameMain owner, WindowDrawer windowDrawer, TextDrawer textDrawer, int row, int column, int margin=0)
void	Release ()
void	AddChoiceData (string text, bool enable=true)
void	AddChoiceData (Common.Resource.Texture iconImageId, Icon.Ref iconRef, string text, bool enable=true)
void	AddChoiceData (Texture imageId, string text, bool enable=true)
void	AddChoiceData (string text, int number, Common.Rom.NItem nitem, bool enable=true)
void	AddChoiceData (Common.Resource.Texture iconImageId, Icon.Ref iconRef, string text, int number, Common.Rom.NItem nitem, bool enable=true)
void	AddChoiceData (string text, int number, string text2, Common.Rom.NItem nitem, bool enable=true)
void	AddChoiceData (Common.Resource.Texture iconImageId, Icon.Ref iconRef, string text, int number, string text2, Common.Rom.NItem nitem, bool enable=true)
void	ClearChoiceListData ()
void	Update ()
void	SelectItem (int itemIndex)
void	SelectDefaultItem (BattleCharacterBase chr, BattleState state)
void	SelectTopItem ()
void	SelectLastItem ()
void	SelectPrevRowItem (int moveRowCount=1)
void	SelectNextRowItem (int moveRowCount=1)
void	SelectPrevColumnItem (int moveColumnCount=1)
void	SelectNextColumnItem (int moveColumnCount=1)
void	Draw (Vector2 windowPosition, Vector2 windowSize, HeaderStyle headerStyle=HeaderStyle.None, FooterStyle footerStyle=FooterStyle.None)
void	saveSelected ()

Public Attributes
bool	IsDisplayPageIcon
bool	decided = false
Icon.Ref	escapeIcon
Texture	escapeImageId
Icon.Ref	returnIcon
Texture	returnImageId

Properties
WindowDrawer	BaseWindowDrawer [get]
int	ChoiceItemCount [get]
int	RowCount [get, set]
int	ColumnCount [get, set]
int	ChoiceItemTopIndex [get]
int	ChoiceItemLastIndex [get]
ItemType	CurrentSelectItemType [get]
int	CurrentSelectItemIndex [get]
bool	CurrentSelectItemEnable [get]
WindowDrawer	ChoiceItemBackgroundDrawer [get, set]
Color	EnableItemTextColor [get, set]
Color	DisableItemTextColor [get, set]
float	ItemTextScale [get, set]
Vector2	ChoiceItemIconPositionOffset [get, set]
Vector2	ChoiceItemTextPositionOffset [get, set]
Vector2	ChoiceItemNumberPositionOffset [get, set]
string	ItemNoneText [get, set]
int	RowSpaceMarginPixel [get, set]
int	ColumnSpaceMarginPixel [get, set]
WindowDrawer	CursorDrawer [get, set]
Color	CursorColor [get, set]
string	CancelButtonText [get, set]
int	CancelButtonHeight [get, set]
Vector2	TextAreaSize [get, set]
int	WindowFrameThickness [get, set]
Common.Resource.Texture	PageIconId [get, set]
int	PageIconMarginPixel [get, set]
Icon.Ref	HeaderTitleIcon [get, set]
string	HeaderTitleText [get, set]
Icon.Ref	FooterTitleIcon [get, set]
string	FooterTitleText [get, set]
string	FooterMainDescriptionText [get, set]
string	FooterSubDescriptionText [get, set]
bool	IsPlayItemSelectSe [get, set]

Detailed Description

Window management/drawing class with options

Member Enumeration Documentation

FooterStyle

enum Yukar.Engine.ChoiceWindowDrawer.FooterStyle

Whether to add an explanation column at the bottom of the window

Enumerator
None
InfoDescription
PageText

HeaderStyle

enum Yukar.Engine.ChoiceWindowDrawer.HeaderStyle

Whether to add an explanation column on the window (not used)

Enumerator
None

ItemSortOrientation

enum Yukar.Engine.ChoiceWindowDrawer.ItemSortOrientation

How to arrange selection items / Scroll is scroll type, PageTurn is page type, Z is horizontal priority, N is vertical priority

Enumerator
Scroll_Z
Scroll_MirrorN
PageTurn_Z
PageTurn_MirrorN

ItemType

enum Yukar.Engine.ChoiceWindowDrawer.ItemType

Choice type

Enumerator
Item
Cancel

Constructor & Destructor Documentation

ChoiceWindowDrawer()

Yukar.Engine.ChoiceWindowDrawer.ChoiceWindowDrawer	(	GameMain	owner,
		WindowDrawer	windowDrawer,
		TextDrawer	textDrawer,
		int	row,
		int	column,
		int	margin = 0
	)

Member Function Documentation

AddChoiceData() [1/7]

void Yukar.Engine.ChoiceWindowDrawer.AddChoiceData	(	Common.Resource.Texture	iconImageId,
		Icon.Ref	iconRef,
		string	text,
		bool	enable = true
	)

AddChoiceData() [2/7]

void Yukar.Engine.ChoiceWindowDrawer.AddChoiceData	(	Common.Resource.Texture	iconImageId,
		Icon.Ref	iconRef,
		string	text,
		int	number,
		Common.Rom.NItem	nitem,
		bool	enable = true
	)

AddChoiceData() [3/7]

void Yukar.Engine.ChoiceWindowDrawer.AddChoiceData	(	Common.Resource.Texture	iconImageId,
		Icon.Ref	iconRef,
		string	text,
		int	number,
		string	text2,
		Common.Rom.NItem	nitem,
		bool	enable = true
	)

AddChoiceData() [4/7]

void Yukar.Engine.ChoiceWindowDrawer.AddChoiceData	(	string	text,
		bool	enable = true
	)

AddChoiceData() [5/7]

void Yukar.Engine.ChoiceWindowDrawer.AddChoiceData	(	string	text,
		int	number,
		Common.Rom.NItem	nitem,
		bool	enable = true
	)

AddChoiceData() [6/7]

void Yukar.Engine.ChoiceWindowDrawer.AddChoiceData	(	string	text,
		int	number,
		string	text2,
		Common.Rom.NItem	nitem,
		bool	enable = true
	)

AddChoiceData() [7/7]

void Yukar.Engine.ChoiceWindowDrawer.AddChoiceData	(	Texture	imageId,
		string	text,
		bool	enable = true
	)

ClearChoiceListData()

void Yukar.Engine.ChoiceWindowDrawer.ClearChoiceListData

(

)

Draw()

void Yukar.Engine.ChoiceWindowDrawer.Draw	(	Vector2	windowPosition,
		Vector2	windowSize,
		HeaderStyle	headerStyle = HeaderStyle.None,
		FooterStyle	footerStyle = FooterStyle.None
	)

GetChoicesData()

List< ChoiceItemData > Yukar.Engine.ChoiceWindowDrawer.GetChoicesData

(

)

Release()

void Yukar.Engine.ChoiceWindowDrawer.Release

(

)

saveSelected()

void Yukar.Engine.ChoiceWindowDrawer.saveSelected

(

)

SelectDefaultItem()

void Yukar.Engine.ChoiceWindowDrawer.SelectDefaultItem	(	BattleCharacterBase	chr,
		BattleState	state
	)

SelectItem()

void Yukar.Engine.ChoiceWindowDrawer.SelectItem

(

int

itemIndex

)

SelectLastItem()

void Yukar.Engine.ChoiceWindowDrawer.SelectLastItem

(

)

SelectNextColumnItem()

void Yukar.Engine.ChoiceWindowDrawer.SelectNextColumnItem

(

int

moveColumnCount = 1

)

SelectNextRowItem()

void Yukar.Engine.ChoiceWindowDrawer.SelectNextRowItem

(

int

moveRowCount = 1

)

SelectPrevColumnItem()

void Yukar.Engine.ChoiceWindowDrawer.SelectPrevColumnItem

(

int

moveColumnCount = 1

)

SelectPrevRowItem()

void Yukar.Engine.ChoiceWindowDrawer.SelectPrevRowItem

(

int

moveRowCount = 1

)

SelectTopItem()

void Yukar.Engine.ChoiceWindowDrawer.SelectTopItem

(

)

Update()

void Yukar.Engine.ChoiceWindowDrawer.Update

(

)

Member Data Documentation

decided

bool Yukar.Engine.ChoiceWindowDrawer.decided = false

escapeIcon

Icon.Ref Yukar.Engine.ChoiceWindowDrawer.escapeIcon

escapeImageId

Texture Yukar.Engine.ChoiceWindowDrawer.escapeImageId

IsDisplayPageIcon

bool Yukar.Engine.ChoiceWindowDrawer.IsDisplayPageIcon

returnIcon

Icon.Ref Yukar.Engine.ChoiceWindowDrawer.returnIcon

returnImageId

Texture Yukar.Engine.ChoiceWindowDrawer.returnImageId

Property Documentation

BaseWindowDrawer

WindowDrawer Yukar.Engine.ChoiceWindowDrawer.BaseWindowDrawer

get

CancelButtonHeight

int Yukar.Engine.ChoiceWindowDrawer.CancelButtonHeight

getset

CancelButtonText

string Yukar.Engine.ChoiceWindowDrawer.CancelButtonText

getset

ChoiceItemBackgroundDrawer

WindowDrawer Yukar.Engine.ChoiceWindowDrawer.ChoiceItemBackgroundDrawer

getset

ChoiceItemCount

int Yukar.Engine.ChoiceWindowDrawer.ChoiceItemCount

get

ChoiceItemIconPositionOffset

Vector2 Yukar.Engine.ChoiceWindowDrawer.ChoiceItemIconPositionOffset

getset

ChoiceItemLastIndex

int Yukar.Engine.ChoiceWindowDrawer.ChoiceItemLastIndex

get

ChoiceItemNumberPositionOffset

Vector2 Yukar.Engine.ChoiceWindowDrawer.ChoiceItemNumberPositionOffset

getset

ChoiceItemTextPositionOffset

Vector2 Yukar.Engine.ChoiceWindowDrawer.ChoiceItemTextPositionOffset

getset

ChoiceItemTopIndex

int Yukar.Engine.ChoiceWindowDrawer.ChoiceItemTopIndex

get

ColumnCount

int Yukar.Engine.ChoiceWindowDrawer.ColumnCount

getset

ColumnSpaceMarginPixel

int Yukar.Engine.ChoiceWindowDrawer.ColumnSpaceMarginPixel

getset

CurrentSelectItemEnable

bool Yukar.Engine.ChoiceWindowDrawer.CurrentSelectItemEnable

get

CurrentSelectItemIndex

int Yukar.Engine.ChoiceWindowDrawer.CurrentSelectItemIndex

get

CurrentSelectItemType

ItemType Yukar.Engine.ChoiceWindowDrawer.CurrentSelectItemType

get

CursorColor

Color Yukar.Engine.ChoiceWindowDrawer.CursorColor

getset

CursorDrawer

WindowDrawer Yukar.Engine.ChoiceWindowDrawer.CursorDrawer

getset

DisableItemTextColor

Color Yukar.Engine.ChoiceWindowDrawer.DisableItemTextColor

getset

EnableItemTextColor

Color Yukar.Engine.ChoiceWindowDrawer.EnableItemTextColor

getset

FooterMainDescriptionText

string Yukar.Engine.ChoiceWindowDrawer.FooterMainDescriptionText

getset

FooterSubDescriptionText

string Yukar.Engine.ChoiceWindowDrawer.FooterSubDescriptionText

getset

FooterTitleIcon

Icon.Ref Yukar.Engine.ChoiceWindowDrawer.FooterTitleIcon

getset

FooterTitleText

string Yukar.Engine.ChoiceWindowDrawer.FooterTitleText

getset

HeaderTitleIcon

Icon.Ref Yukar.Engine.ChoiceWindowDrawer.HeaderTitleIcon

getset

HeaderTitleText

string Yukar.Engine.ChoiceWindowDrawer.HeaderTitleText

getset

IsPlayItemSelectSe

bool Yukar.Engine.ChoiceWindowDrawer.IsPlayItemSelectSe

getset

ItemNoneText

string Yukar.Engine.ChoiceWindowDrawer.ItemNoneText

getset

ItemTextScale

float Yukar.Engine.ChoiceWindowDrawer.ItemTextScale

getset

PageIconId

Common.Resource.Texture Yukar.Engine.ChoiceWindowDrawer.PageIconId

getset

PageIconMarginPixel

int Yukar.Engine.ChoiceWindowDrawer.PageIconMarginPixel

getset

RowCount

int Yukar.Engine.ChoiceWindowDrawer.RowCount

getset

RowSpaceMarginPixel

int Yukar.Engine.ChoiceWindowDrawer.RowSpaceMarginPixel

getset

TextAreaSize

Vector2 Yukar.Engine.ChoiceWindowDrawer.TextAreaSize

getset

WindowFrameThickness

int Yukar.Engine.ChoiceWindowDrawer.WindowFrameThickness

getset