Logo
Classes | Public Member Functions | Static Public Member Functions | Properties | List of all members
Yukar.Engine.GameContentCreator Class Reference

A class that picks up in-game information and generates drawing items More...

Classes

class  RenderContent
 A structure that stores information used for drawing More...
 
class  Thumbnail
 Thumbnail management class More...
 

Public Member Functions

bool SetPartyThumbnail (RenderContent inResult, int inImageInstanceIndex)
 Sets the specified party member's thumbnail based on the index of a specific image instance. More...
 
bool SetPartyImageThumbnail (RenderContent inResult, int inImageInstanceIndex)
 Sets the thumbnail image of the party character in the menu based on the index of the specified image instance. More...
 
bool SetPartyImageThumbnail (RenderContent inResult, Cast inCast)
 Sets the party image thumbnail for the given render content based on the provided cast. More...
 
bool SetPartyThumbnail (RenderContent inResult, Cast inCast)
 Sets the party thumbnail for the given render content using the provided cast. More...
 
bool SetPartyIconThumbnail (RenderContent inResult, Cast inCast)
 Sets the party icon thumbnail for the given render content based on the provided cast. More...
 
bool SetPartyIconThumbnail (RenderContent inResult, GameDataManager savedata, int index)
 Sets the icon thumbnail of the specified party member. More...
 
string SetConditionName (Dictionary< Guid, Common.GameData.Hero.ConditionInfo > conditionInfoDic, int getIndex=-1)
 Get the Hero's status ailment name More...
 
bool SetConditionIconThumbnail (RenderContent inResult, Dictionary< Guid, Common.GameData.Hero.ConditionInfo > conditionInfoDic, int getIndex=-1)
 Get the Hero's status ailment icon More...
 
bool SetHeroResistanceIconThumbnail (RenderContent inResult, Common.GameData.Hero hero, int attributeIndex)
 Get a hero's elemental resistance thumbnail More...
 
bool SetCastResistanceIconThumbnail (RenderContent inResult, Cast cast, int attributeIndex)
 Sets the thumbnail icon of the specified cast's resistance attribute. More...
 
bool SetResistanceIconThumbnail (RenderContent inResult, int attributeIndex)
 Sets the thumbnail icon for the specified resistance attribute based on its index. More...
 
bool SetHeroAttributeIconThumbnail (RenderContent inResult, Common.GameData.Hero hero)
 Get thumbnails of hero attributes More...
 
bool SetCastAttributeIconThumbnail (RenderContent inResult, Cast cast)
 Get attribute thumbnail for cast More...
 
string GetCastJobName (Cast cast, bool isSubClass)
 Get the name of the cast's occupation More...
 
string GetCastJobLevel (Cast cast, bool isSubClass)
 Gets the specified cast member's occupation level based on their primary or secondary occupation. More...
 
bool SetHeroJobIcon (RenderContent inResult, Common.GameData.Hero hero, bool isSubClass)
 Sets the profession icon based on the specified hero's primary or secondary profession. More...
 
bool SetCastJobIcon (RenderContent inResult, Cast cast, bool isSubClass)
 Sets the profession icon based on the specified caster's primary or secondary profession. More...
 
string GetHeroExtraParameter (Common.GameData.Hero hero, string ParameterName)
 Gets the value of an additional parameter for the specified hero. More...
 
string GetCastExtraParameter (Cast cast, string ParameterName)
 Gets the value of additional parameters associated with the specified cast. More...
 
string ReplaceVariableString (string variableString)
 Replaces escape sequences in the specified string with their corresponding literal values. More...
 
bool SetMemberThumbnail (RenderContent inResult, Common.GameData.Hero hero)
 Generates a thumbnail image for the specified hero and assigns it to the provided render content. More...
 
int GetGrowthFactor (Common.GameData.Hero inHero, int inStatusIndex)
 Calculates the hero's growth factor based on the specified stat index. More...
 
string GetGrowthFactor (BattleCharacterBase inHero, int inStatusIndex)
 Gets the growth factor for a given stat index for the specified hero. More...
 
string GetJobStatus (CastJob castJob, int statusIndex, BattleEnum.LevelUpData levelUpData)
 Gets the status of a specific cast profession at the specified index, optionally including level up data. More...
 
string GetHeroResistance (Common.GameData.Hero hero, int resistanceIndex)
 Get a hero's attribute resistance value More...
 

