Yukar.Engine.LayoutDrawer Class Reference

layout drawing class More...

Public Member Functions
	LayoutDrawer (GameMain gameMain, Common.Catalog catalog, MenuSettings menuSettings, bool isPreview=false, bool isThumbnail=false)
	Initialize the LayoutDrawer using menu settings. More...
	LayoutDrawer (GameMain gameMain, Common.Catalog catalog, LayoutProperties.LayoutNode layoutNode, bool isPreview=false, bool isThumbnail=false)
	Initialize the LayoutDrawer using a layout node. More...
bool	ContainsRenderContent ()
	whether it contains something to draw More...
List< AbstractRenderObject >	GetRenderObjects ()
	Get a list of drawing objects More...
MenuSettings.MenuItem	GetMenuItem (AbstractRenderObject obj)
	Get the setting value of the specified drawing object More...
AbstractRenderObject	GetRednerObject (MenuSettings.MenuItem mitem)
	Get the drawing object with the specified settings More...
void	SetGridProperty (bool drawGrid, int previewScreenWidth, int previewScreenHeight)
	Set grid settings More...
void	ChangeAnimationState (SpriteRenderObject.AnimationState animationState)
	Force an animation state change More...
void	Initialize (GameMain gameMain, Common.Catalog catalog, MenuSettings menuSettings, bool isPreview, bool isThumbnail)
	initialize More...
void	Insert (GameMain gameMain, Common.Catalog catalog, MenuSettings.MenuItem addedMenuItem, MenuSettings.MenuItem parentMenuItem, int insertIndex, bool isPreview)
	insert More...
void	Remove (MenuSettings.MenuItem removedMenuItem)
	delete More...
void	Move (MenuSettings.MenuItem movedMenuItem, MenuSettings.MenuItem movedParentMenuItem, int insertIndex)
	Moving More...
void	ResetVisible (MenuSettings.MenuItem menuItem)
	Reset display state More...
void	Release ()
	Open More...
void	Update ()
	Update More...
void	UpdateTouchCollider (Vector2 addtionalContainerSize)
	Update hitbox More...
void	Draw ()
	draw More...
void	ClearSkipDrawIndices ()
	Clear information to skip drawing More...
void	Show ()
	indicate More...
void	ShowContainer ()
	make the container visible More...
void	Hide (bool immediate=false)
	You want to hide More...
void	HideContainer ()
	hide container More...
bool	IsLocked ()
	is it locked More...
void	Lock ()
	lock More...
void	UnLock ()
	to unlock More...
Vector2	GetAutoSizeMargin (int index)
	Get Auto Adjust Margins More...
bool	IsTouchingAnything (SharpKmyMath.Vector2 position)
	are you touching something More...
bool	IsTouchingAnything (SharpKmyMath.Vector2 position, int index)
	are you touching something More...
bool	HaveDecidedByTouch ()
	whether it is determined by touch More...
Tuple< bool, int >	ForceUpdateSubContainerTouch ()
	Force touch detection More...
void	CreateBattleContent ()
	Generate elements for battle More...
MenuSettings.MenuItem.ActionType	GetSelectAction ()
	Get selected action More...
MenuSettings.MenuItem	GetSelectMenuItem ()
	Get selected menu item More...
MenuSettings.MenuItem.ActionType	GetSelectAction (int index)
	Get selected action More...
MenuSettings.MenuItem.ActionType	GetAction (int index)
	get action More...
Tuple< MenuSettings.MenuItem.ActionType, AbstractRenderObject >	GetInputtingActionAndObject ()
	Gets the currently entered action and the object that performs that action. More...
bool	IsAnytingVisible ()
	is there anything displayed More...
bool	IsAnytingVisible (int index)
	is there anything displayed Parameters index the index number of the drawing object to check More...
bool	IsAnytingInOutAnimating ()
	whether something is animated More...
bool	IsAnytingInOutAnimating (int index)
	whether something is animated Parameters index the index number of the drawing object to check More...
bool	HasHideContainerOption ()
	Whether the selected container has a setting to hide the container when determined More...
bool	IsHideMyself ()
	Whether to hide the container when the menu container is determined More...
bool	ContainSpecialTextType (SpecialTextRenderer.SpecialTexts specialText, int index)
	Whether the specified content contains special formatting More...
bool	ContainLayoutType (MenuSettings.MenuItem.LayoutType layoutType, int index)
	Does it contain the specified layout type? More...
void	ConfigureContentProperty (int maximumContent)
	Set maximum number of elements in menu container More...
void	ConfigureContentProperty (int maximumContent, int index)
	Set maximum number of elements in menu container More...
void	ConfigureContentProperty (int maximumContent, int index, bool updateRenderPanelIndex)
	Set maximum number of elements in menu container More...
void	ConfigureContentProperty (int maximumContent, bool updateRenderPanel, SpecialTextRenderer.SpecialTexts specialText)
	Sets the maximum number of menu container elements that contain the specified special formatting More...
void	ConfigureMenuContainerContentProperty (int maximumContent, int menuContainerIndex)
	Set maximum number of elements in menu container More...
void	UpdateGameContent (AbstractRenderObject.GameContent gameContent, bool skipBattleReplace=false)
	Update game content More...
void	ResetSubMenuContainerRenderStatus ()
	Reset the drawing state of the subcontainer More...
void	ChangeSubMenuContainerRenderStatus (AbstractRenderObject.RenderStatus renderStatus, bool overrride, int menuContainerIndex)
	Change the drawing state of a subcontainer More...
void	ChangeSubMenuContainerRenderStatus (AbstractRenderObject.RenderStatus renderStatus, bool overrride)
	Change the drawing state of a subcontainer More...
void	ChangeResultVisible (AbstractRenderObject.GameContent gameContent)
	Switch between displaying and hiding battle results More...
void	SkipContentRendering (bool skip)
	Avoid drawing non-strings (container children are still drawn) More...
int	GetSelectIndex ()
	Get the index number of the selected menu container More...
int	GetSelectIndex (int menuContainerIndex)
	Get the index number of the selected menu container More...
bool	IsUpdateSubContainerRenderStatus ()
	Update the drawing status of a subcontainer More...
void	SetSelectIndex (int index)
	Change the selected index number More...