Static Public Member Functions

static GameContentParser.StatusUpDown CompareStatus (int inBefore, int inAfter)
 Compare status changes More...
 
static string GetStatusDiffText (int inBefore, int inAfter, out GameContentParser.StatusUpDown outStatusUpDown)
 Get status changes in text More...
 
static int[] GetJobStatus (CastJob castJob)
 Gets the current status of the specified occupation as an array of integers. More...
 
static int GetExpLevelIndex (List< int > expTable, int exp)
 Determines the index of the experience level corresponding to the specified experience value within the provided experience value table. More...
 
static int GetNextLevelExp (List< int > expTable, int exp)
 Calculates the experience points needed to reach the next level based on the experience table provided and the current experience points. Experience points to next level More...
 
static int GetCurrentLevelExp (List< int > expTable, int exp)
 Calculates the experience points earned within the current level based on the provided experience table and total experience points. Experience points at current level More...
 
static string GetJobExpStatus (Common.GameData.CastJob castJob, int index)
 Gets the status related to the experience of a profession based on the specified index. More...
 
static string GetJobExpStatus (Common.Rom.Job job, int index)
 Gets the specific experience-related value for the given occupation based on the specified index. More...
 

Properties

int ContentIndex [get, set]
 
int ContentPage [get, set]
 
int ContentPageSize [get, set]
 
int OnePageContenAmount [get, set]
 

Detailed Description

A class that picks up in-game information and generates drawing items

Member Function Documentation

◆ CompareStatus()

static GameContentParser.StatusUpDown Yukar.Engine.GameContentCreator.CompareStatus ( int  inBefore,
int  inAfter 
)
static

Compare status changes

◆ GetCastExtraParameter()

string Yukar.Engine.GameContentCreator.GetCastExtraParameter ( Cast  cast,
string  ParameterName 
)

Gets the value of additional parameters associated with the specified cast.

Parameters
cast追加パラメータを含むキャストオブジェクト。nullIt must not be.
ParameterName取得するパラメータの名前。nullor must not be empty.
Returns
指定されたパラメータの値を、変数を置き換えた文字列として返します。パラメータが見つからない場合、 or returns an empty string if the cast is <see langword=\

◆ GetCastJobLevel()

string Yukar.Engine.GameContentCreator.GetCastJobLevel ( Cast  cast,
bool  isSubClass 
)

Gets the specified cast member's occupation level based on their primary or secondary occupation.

Parameters
cast職業レベルを取得するキャストメンバー。nullIt must not be.
isSubClass副職業のレベルを取得する場合はtrue、主職業のレベルを取得する場合はfalse.
Returns
Occupation level string representation.

◆ GetCastJobName()

string Yukar.Engine.GameContentCreator.GetCastJobName ( Cast  cast,
bool  isSubClass 
)

Get the name of the cast's occupation

Parameters
castCast to get occupation name
isSubClassWhether to acquire a side job true side job name false job name
Returns
occupation name

◆ GetCurrentLevelExp()

static int Yukar.Engine.GameContentCreator.GetCurrentLevelExp ( List< int >  expTable,
int  exp 
)
static

Calculates the experience points earned within the current level based on the provided experience table and total experience points. Experience points at current level

Parameters
expTableA list of integers representing the cumulative experience points required to reach each level.
expTotal experience points accumulated by the player.
Returns
現在のレベル内で獲得した経験値。プレイヤーが最初のレベルの場合は総経験値を返します。expTable がnullの場合、 or -1 if the experience points cannot be mapped to a valid level.

◆ GetExpLevelIndex()

static int Yukar.Engine.GameContentCreator.GetExpLevelIndex ( List< int >  expTable,
int  exp 
)
static

Determines the index of the experience level corresponding to the specified experience value within the provided experience value table.

Parameters
expTable各レベルの経験値閾値を表す整数のリスト。リストは昇順でソートされている必要があり、 Each value represents the minimum experience needed to reach the next level.
Parameters
expExperience points to evaluate.
Returns
exp に対応するexpTable 内のレベルのゼロベースのインデックス。 expTable がnullの場合、またはexp がテーブル内のすべての閾値を超える場合は-1を返します。

◆ GetGrowthFactor() [1/2]

string Yukar.Engine.GameContentCreator.GetGrowthFactor ( BattleCharacterBase  inHero,
int  inStatusIndex 
)

Gets the growth factor for a given stat index for the specified hero.

Parameters
inHero成長要因が取得されるヒーロー。nullIt must not be.
inStatusIndexIndex of the status to get the growth factor.
Returns
A string representation of the growth factor for the specified status index.

◆ GetGrowthFactor() [2/2]

int Yukar.Engine.GameContentCreator.GetGrowthFactor ( Common.GameData.Hero  inHero,
int  inStatusIndex 
)

Calculates the hero's growth factor based on the specified stat index.

Parameters
inHeroA hero whose growth factors are calculated.
inStatusIndexIndex of status to evaluate.
Returns
Growth factors as integers.

◆ GetHeroExtraParameter()

string Yukar.Engine.GameContentCreator.GetHeroExtraParameter ( Common.GameData.Hero  hero,
string  ParameterName 
)

Gets the value of an additional parameter for the specified hero.

Parameters
hero追加パラメータの値を取得するヒーロー。nullIt must not be.
ParameterNameName of the parameter to retrieve.
Returns
指定されたパラメータの値を文字列として返します。heronullの場合、 or returns an empty string if the parameter does not exist.

◆ GetHeroResistance()

string Yukar.Engine.GameContentCreator.GetHeroResistance ( Common.GameData.Hero  hero,
int  resistanceIndex 
)

Get a hero's attribute resistance value

Parameters
heroHero you want to get attribute resistance value
resistanceIndexIndex number of attribute resistance value to get
Returns
attribute resistance value

◆ GetJobExpStatus() [1/2]

static string Yukar.Engine.GameContentCreator.GetJobExpStatus ( Common.GameData.CastJob  castJob,
int  index 
)
static

Gets the status related to the experience of a profession based on the specified index.

Parameters
castJob経験ステータスが取得される職業データ。nullIt must not be.
index取得する経験関連情報のタイプを指定するインデックス:
  • 0: 現在のレベル。
  • 1: 現在の経験値ポイント。
  • 2: 次のレベルに到達するために必要な経験値ポイント。
  • 3: 最大レベル。
  • 4: 現在のレベルで蓄積された経験値ポイント。
Returns
要求された経験関連ステータスの文字列表現。castJobnullの場合、 or returns an empty string if <paramref name=\

◆ GetJobExpStatus() [2/2]

static string Yukar.Engine.GameContentCreator.GetJobExpStatus ( Common.Rom.Job  job,
int  index 
)
static

Gets the specific experience-related value for the given occupation based on the specified index.

Parameters
job経験値とレベル情報を含む職業オブジェクト。nullIt must not be.
index取得する値を指定するインデックス:
  • 0: 職業の現在のレベル。
  • 1: 職業の現在の経験値ポイント。
  • 2: 次のレベルに到達するために必要な経験値ポイント。
  • 3: 職業の最大レベル。
  • 4: 現在のレベルに必要な経験値ポイント。
Returns
要求された値の文字列表現、またはjobnullの場合、 or an empty string if <paramref name=\

◆ GetJobStatus() [1/2]

static int[] Yukar.Engine.GameContentCreator.GetJobStatus ( CastJob  castJob)
static

Gets the current status of the specified occupation as an array of integers.

Parameters
castJobステータスを取得する職業。nullIt must not be.
Returns
レベル、ヒットポイント、マジックポイント、経験値などの属性を含む、職業のステータスを表す整数の配列。 castJobnullの場合はnullを返します。

◆ GetJobStatus() [2/2]

string Yukar.Engine.GameContentCreator.GetJobStatus ( CastJob  castJob,
int  statusIndex,
BattleEnum.LevelUpData  levelUpData 
)

Gets the status of a specific cast profession at the specified index, optionally including level up data.

Parameters
castJobCast profession to obtain status.
statusIndexIndex of status value to retrieve.
levelUpDataステータスに適用するレベルアップデータ。現在のレベル、経験値、および次のレベルに必要な経験値を含みます。 levelUpData If the current level of is greater than 0, the status array is updated with this data.
Returns
指定されたインデックスのステータス値を文字列として返します。ステータスがnullの場合、 or returns an empty string if the index is out of range.

◆ GetNextLevelExp()

static int Yukar.Engine.GameContentCreator.GetNextLevelExp ( List< int >  expTable,
int  exp 
)
static