int	GetMenuPage ()
	Get page of menu container More...
void	SetSelectIndex (int index, int menuContainerIndex)
	Change the selected index number More...
bool	IsSelectedFirstPage (int menuContainerIndex)
	Are you selecting the first page? More...
bool	IsSelectedLastPage (int menuContainerIndex)
	Are you selecting the last page? More...
bool	PressNextPage (int menuContainerIndex)
	Did you enter a move to the next page? More...
bool	PressPreviousPage (int menuContainerIndex)
	Did you enter a move to the previous page? More...
bool	MovedPage (int menuContainerIndex)
	Did you move the page (need to call update first) More...
int	GetMaximumSelectIndex (int menuContainerIndex)
	Get the maximum value of the selection index of the menu container More...
void	EnableSubContainer (bool enable, int subContainerIndex)
	Toggle enablement of submenu container (if disabled, it will not be selected when moving the cursor) More...
void	EnableSubContainer (bool enable, int subContainerIndex, int menuContainerIndex)
	Toggle enablement of submenu container (if disabled, it will not be selected when moving the cursor) More...
void	EnableSubContainerPageIndex (bool enable, int subContainerPageIndex, int menuContainerIndex)
	Change whether the subcontainer of the specified page number can be selected More...
void	EnableLoopPage (bool enable)
	Whether to loop the page movement of keystrokes in the menu container More...
void	SetSelectingLayout (Guid guid)
	Make the object with the specified guid selected More...
void	EnableSelectAll (bool enableSelectAll)
	select all More...
void	EnableSelectMulti (bool enableSelectMulti, int selectedCount)
	Select multiple items from the beginning More...
void	ForceBlinkSubContainer (bool forceUseBlinker, int subContianerIndex, int menuContainerIndex)
	Force submenu container blinker More...
Guid	GetSelectOpenLayoutGuid ()
	Get the guid of the selected open layout More...
Guid	GetLayoutStateGuid ()
	Get the guid of the selected open layout state (to open multiple menus) More...
void	SetLayoutStateGuid (Guid guid)
int	GetMenuContainerIndex (int renderObjectIndex)
	Convert from index in RenderObjects to index in MenuContainer More...
void	ChangeFocusMenuContainer (bool forceSelected, int menuContainerIndex)
	Change the focused menu container More...
bool	IsFocusedMenuContainer (int menuContainerIndex)
	is it focused More...
void	EnableAutoInputUpdate (bool autoInputUpdate, int menuContainerIndex)
	Change whether to automatically update input More...
void	GoNextSubContainer (int menuContainerIndex)
	Select next subcontainer More...
void	GoNextSubPanel (AbstractRenderObject.NextInputTypes nextInputType, int menuContainerIndex)
	Select next subcontainer More...
void	GoPreviousSubPanel (int menuContainerIndex)
	Select previous subcontainer More...
int	GetFocusedMenuContainerIndex (bool findFromAllContainers=false)
	Get the index number of the menu container that has focus More...
void	SetCursorVisible (bool state)
	Change cursor visibility More...
Vector2	GetTextScaledSize (int index)
	get text size More...
float	GetTextScale (int index)
	get text scale More...
TextDrawer	GetTextDrawer (int index)
	get text drawing object More...
AbstractRenderObject	GetTextDrawerObject (int index, AbstractRenderObject.Events usage, List< AbstractRenderObject > items=null)
	get text drawing object More...
void	EnableScrollText (bool enable, int index)
	Enable text scrolling More...
bool	IsTextOutOfScrren (int index)
	whether the text is off screen More...
void	UpdateSpecialRenderObject ()
	Update special formatting More...
void	ShowRenderNamePlate (int containerIndex, int index)
	Show nameplate More...
void	HideRenderNamePlate (int containerIndex, int index)
	Hide nameplate More...
void	ForceHideNamePlate (int index)
	Force hide all nameplates More...
void	SetSliderValueAllowModification (int index, bool v)
	Forcibly enable the selected slider value set (for variable operations) More...
void	ResetSliderValueFromMenuItem (int index)
	Reset slider value from menu item setting value More...
float	GetSelectSliderValue ()
	Get the value of the selected slider More...
float	GetSliderValueWithIndex (int index)
	Get slider value More...
float	GetSliderValueWithIndex (int index, int objectIndex)
	Get slider value More...
float	GetSliderMamixmumValueWithIndex (int index)
	Get maximum value of slider More...
float	GetSliderMamixmumValueWithIndex (int index, int objectIndex)
	Get maximum value of slider More...
void	SetSliderValueWithIndex (float value, int index)
	Change slider value More...
void	SetSliderValueWithIndex (float value, int index, int objectIndex)
	Change slider value More...
int	GetSpinValueWithIndex (int index)
	Get spin value More...
int	GetSpinValueWithIndex (int index, int objectIndex)
	Get spin value More...
void	SetSpinValueWithIndex (int value, int index)
	Change spin value More...
void	SetSpinValueWithIndex (int value, int index, int objectIndex)
	Change spin value More...
void	ChangeMenuSubContainerAmount (int amount, Vector2 menuSubContainerSize)
	Change the number of submenu containers More...
void	ChangeMenuSubContainerAmount (int amount, Vector2 menuSubContainerSize, int index)
	Change the number of submenu containers More...
void	SkipDrawingWithTagPosition (AbstractRenderObject.TagPositions tagPosition, AbstractRenderObject.Events layoutEvent)
	Skip drawing outside the specified tag position More...
int	GetIndexWithTagPosition (AbstractRenderObject.TagPositions tagPosition, AbstractRenderObject.Events layoutEvent)
	Get the index of the specified tag position More...
void	SkipDrawingWithTagTelop (bool useBacground, bool useImage, bool isScrolling)
	Change caption display More...
int	GetIndexWithTagTelop (AbstractRenderObject.TagTelop tagTelop)
	Get the index that contains the telop tag More...
void	EnableMessageSprite (bool enable)
	Show/hide message sprites More...
Vector2	GetSnapPosition (Vector2 position)
	Get position for snap More...
AbstractRenderObject	GetRenderObjectWithPositionAnchorTag (string positionAnchorTag, int index=-1)
	Get an object with a special coordinate tag (return the first one found) More...
AbstractRenderObject	GetRenderObjectWithPositionAnchorTag (AbstractRenderObject.PositionAnchorTags positionAnchorTag, int index)
	Get an object with a special coordinate tag (return the first one found) More...
AbstractRenderObject	GetRenderObjectWithPositionAnchorTag (string positionAnchorTag, int menuIndex, int index)
	Get an object with a special coordinate tag (return the first one found) More...
AbstractRenderObject	GetRenderObjectWithPositionAnchorTag (AbstractRenderObject.PositionAnchorTags positionAnchorTag, int menuIndex, int index)
	Get an object with a special coordinate tag (return the first one found) More...
List< AbstractRenderObject >	GetRenderObjectsWithPositionAnchorTag (string positionAnchorTag, int index)
	Get all objects with a special coordinate tag More...
List< AbstractRenderObject >	GetRenderObjectsWithPositionAnchorTag (AbstractRenderObject.PositionAnchorTags positionAnchorTag, int index)
	Get all objects with a special coordinate tag More...
List< AbstractRenderObject >	ParseNodes ()
	return all nodes More...
SpecialTextRenderer.SpecialTexts	GetMostMajorContent (int index)
	Return the most content for all nodes More...

Static Public Member Functions
static void	ClearLastSelectedIndicies ()
	Clear the last selected index More...

Public Attributes
string	variableName
string	selectingVariableName
bool	setVariableOneOrigin
bool	setContainerNumber
Func< float >	fov = () => 0.2f
Func< int >	maxLineNum = () => 3
int	lineOffset = 0
bool	rootVisibility = false
List< AbstractRenderObject >	renderObjects
List< MenuContainer >	menuContainers
MenuContainer	selectMenuContainer

Static Public Attributes
static Guid	extraGuid = Guid.Empty

Properties
int	RenderObjectsCount [get]
	Get the number of currently rendered objects More...
int	MenuContainersCount [get]
	Get the number of currently available menu containers More...
bool	ShouldDrawCollider [get, set]
Guid	Guid [get]

Detailed Description

layout drawing class

Constructor & Destructor Documentation

LayoutDrawer() [1/2]

Yukar.Engine.LayoutDrawer.LayoutDrawer	(	GameMain	gameMain,
		Common.Catalog	catalog,
		MenuSettings	menuSettings,
		bool	isPreview = false,
		bool	isThumbnail = false
	)

Initialize the LayoutDrawer using menu settings.

Parameters

gameMain	Game main object
catalog	Catalog Objects
menuSettings	Menu settings
isPreview	Preview mode or not
isThumbnail	Is it in thumbnail mode?

LayoutDrawer() [2/2]

Yukar.Engine.LayoutDrawer.LayoutDrawer	(	GameMain	gameMain,
		Common.Catalog	catalog,
		LayoutProperties.LayoutNode	layoutNode,
		bool	isPreview = false,
		bool	isThumbnail = false
	)

Initialize the LayoutDrawer using a layout node.

Parameters

gameMain	Game main object
catalog	Catalog Objects
layoutNode	Layout node settings
isPreview	Preview mode or not
isThumbnail	Is it in thumbnail mode?

Member Function Documentation

ChangeAnimationState()

void Yukar.Engine.LayoutDrawer.ChangeAnimationState

(

SpriteRenderObject.AnimationState

animationState

)

Force an animation state change

Parameters

animationState

the state of the animation to change to

ChangeFocusMenuContainer()

void Yukar.Engine.LayoutDrawer.ChangeFocusMenuContainer	(	bool	forceSelected,
		int	menuContainerIndex
	)

Change the focused menu container

Parameters

forceSelected	true to force selection false to select when focused
menuContainerIndex	Index number of the menu container to change

ChangeMenuSubContainerAmount() [1/2]

void Yukar.Engine.LayoutDrawer.ChangeMenuSubContainerAmount	(	int	amount,
		Vector2	menuSubContainerSize
	)

Change the number of submenu containers

Parameters

amount	Number of submenu containers
menuSubContainerSize	Submenu container size

ChangeMenuSubContainerAmount() [2/2]

void Yukar.Engine.LayoutDrawer.ChangeMenuSubContainerAmount	(	int	amount,
		Vector2	menuSubContainerSize,
		int	index
	)

Change the number of submenu containers

Parameters

amount	Number of submenu containers
menuSubContainerSize	Submenu container size
index	the index number of the drawing object to change

ChangeResultVisible()

void Yukar.Engine.LayoutDrawer.ChangeResultVisible

(

AbstractRenderObject.GameContent

gameContent

)

Switch between displaying and hiding battle results

Parameters

gameContent

Game content

ChangeSubMenuContainerRenderStatus() [1/2]

void Yukar.Engine.LayoutDrawer.ChangeSubMenuContainerRenderStatus	(	AbstractRenderObject.RenderStatus	renderStatus,
		bool	overrride
	)

Change the drawing state of a subcontainer

Parameters

renderStatus	Changes
overrride	overwrite

ChangeSubMenuContainerRenderStatus() [2/2]

void Yukar.Engine.LayoutDrawer.ChangeSubMenuContainerRenderStatus	(	AbstractRenderObject.RenderStatus	renderStatus,
		bool	overrride,
		int	menuContainerIndex
	)

Change the drawing state of a subcontainer

Parameters

renderStatus	Changes
overrride	overwrite

ClearLastSelectedIndicies()

static void Yukar.Engine.LayoutDrawer.ClearLastSelectedIndicies ( )

static

Clear the last selected index

ClearSkipDrawIndices()

void Yukar.Engine.LayoutDrawer.ClearSkipDrawIndices

(

)

Clear information to skip drawing

ConfigureContentProperty() [1/4]

void Yukar.Engine.LayoutDrawer.ConfigureContentProperty

(

int

maximumContent

)

Set maximum number of elements in menu container

Parameters

maximumContent

maximum number of elements

ConfigureContentProperty() [2/4]

void Yukar.Engine.LayoutDrawer.ConfigureContentProperty	(	int	maximumContent,
		bool	updateRenderPanel,
		SpecialTextRenderer.SpecialTexts	specialText
	)

Sets the maximum number of menu container elements that contain the specified special formatting

Parameters