Calculates the experience points needed to reach the next level based on the experience table provided and the current experience points. Experience points to next level

Parameters
expTableA list of integers representing the experience points required for each level.
expThe entity's current experience.
Returns
Experience points needed to reach the next level.

◆ GetStatusDiffText()

static string Yukar.Engine.GameContentCreator.GetStatusDiffText ( int  inBefore,
int  inAfter,
out GameContentParser.StatusUpDown  outStatusUpDown 
)
static

Get status changes in text

◆ ReplaceVariableString()

string Yukar.Engine.GameContentCreator.ReplaceVariableString ( string  variableString)

Replaces escape sequences in the specified string with their corresponding literal values.

Parameters
variableStringInput string containing escape sequences.
Returns
エスケープシーケンスがリテラル値に置き換えられた新しい文字列。variableStringnullの場合は空の文字列を返します。

◆ SetCastAttributeIconThumbnail()

bool Yukar.Engine.GameContentCreator.SetCastAttributeIconThumbnail ( RenderContent  inResult,
Cast  cast 
)

Get attribute thumbnail for cast

Parameters
inResultstore the result
castcast to get attributes
Returns
true Acquisition success false Acquisition failure

◆ SetCastJobIcon()

bool Yukar.Engine.GameContentCreator.SetCastJobIcon ( RenderContent  inResult,
Cast  cast,
bool  isSubClass 
)

Sets the profession icon based on the specified caster's primary or secondary profession.

Parameters
inResult職業アイコンが設定されるRenderContentobject.
cast職業アイコンを設定するキャストメンバー。nullIt must not be.
isSubClassキャストメンバーの副職業を使用する場合はtrue、主職業を使用する場合はfalse.
Returns
<see langword=</returns>

◆ SetCastResistanceIconThumbnail()

bool Yukar.Engine.GameContentCreator.SetCastResistanceIconThumbnail ( RenderContent  inResult,
Cast  cast,
int  attributeIndex 
)

Sets the thumbnail icon of the specified cast's resistance attribute.

Parameters
inResultサムネイルが設定される RenderContentobject.
cast抵抗を表す Castobject.
attributeIndexZero-based index of the attribute used for thumbnail settings.
Returns
<see langword=</returns>

◆ SetConditionIconThumbnail()

bool Yukar.Engine.GameContentCreator.SetConditionIconThumbnail ( RenderContent  inResult,
Dictionary< Guid, Common.GameData.Hero.ConditionInfo conditionInfoDic,
int  getIndex = -1 
)

Get the Hero's status ailment icon

Parameters
inResultstore the result
conditionInfoDicHero status ailments
getIndexAbnormal status number you want to get
Returns

◆ SetConditionName()

string Yukar.Engine.GameContentCreator.SetConditionName ( Dictionary< Guid, Common.GameData.Hero.ConditionInfo conditionInfoDic,
int  getIndex = -1 
)

Get the Hero's status ailment name

Parameters
conditionInfoDicHero status ailments
getIndexAbnormal status number you want to get
Returns

◆ SetHeroAttributeIconThumbnail()

bool Yukar.Engine.GameContentCreator.SetHeroAttributeIconThumbnail ( RenderContent  inResult,
Common.GameData.Hero  hero 
)

Get thumbnails of hero attributes

Parameters
inResultstore the result
heroHero to get attributes
Returns
true Acquisition success false Acquisition failure

◆ SetHeroJobIcon()

bool Yukar.Engine.GameContentCreator.SetHeroJobIcon ( RenderContent  inResult,
Common.GameData.Hero  hero,
bool  isSubClass 
)

Sets the profession icon based on the specified hero's primary or secondary profession.

Parameters
inResultRender content where occupation icons are set.
hero職業アイコンを設定するヒーロー。nullIt must not be.
isSubClassヒーローの副職業を使用する場合はtrue、主職業を使用する場合はfalse.
Returns
<see langword=</returns>

◆ SetHeroResistanceIconThumbnail()

bool Yukar.Engine.GameContentCreator.SetHeroResistanceIconThumbnail ( RenderContent  inResult,
Common.GameData.Hero  hero,
int  attributeIndex 
)

Get a hero's elemental resistance thumbnail

Parameters
inResultstore the result
heroHero that acquires attribute resistance
attributeIndexattribute resistance index
Returns
true Acquisition success false Acquisition failure