maximumContent	maximum number of elements
updateRenderPanel	whether to update the drawing panel index number
specialText	Special format you want to set

ConfigureContentProperty() [3/4]

void Yukar.Engine.LayoutDrawer.ConfigureContentProperty	(	int	maximumContent,
		int	index
	)

Set maximum number of elements in menu container

Parameters

maximumContent	maximum number of elements
index	the index number of the drawing object to change

ConfigureContentProperty() [4/4]

void Yukar.Engine.LayoutDrawer.ConfigureContentProperty	(	int	maximumContent,
		int	index,
		bool	updateRenderPanelIndex
	)

Set maximum number of elements in menu container

Parameters

maximumContent	maximum number of elements
index	the index number of the drawing object to change
updateRenderPanelIndex	whether to update the drawing panel index number

ConfigureMenuContainerContentProperty()

void Yukar.Engine.LayoutDrawer.ConfigureMenuContainerContentProperty	(	int	maximumContent,
		int	menuContainerIndex
	)

Set maximum number of elements in menu container

Parameters

maximumContent	maximum number of elements
menuContainerIndex	Index number of the menu container to change

ContainLayoutType()

bool Yukar.Engine.LayoutDrawer.ContainLayoutType	(	MenuSettings.MenuItem.LayoutType	layoutType,
		int	index
	)

Does it contain the specified layout type?

Parameters

layoutType	The type of layout you want to check for inclusion
index	the index number of the drawing object to check

Returns

true included false not included

ContainSpecialTextType()

bool Yukar.Engine.LayoutDrawer.ContainSpecialTextType	(	SpecialTextRenderer.SpecialTexts	specialText,
		int	index
	)

Whether the specified content contains special formatting

Parameters

specialText	The type of special format you want to check
index	the index number of the drawing object to check

Returns

true included false not included

ContainsRenderContent()

bool Yukar.Engine.LayoutDrawer.ContainsRenderContent

(

)

whether it contains something to draw

Returns

true included false not included

CreateBattleContent()

void Yukar.Engine.LayoutDrawer.CreateBattleContent

(

)

Generate elements for battle

Draw()

void Yukar.Engine.LayoutDrawer.Draw

(

)

draw

EnableAutoInputUpdate()

void Yukar.Engine.LayoutDrawer.EnableAutoInputUpdate	(	bool	autoInputUpdate,
		int	menuContainerIndex
	)

Change whether to automatically update input

Parameters

autoInputUpdate	true Automatically update false Do not automatically update
menuContainerIndex

EnableLoopPage()

void Yukar.Engine.LayoutDrawer.EnableLoopPage

(

bool

enable

)

Whether to loop the page movement of keystrokes in the menu container

Parameters

enable

true loop false no loop

EnableMessageSprite()

void Yukar.Engine.LayoutDrawer.EnableMessageSprite

(

bool

enable

)

Show/hide message sprites

Parameters

enable

true show false hide

EnableScrollText()

void Yukar.Engine.LayoutDrawer.EnableScrollText	(	bool	enable,
		int	index
	)

Enable text scrolling

Parameters

enable	true start scrolling false stop scrolling
index	the index number of the drawing object whose scrolling is to be changed

EnableSelectAll()

void Yukar.Engine.LayoutDrawer.EnableSelectAll

(

bool

enableSelectAll

)

select all

Parameters

enableSelectAll

true select all false normal selection

EnableSelectMulti()

void Yukar.Engine.LayoutDrawer.EnableSelectMulti	(	bool	enableSelectMulti,
		int	selectedCount
	)

Select multiple items from the beginning

Parameters

enableSelectMulti	true Select multiple items false Normal selection
selectedCount	number to select

EnableSubContainer() [1/2]

void Yukar.Engine.LayoutDrawer.EnableSubContainer	(	bool	enable,
		int	subContainerIndex
	)

Toggle enablement of submenu container (if disabled, it will not be selected when moving the cursor)

Parameters

enable	Whether to enable true enabled false disabled
subContainerIndex	Index of submenu container to change

EnableSubContainer() [2/2]

void Yukar.Engine.LayoutDrawer.EnableSubContainer	(	bool	enable,
		int	subContainerIndex,
		int	menuContainerIndex
	)

Toggle enablement of submenu container (if disabled, it will not be selected when moving the cursor)

Parameters

enable	Whether to enable true enabled false disabled
subContainerIndex	Index number of the submenu container to change
menuContainerIndex	Index number of the menu container to change

EnableSubContainerPageIndex()

void Yukar.Engine.LayoutDrawer.EnableSubContainerPageIndex	(	bool	enable,
		int	subContainerPageIndex,
		int	menuContainerIndex
	)

Change whether the subcontainer of the specified page number can be selected

Parameters

enable	true selectable false not selectable
subContainerPageIndex	The page number of the subcontainer you want to change
menuContainerIndex	Index number of the menu container to change

ForceBlinkSubContainer()

void Yukar.Engine.LayoutDrawer.ForceBlinkSubContainer	(	bool	forceUseBlinker,
		int	subContianerIndex,
		int	menuContainerIndex
	)

Force submenu container blinker

Parameters

forceUseBlinker	Force blinker or true to force false to not force
subContianerIndex	the index number of the subcontainer to modify
menuContainerIndex	Index number of the menu container to change

ForceHideNamePlate()

void Yukar.Engine.LayoutDrawer.ForceHideNamePlate

(

int

index

)

Force hide all nameplates

Parameters

index

Index number of drawing object to hide nameplate

ForceUpdateSubContainerTouch()

Tuple< bool, int > Yukar.Engine.LayoutDrawer.ForceUpdateSubContainerTouch

(

)

Force touch detection

Returns

true touched false not touched index number of the subcontainer being touched

GetAction()

MenuSettings.MenuItem.ActionType Yukar.Engine.LayoutDrawer.GetAction

(

int

index

)

get action

Parameters

index

Index number of the submenu container you want to get

Returns

action

GetAutoSizeMargin()

Vector2 Yukar.Engine.LayoutDrawer.GetAutoSizeMargin

(

int

index

)

Get Auto Adjust Margins

Parameters

index

Index number of the object for which you want to get the auto-fit margins

Returns

Auto Adjust Margin

GetFocusedMenuContainerIndex()

int Yukar.Engine.LayoutDrawer.GetFocusedMenuContainerIndex

(

bool

findFromAllContainers = false

)

Get the index number of the menu container that has focus

Returns

the index number of the menu container that has focus

GetIndexWithTagPosition()

int Yukar.Engine.LayoutDrawer.GetIndexWithTagPosition	(	AbstractRenderObject.TagPositions	tagPosition,
		AbstractRenderObject.Events	layoutEvent
	)

Get the index of the specified tag position

Parameters

tagPosition

the position where you want to get the index

Returns

the index at the specified position

GetIndexWithTagTelop()

int Yukar.Engine.LayoutDrawer.GetIndexWithTagTelop

(

AbstractRenderObject.TagTelop

tagTelop

)

Get the index that contains the telop tag

Parameters

tagTelop

Telop tags

Returns

Index that contains caption tags

GetInputtingActionAndObject()

Tuple< MenuSettings.MenuItem.ActionType, AbstractRenderObject > Yukar.Engine.LayoutDrawer.GetInputtingActionAndObject

(

)

Gets the currently entered action and the object that performs that action.

Returns

入力されているアクションタイプとそのオブジェクトのタプル。 If nothing is entered, it returns a tuple of ActionType.NONE and null.

GetLayoutStateGuid()

Guid Yukar.Engine.LayoutDrawer.GetLayoutStateGuid

(

)

Get the guid of the selected open layout state (to open multiple menus)

Returns

guid of layout state to open

GetMaximumSelectIndex()

int Yukar.Engine.LayoutDrawer.GetMaximumSelectIndex

(

int

menuContainerIndex

)

Get the maximum value of the selection index of the menu container

Parameters

menuContainerIndex

Index number of the menu container to get

Returns

Maximum value of the selection index of the menu container

GetMenuContainerIndex()

int Yukar.Engine.LayoutDrawer.GetMenuContainerIndex

(

int

renderObjectIndex

)

Convert from index in RenderObjects to index in MenuContainer

Parameters

renderObjectIndex

Returns

GetMenuItem()

MenuSettings.MenuItem Yukar.Engine.LayoutDrawer.GetMenuItem

(

AbstractRenderObject

obj

)

Get the setting value of the specified drawing object

Parameters

obj	the drawing object you want to get

Returns

Drawing object settings

GetMenuPage()

int Yukar.Engine.LayoutDrawer.GetMenuPage

(

)

Get page of menu container

Returns

menu container page

GetMostMajorContent()

SpecialTextRenderer.SpecialTexts Yukar.Engine.LayoutDrawer.GetMostMajorContent

(

int

index

)

Return the most content for all nodes

Returns

GetRednerObject()

AbstractRenderObject Yukar.Engine.LayoutDrawer.GetRednerObject

(

MenuSettings.MenuItem

mitem

)

Get the drawing object with the specified settings

Parameters

mitem

The setting value of the drawing object you want to get

Returns

drawing object

GetRenderObjects()

List< AbstractRenderObject > Yukar.Engine.LayoutDrawer.GetRenderObjects

(

)

Get a list of drawing objects

Returns

List of drawing objects

GetRenderObjectsWithPositionAnchorTag() [1/2]

List< AbstractRenderObject > Yukar.Engine.LayoutDrawer.GetRenderObjectsWithPositionAnchorTag	(	AbstractRenderObject.PositionAnchorTags	positionAnchorTag,
		int	index
	)

Get all objects with a special coordinate tag

Parameters

positionAnchorTag	Special coordinate tag to get
index	the index number of the drawing object to get

Returns

All objects with special coordinate tags

GetRenderObjectsWithPositionAnchorTag() [2/2]

List< AbstractRenderObject > Yukar.Engine.LayoutDrawer.GetRenderObjectsWithPositionAnchorTag	(	string	positionAnchorTag,
		int	index
	)

Get all objects with a special coordinate tag

Parameters

positionAnchorTag	Special coordinate tag to get
index	the index number of the drawing object to get

Returns

All objects with special coordinate tags

GetRenderObjectWithPositionAnchorTag() [1/4]

AbstractRenderObject Yukar.Engine.LayoutDrawer.GetRenderObjectWithPositionAnchorTag	(	AbstractRenderObject.PositionAnchorTags	positionAnchorTag,
		int	index
	)

Get an object with a special coordinate tag (return the first one found)

Parameters

positionAnchorTag	Special coordinate tag to get
index	the index number of the drawing object to get

Returns

Objects with special coordinate tags

GetRenderObjectWithPositionAnchorTag() [2/4]

AbstractRenderObject Yukar.Engine.LayoutDrawer.GetRenderObjectWithPositionAnchorTag	(	AbstractRenderObject.PositionAnchorTags	positionAnchorTag,
		int	menuIndex,
		int	index
	)

Get an object with a special coordinate tag (return the first one found)

Parameters

positionAnchorTag	Special coordinate tag to get
menuIndex	Container management number to acquire
index	the index number of the drawing object to get

Returns

Objects with special coordinate tags

GetRenderObjectWithPositionAnchorTag() [3/4]

AbstractRenderObject Yukar.Engine.LayoutDrawer.GetRenderObjectWithPositionAnchorTag	(	string	positionAnchorTag,
		int	index = -1
	)

Get an object with a special coordinate tag (return the first one found)

Parameters

positionAnchorTag	Special coordinate tag to get
index	the index number of the drawing object to get

Returns

Objects with special coordinate tags

GetRenderObjectWithPositionAnchorTag() [4/4]

AbstractRenderObject Yukar.Engine.LayoutDrawer.GetRenderObjectWithPositionAnchorTag	(	string	positionAnchorTag,
		int	menuIndex,
		int	index
	)

Get an object with a special coordinate tag (return the first one found)

Parameters

positionAnchorTag	Special coordinate tag to get
menuIndex	Container management number to acquire
index	the index number of the drawing object to get

Returns

Objects with special coordinate tags

GetSelectAction() [1/2]

MenuSettings.MenuItem.ActionType Yukar.Engine.LayoutDrawer.GetSelectAction

(

)

Get selected action

Returns

Selected action

GetSelectAction() [2/2]

MenuSettings.MenuItem.ActionType Yukar.Engine.LayoutDrawer.GetSelectAction