◆ SetMemberThumbnail()

bool Yukar.Engine.GameContentCreator.SetMemberThumbnail ( RenderContent  inResult,
Common.GameData.Hero  hero 
)

Generates a thumbnail image for the specified hero and assigns it to the provided render content.

Parameters
inResultサムネイルが割り当てられるRenderContentオブジェクト。RenderContent.PartyThumbnailプロパティが Updated with generated thumbnail.
Parameters
heroHero to set thumbnail image.
Returns
<see langword=</returns>

◆ SetPartyIconThumbnail() [1/2]

bool Yukar.Engine.GameContentCreator.SetPartyIconThumbnail ( RenderContent  inResult,
Cast  inCast 
)

Sets the party icon thumbnail for the given render content based on the provided cast.

Parameters
inResultRender content object where the party icon thumbnail and related properties are set.
inCastA cast object containing the icon and graphic information used for thumbnail generation.
Returns
パーティアイコンサムネイルまたは画像IDが正常に設定された場合はtrue、それ以外の場合は<see langword=\

◆ SetPartyIconThumbnail() [2/2]

bool Yukar.Engine.GameContentCreator.SetPartyIconThumbnail ( RenderContent  inResult,
GameDataManager  savedata,
int  index 
)

Sets the icon thumbnail of the specified party member.

Parameters
inResultRender content object where the party icon thumbnail and related data are set.
savedataGame data manager with party information.
indexIndex of the party member to set the icon thumbnail for.
Returns
<see langword=</returns>

◆ SetPartyImageThumbnail() [1/2]

bool Yukar.Engine.GameContentCreator.SetPartyImageThumbnail ( RenderContent  inResult,
Cast  inCast 
)

Sets the party image thumbnail for the given render content based on the provided cast.

Parameters
inResultRender content object to which the party image thumbnail or ID is set.
inCastパーティ画像またはサムネイルを決定するために使用されるキャストオブジェクト。nullIt must not be.
Returns
<see langword=</returns>

◆ SetPartyImageThumbnail() [2/2]

bool Yukar.Engine.GameContentCreator.SetPartyImageThumbnail ( RenderContent  inResult,
int  inImageInstanceIndex 
)

Sets the thumbnail image of the party character in the menu based on the index of the specified image instance.

Parameters
inResultパーティ画像IDとサムネイルが設定されるRenderContentobject.
inImageInstanceIndexIndex of the image instance to use for party image thumbnail settings.
Returns
<see langword=</returns>

◆ SetPartyThumbnail() [1/2]

bool Yukar.Engine.GameContentCreator.SetPartyThumbnail ( RenderContent  inResult,
Cast  inCast 
)

Sets the party thumbnail for the given render content using the provided cast.

Parameters
inResultRender content object where the party thumbnail is set.
inCastサムネイル作成に使用するグラフィック情報を含むキャストオブジェクト。nullIt must not be.
Returns
<see langword=</returns>

◆ SetPartyThumbnail() [2/2]

bool Yukar.Engine.GameContentCreator.SetPartyThumbnail ( RenderContent  inResult,
int  inImageInstanceIndex 
)

Sets the specified party member's thumbnail based on the index of a specific image instance.

Parameters
inResultパーティサムネイルが設定されるRenderContentobject.
inImageInstanceIndexパーティサムネイル作成に使用する画像インスタンスのインデックス。利用可能な画像インスタンスの Must be within range.
Returns
パーティサムネイルが正常に作成および設定された場合はtrue、それ以外の場合は<see langword=\

◆ SetResistanceIconThumbnail()

bool Yukar.Engine.GameContentCreator.SetResistanceIconThumbnail ( RenderContent  inResult,
int  attributeIndex 
)

Sets the thumbnail icon for the specified resistance attribute based on its index.

Parameters
inResultサムネイルアイコンが設定される RenderContentobject.
attributeIndexZero-based index of the resistance attribute in the filtered attribute list.
Returns
<see langword=</returns>

Property Documentation

◆ ContentIndex

int Yukar.Engine.GameContentCreator.ContentIndex
getset

◆ ContentPage

int Yukar.Engine.GameContentCreator.ContentPage
getset

◆ ContentPageSize

int Yukar.Engine.GameContentCreator.ContentPageSize
getset

◆ OnePageContenAmount

int Yukar.Engine.GameContentCreator.OnePageContenAmount
getset