(

int

index

)

Get selected action

Parameters

index

the index number of the drawing object you want to get

Returns

Selected action

GetSelectIndex() [1/2]

int Yukar.Engine.LayoutDrawer.GetSelectIndex

(

)

Get the index number of the selected menu container

Returns

Index number in menu container selection

GetSelectIndex() [2/2]

int Yukar.Engine.LayoutDrawer.GetSelectIndex

(

int

menuContainerIndex

)

Get the index number of the selected menu container

Parameters

menuContainerIndex

Index number of the menu container you want to get

Returns

Index number in menu container selection

GetSelectMenuItem()

MenuSettings.MenuItem Yukar.Engine.LayoutDrawer.GetSelectMenuItem

(

)

Get selected menu item

Returns

Selected menu item

GetSelectOpenLayoutGuid()

Guid Yukar.Engine.LayoutDrawer.GetSelectOpenLayoutGuid

(

)

Get the guid of the selected open layout

Returns

guid of layout to open

GetSelectSliderValue()

float Yukar.Engine.LayoutDrawer.GetSelectSliderValue

(

)

Get the value of the selected slider

Returns

slider value

GetSliderMamixmumValueWithIndex() [1/2]

float Yukar.Engine.LayoutDrawer.GetSliderMamixmumValueWithIndex

(

int

index

)

Get maximum value of slider

Parameters

index

The index number of the subcontainer of the slider you want to get

Returns

Maximum slider value

GetSliderMamixmumValueWithIndex() [2/2]

float Yukar.Engine.LayoutDrawer.GetSliderMamixmumValueWithIndex	(	int	index,
		int	objectIndex
	)

Get maximum value of slider

Parameters

index	The index number of the subcontainer of the slider you want to get
objectIndex	Index number of the slider drawing object you want to get

Returns

Maximum slider value

GetSliderValueWithIndex() [1/2]

float Yukar.Engine.LayoutDrawer.GetSliderValueWithIndex

(

int

index

)

Get slider value

Parameters

index

The index number of the subcontainer of the slider you want to get

Returns

slider value

GetSliderValueWithIndex() [2/2]

float Yukar.Engine.LayoutDrawer.GetSliderValueWithIndex	(	int	index,
		int	objectIndex
	)

Get slider value

Parameters

index	The index number of the subcontainer of the slider you want to get
objectIndex	Index number of the slider drawing object you want to get

Returns

slider value

GetSnapPosition()

Vector2 Yukar.Engine.LayoutDrawer.GetSnapPosition

(

Vector2

position

)

Get position for snap

Parameters

position

Position before snap

Returns

Snap position

GetSpinValueWithIndex() [1/2]

int Yukar.Engine.LayoutDrawer.GetSpinValueWithIndex

(

int

index

)

Get spin value

Parameters

index

The index number of the subcontainer of the spin you want to get

Returns

spin value

GetSpinValueWithIndex() [2/2]

int Yukar.Engine.LayoutDrawer.GetSpinValueWithIndex	(	int	index,
		int	objectIndex
	)

Get spin value

Parameters

index	The index number of the subcontainer of the spin you want to get
objectIndex	Index number of the spin drawing object you want to obtain

Returns

spin value

GetTextDrawer()

TextDrawer Yukar.Engine.LayoutDrawer.GetTextDrawer

(

int

index

)

get text drawing object

Parameters

index

The index number of the drawing object for which you want to get the text drawing object

Returns

text drawing object

GetTextDrawerObject()

AbstractRenderObject Yukar.Engine.LayoutDrawer.GetTextDrawerObject	(	int	index,
		AbstractRenderObject.Events	usage,
		List< AbstractRenderObject >	items = null
	)

get text drawing object

Parameters

index

The index number of the drawing object for which you want to get the text drawing object

Returns

text drawing object

GetTextScale()

float Yukar.Engine.LayoutDrawer.GetTextScale

(

int

index

)

get text scale

Parameters

index

The index number of the drawing object for which you want to get the scale of the text

Returns

text scale

GetTextScaledSize()

Vector2 Yukar.Engine.LayoutDrawer.GetTextScaledSize

(

int

index

)

get text size

Parameters

index

Index number of the drawing object for which you want to get the size of the text

Returns

text size

GoNextSubContainer()

void Yukar.Engine.LayoutDrawer.GoNextSubContainer

(

int

menuContainerIndex

)

Select next subcontainer

Parameters

menuContainerIndex

Index number of the menu container to change

GoNextSubPanel()

void Yukar.Engine.LayoutDrawer.GoNextSubPanel	(	AbstractRenderObject.NextInputTypes	nextInputType,
		int	menuContainerIndex
	)

Select next subcontainer

Parameters

nextInputType	Input type
menuContainerIndex	Index number of the menu container to change

GoPreviousSubPanel()

void Yukar.Engine.LayoutDrawer.GoPreviousSubPanel

(

int

menuContainerIndex

)

Select previous subcontainer

Parameters

menuContainerIndex

Index number of the menu container to change

HasHideContainerOption()

bool Yukar.Engine.LayoutDrawer.HasHideContainerOption

(

)

Whether the selected container has a setting to hide the container when determined

Returns

Has a true setting Does not have a false setting

HaveDecidedByTouch()

bool Yukar.Engine.LayoutDrawer.HaveDecidedByTouch

(

)

whether it is determined by touch

Returns

true pressed false not pressed

Hide()

void Yukar.Engine.LayoutDrawer.Hide

(

bool

immediate = false

)

You want to hide

Parameters

immediate

Whether or not to perform erase animation.

HideContainer()

void Yukar.Engine.LayoutDrawer.HideContainer

(

)

hide container

HideRenderNamePlate()

void Yukar.Engine.LayoutDrawer.HideRenderNamePlate	(	int	containerIndex,
		int	index
	)

Hide nameplate

Parameters

containerIndex	Container index number on nameplate
index	the index number of the drawing object to hide

Initialize()

void Yukar.Engine.LayoutDrawer.Initialize	(	GameMain	gameMain,
		Common.Catalog	catalog,
		MenuSettings	menuSettings,
		bool	isPreview,
		bool	isThumbnail
	)

initialize

Parameters

gameMain	game main
catalog	catalog
menuSettings	List of setting values to read
isPreview	preview or not
isThumbnail	Thumbnail or not?

Insert()

void Yukar.Engine.LayoutDrawer.Insert	(	GameMain	gameMain,
		Common.Catalog	catalog,
		MenuSettings.MenuItem	addedMenuItem,
		MenuSettings.MenuItem	parentMenuItem,
		int	insertIndex,
		bool	isPreview
	)

insert

Parameters

gameMain	game main
catalog	catalog
addedMenuItem	Setting the layout to insert
parentMenuItem	Parent layout settings
insertIndex	index number to insert
isPreview	preview or not

IsAnytingInOutAnimating() [1/2]

bool Yukar.Engine.LayoutDrawer.IsAnytingInOutAnimating

(

)

whether something is animated

Returns

true during animation false no animation

IsAnytingInOutAnimating() [2/2]

bool Yukar.Engine.LayoutDrawer.IsAnytingInOutAnimating

(

int

index

)

whether something is animated

Parameters

index

the index number of the drawing object to check

Returns

true during animation false no animation

IsAnytingVisible() [1/2]

bool Yukar.Engine.LayoutDrawer.IsAnytingVisible

(

)

is there anything displayed

Returns

true showing false not showing

IsAnytingVisible() [2/2]

bool Yukar.Engine.LayoutDrawer.IsAnytingVisible

(

int

index

)

is there anything displayed

Parameters

index

the index number of the drawing object to check

Returns

true showing false not showing

IsFocusedMenuContainer()

bool Yukar.Engine.LayoutDrawer.IsFocusedMenuContainer

(

int

menuContainerIndex

)

is it focused

Parameters

menuContainerIndex

The index number of the menu container to check

Returns

true focused false not focused

IsHideMyself()

bool Yukar.Engine.LayoutDrawer.IsHideMyself

(

)

Whether to hide the container when the menu container is determined

IsLocked()

bool Yukar.Engine.LayoutDrawer.IsLocked

(

)

is it locked

Returns

true locked false not locked

IsSelectedFirstPage()

bool Yukar.Engine.LayoutDrawer.IsSelectedFirstPage

(

int

menuContainerIndex

)

Are you selecting the first page?

Parameters

menuContainerIndex

The index number of the menu container to check

Returns

true selected false not selected

IsSelectedLastPage()

bool Yukar.Engine.LayoutDrawer.IsSelectedLastPage

(

int

menuContainerIndex

)

Are you selecting the last page?

Parameters

menuContainerIndex

The index number of the menu container to check

Returns

true selected false not selected

IsTextOutOfScrren()

bool Yukar.Engine.LayoutDrawer.IsTextOutOfScrren

(

int

index

)

whether the text is off screen

Parameters

index

The index number of the drawing object to check if the text is offscreen

Returns

true outside the screen false inside the screen

IsTouchingAnything() [1/2]

bool Yukar.Engine.LayoutDrawer.IsTouchingAnything

(

SharpKmyMath.Vector2

position

)

are you touching something

Parameters

position

position of touch

Returns

true touched false not touched

IsTouchingAnything() [2/2]

bool Yukar.Engine.LayoutDrawer.IsTouchingAnything	(	SharpKmyMath.Vector2	position,
		int	index
	)

are you touching something

Parameters

position	position of touch
index	The index number of the drawing object to check for touching

Returns

true touched false not touched

IsUpdateSubContainerRenderStatus()

bool Yukar.Engine.LayoutDrawer.IsUpdateSubContainerRenderStatus

(

)

Update the drawing status of a subcontainer

Lock()

void Yukar.Engine.LayoutDrawer.Lock

(

)

lock

Move()

void Yukar.Engine.LayoutDrawer.Move	(	MenuSettings.MenuItem	movedMenuItem,
		MenuSettings.MenuItem	movedParentMenuItem,
		int	insertIndex
	)

Moving

Parameters

movedMenuItem	Setting the layout to move
movedParentMenuItem	Setting the parent of the layout to be moved
insertIndex	Destination index number

MovedPage()

bool Yukar.Engine.LayoutDrawer.MovedPage

(

int

menuContainerIndex

)

Did you move the page (need to call update first)

Parameters

menuContainerIndex

The index number of the menu container to check

Returns

true moved false not moved

ParseNodes()

List< AbstractRenderObject > Yukar.Engine.LayoutDrawer.ParseNodes

(

)

return all nodes

Returns

PressNextPage()

bool Yukar.Engine.LayoutDrawer.PressNextPage

(

int

menuContainerIndex

)

Did you enter a move to the next page?

Parameters

menuContainerIndex

The index number of the menu container to check

Returns

true pressed false not pressed

PressPreviousPage()

bool Yukar.Engine.LayoutDrawer.PressPreviousPage

(

int

menuContainerIndex

)

Did you enter a move to the previous page?

Parameters

menuContainerIndex

The index number of the menu container to check

Returns

true pressed false not pressed

Release()

void Yukar.Engine.LayoutDrawer.Release

(

)

Open

Remove()

void Yukar.Engine.LayoutDrawer.Remove

(

MenuSettings.MenuItem

removedMenuItem

)

delete

Parameters

removedMenuItem

Setting the layout to be deleted

ResetSliderValueFromMenuItem()

void Yukar.Engine.LayoutDrawer.ResetSliderValueFromMenuItem

(

int

index

)

Reset slider value from menu item setting value

Parameters

index

Index number of the slider to reset

ResetSubMenuContainerRenderStatus()

void Yukar.Engine.LayoutDrawer.ResetSubMenuContainerRenderStatus

(

)

Reset the drawing state of the subcontainer

ResetVisible()

void Yukar.Engine.LayoutDrawer.ResetVisible

(

MenuSettings.MenuItem

menuItem

)

Reset display state

Parameters

menuItem

Setting the layout to reset the display state

SetCursorVisible()

void Yukar.Engine.LayoutDrawer.SetCursorVisible

(

bool

state

)

Change cursor visibility

Parameters

state

true show false do not show

SetGridProperty()

void Yukar.Engine.LayoutDrawer.SetGridProperty	(	bool	drawGrid,
		int	previewScreenWidth,
		int	previewScreenHeight
	)

Set grid settings

Parameters

drawGrid	whether to draw the grid
previewScreenWidth	screen width of preview screen
previewScreenHeight	screen height of preview screen

SetLayoutStateGuid()

void Yukar.Engine.LayoutDrawer.SetLayoutStateGuid

(

Guid

guid

)

SetSelectIndex() [1/2]

void Yukar.Engine.LayoutDrawer.SetSelectIndex

(

int

index

)

Change the selected index number

Parameters

index

Index number to change

SetSelectIndex() [2/2]

void Yukar.Engine.LayoutDrawer.SetSelectIndex	(	int	index,
		int	menuContainerIndex
	)

Change the selected index number

Parameters

index	Index number to change
menuContainerIndex	Index number of the menu container to change

SetSelectingLayout()

void Yukar.Engine.LayoutDrawer.SetSelectingLayout

(

Guid

guid

)

Make the object with the specified guid selected

Parameters

guid	the guid of the object you want to select

SetSliderValueAllowModification()

void Yukar.Engine.LayoutDrawer.SetSliderValueAllowModification	(	int	index,
		bool	v
	)

Forcibly enable the selected slider value set (for variable operations)

Parameters

index
v

SetSliderValueWithIndex() [1/2]

void Yukar.Engine.LayoutDrawer.SetSliderValueWithIndex	(	float	value,
		int	index
	)

Change slider value

Parameters

value	Value to set
index	The index number of the subcontainer of the slider whose value you want to change

SetSliderValueWithIndex() [2/2]

void Yukar.Engine.LayoutDrawer.SetSliderValueWithIndex	(	float	value,
		int	index,
		int	objectIndex
	)

Change slider value

Parameters

value	Value to set
index	The index number of the subcontainer of the slider whose value you want to change
objectIndex	Index number of the slider drawing object whose value you want to change

SetSpinValueWithIndex() [1/2]

void Yukar.Engine.LayoutDrawer.SetSpinValueWithIndex	(	int	value,
		int	index
	)

Change spin value

Parameters

value	Value to set
index	The index number of the subcontainer of the spin you want to set

SetSpinValueWithIndex() [2/2]

void Yukar.Engine.LayoutDrawer.SetSpinValueWithIndex	(	int	value,
		int	index,
		int	objectIndex
	)

Change spin value

Parameters

value	Value to set
index	The index number of the subcontainer of the spin you want to set
objectIndex	Index number of the spin drawing object you want to obtain

Show()

void Yukar.Engine.LayoutDrawer.Show

(

)

indicate

ShowContainer()

void Yukar.Engine.LayoutDrawer.ShowContainer

(

)

make the container visible

ShowRenderNamePlate()

void Yukar.Engine.LayoutDrawer.ShowRenderNamePlate	(	int	containerIndex,
		int	index
	)

Show nameplate

Parameters

containerIndex	Container index number on nameplate
index	the index number of the drawing object to display

SkipContentRendering()

void Yukar.Engine.LayoutDrawer.SkipContentRendering

(

bool

skip

)

Avoid drawing non-strings (container children are still drawn)

Parameters

skip	true Do not draw the container false Draw the container

SkipDrawingWithTagPosition()

void Yukar.Engine.LayoutDrawer.SkipDrawingWithTagPosition	(	AbstractRenderObject.TagPositions	tagPosition,
		AbstractRenderObject.Events	layoutEvent
	)

Skip drawing outside the specified tag position

Parameters

tagPosition	the position you want to display
layoutEvent	layout event

SkipDrawingWithTagTelop()

void Yukar.Engine.LayoutDrawer.SkipDrawingWithTagTelop	(	bool	useBacground,
		bool	useImage,
		bool	isScrolling
	)

Change caption display

Parameters

useBacground	use background
isScrolling	do you scroll

UnLock()

void Yukar.Engine.LayoutDrawer.UnLock

(

)

to unlock

Update()

void Yukar.Engine.LayoutDrawer.Update

(

)

Update

UpdateGameContent()

void Yukar.Engine.LayoutDrawer.UpdateGameContent	(	AbstractRenderObject.GameContent	gameContent,
		bool	skipBattleReplace = false
	)

Update game content

Parameters

gameContent	Game content
skipBattleReplace	Skip processing for battle or true Skip false Do not skip

UpdateSpecialRenderObject()

void Yukar.Engine.LayoutDrawer.UpdateSpecialRenderObject

(

)

Update special formatting

UpdateTouchCollider()

void Yukar.Engine.LayoutDrawer.UpdateTouchCollider

(

Vector2

addtionalContainerSize

)

Update hitbox

Parameters

addtionalContainerSize

Additional size of container when previewing

Member Data Documentation

extraGuid

Guid Yukar.Engine.LayoutDrawer.extraGuid = Guid.Empty

static

fov

Func<float> Yukar.Engine.LayoutDrawer.fov = () => 0.2f

lineOffset

int Yukar.Engine.LayoutDrawer.lineOffset = 0

maxLineNum

Func<int> Yukar.Engine.LayoutDrawer.maxLineNum = () => 3

menuContainers

List<MenuContainer> Yukar.Engine.LayoutDrawer.menuContainers

renderObjects

List<AbstractRenderObject> Yukar.Engine.LayoutDrawer.renderObjects

rootVisibility

bool Yukar.Engine.LayoutDrawer.rootVisibility = false

selectingVariableName

string Yukar.Engine.LayoutDrawer.selectingVariableName

selectMenuContainer

MenuContainer Yukar.Engine.LayoutDrawer.selectMenuContainer

setContainerNumber

bool Yukar.Engine.LayoutDrawer.setContainerNumber

setVariableOneOrigin

bool Yukar.Engine.LayoutDrawer.setVariableOneOrigin

variableName

string Yukar.Engine.LayoutDrawer.variableName

Property Documentation

Guid

Guid Yukar.Engine.LayoutDrawer.Guid

get

MenuContainersCount

int Yukar.Engine.LayoutDrawer.MenuContainersCount

get

Get the number of currently available menu containers

RenderObjectsCount

int Yukar.Engine.LayoutDrawer.RenderObjectsCount

get

Get the number of currently rendered objects

ShouldDrawCollider

bool Yukar.Engine.LayoutDrawer.ShouldDrawCollider

getset