ORK Framework  2.27.1
API Documentation
ORKFramework.BattleTextsSettings Class Reference
Inheritance diagram for ORKFramework.BattleTextsSettings:
ORKFramework.BaseSettings ORKFramework.CoreSettings ORKFramework.IBaseData

Public Member Functions

 BattleTextsSettings (ORKProjectAsset project)
 
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
override void SetRealIDs ()
 Sets the RealID values (indexes). More...
 
override string GetName (int index)
 Gets the name of a data. More...
 
override string [] GetNames (bool addIndex)
 Gets a list of names of all data. More...
 
override int Add ()
 Adds new data. More...
 
override int Copy (int index)
 Creates a copy of the data with the specified index. More...
 
override void Remove (int index)
 Removes the data with the specified index. More...
 
override void Move (int index, bool down)
 Moves the data with the specified index. More...
 
ChoiceContent GetAllCombatantsContent (TargetType type, ContentLayout layout)
 
void ShowMissFlyingText (string info, Combatant combatant, IContentSimple content)
 
void ShowBlockFlyingText (string info, Combatant combatant, IContentSimple content)
 
void ShowBlockFlyingText (string info, Combatant combatant, GameObject gameObject, IContentSimple content)
 
void ShowCastCancelFlyingText (string info, Combatant combatant, IContentSimple content)
 
void ShowLevelUpFlyingText (string info, Combatant combatant)
 
void ShowClassLevelUpFlyingText (string info, Combatant combatant)
 
- Public Member Functions inherited from ORKFramework.BaseSettings
override void DataAdded (ORKDataType type, int index)
 Automatic data updated function when adding new data. More...
 
override void DataRemoved (ORKDataType type, int index, int index2)
 Automatic data update function when removing data. More...
 
override void DataMoved (ORKDataType type, bool down, int index, int index2)
 Automatic data update function when moving data. More...
 
override void DataLoaded ()
 Called after loading the project data of all settings. Handles final data checks. More...
 
- Public Member Functions inherited from ORKFramework.CoreSettings
virtual void LoadProject (ORKProjectAsset project)
 Loads the settings found in the ORK Project asset. More...
 
virtual void GetSaveData (ref Dictionary< string, ORKDataFile > list, bool encrypt)
 Gets the save data. More...
 
virtual void GetLoadData (ref Dictionary< string, ORKDataFile > list, ORKProjectAsset project)
 Gets the load data from the ORK Project asset. More...
 
virtual void GetGameVariables (ref List< string > list)
 Gets the game variables found in this settings. More...
 
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 
void SetRealIDs (BaseIndexData[] d)
 Sets the RealID values (indexes) of the data. More...
 

Public Attributes

AssetSource< GUISkin > textSkin = new AssetSource<GUISkin>()
 
ContentButton allAlliesButton = new ContentButton("All Allies")
 
ContentButton allEnemiesButton = new ContentButton("All Enemies")
 
ContentButton allCombatantsButton = new ContentButton("All Combatants")
 
LanguageContent [] escapeCommandText
 
LanguageContent [] defendCommandText
 
LanguageContent [] noneCommandText
 
LanguageContent [] gridMoveCommandText
 
LanguageContent [] gridOrientationCommandText
 
LanguageContent [] gridExamineCommandText
 
bool showInfo = true
 
NotificationQueueType queueInfos = NotificationQueueType.Queue
 
int infoBoxID = 0
 
float infoTime = 3
 
bool infoAtCom = false
 
bool infoComUpdate = true
 
string infoChildName = ""
 
Vector2 infoPosOff = Vector2.zero
 
bool infoInField = false
 
bool infoInTurnBased = true
 
bool infoInActiveTime = true
 
bool infoInRealTime = true
 
bool infoPhase = true
 
BattleInfo attackInfo = new BattleInfo("%u attacks")
 
BattleInfo abilityInfo = new BattleInfo("%u uses %")
 
BattleInfo itemInfo = new BattleInfo("%u uses %")
 
BattleInfo defendInfo = new BattleInfo("%u defends")
 
BattleInfo escapeInfo = new BattleInfo("%u tries to escape")
 
BattleInfo counterInfo = new BattleInfo("%u counters")
 
BattleInfo deathInfo = new BattleInfo("%u dies")
 
BattleInfo noneInfo = new BattleInfo("%u does nothing")
 
BattleInfo changeMemberInfo = new BattleInfo("%u is exchanged for %")
 
BattleInfo joinBattleInfo = new BattleInfo("%u joins the battle")
 
BattleInfo gridMoveInfo = new BattleInfo("%u moves")
 
BattleInfo stealItemInfo = new BattleInfo("%u steals %")
 
BattleInfo stealItemFailInfo = new BattleInfo("%u fails to steal")
 
BattleInfo stealItemNothingInfo = new BattleInfo("%u fails to steal")
 
BattleInfo stealMoneyInfo = new BattleInfo("%u steals % money")
 
BattleInfo stealMoneyFailInfo = new BattleInfo("%u fails to steal money")
 
BattleInfo stealMoneyNothingInfo = new BattleInfo("%u fails to steal money")
 
FlyingTextPositionSettings flyingTextPositionSettings = new FlyingTextPositionSettings()
 
bool effectRemoveTextEndBattle = true
 
bool effectRemoveTextEndDeath = true
 
FlyingTextGroup< StatusEffectFlyingTextSettings > [] statusEffectFlyingText = new FlyingTextGroup<StatusEffectFlyingTextSettings>[0]
 
FlyingTextGroup< FlyingTextSettings > [] missFlyingText = new FlyingTextGroup<FlyingTextSettings>[0]
 
FlyingTextGroup< FlyingTextSettings > [] blockFlyingText = new FlyingTextGroup<FlyingTextSettings>[0]
 
FlyingTextGroup< FlyingTextSettings > [] castCancelFlyingText = new FlyingTextGroup<FlyingTextSettings>[0]
 
FlyingTextGroup< FlyingTextSettings > [] levelUpFlyingText = new FlyingTextGroup<FlyingTextSettings>[0]
 
FlyingTextGroup< FlyingTextSettings > [] classLevelUpFlyingText = new FlyingTextGroup<FlyingTextSettings>[0]
 

Properties

override string FILENAME [get]
 
override int Count [get]
 
GUISkin GUISkin [get]
 
DefendShortcut DummyDefendAction [get]
 
EscapeShortcut DummyEscapeAction [get]
 
NoneShortcut DummyNoneAction [get]
 
GridMoveShortcut DummyGridMoveAction [get]
 
GridExamineShortcut DummyGridExamineAction [get]
 
GridOrientationShortcut DummyGridOrientationAction [get]
 
- Properties inherited from ORKFramework.CoreSettings
abstract string FILENAME [get]
 Gets the filename used for saving the settings. More...
 
abstract int Count [get]
 

Member Function Documentation

◆ Add()

override int ORKFramework.BattleTextsSettings.Add ( )
virtual

Adds new data.

Implements ORKFramework.CoreSettings.

◆ Copy()

override int ORKFramework.BattleTextsSettings.Copy ( int  index)
virtual

Creates a copy of the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ GetName()

override string ORKFramework.BattleTextsSettings.GetName ( int  index)
virtual

Gets the name of a data.

Returns
The name.
Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ GetNames()

override string [] ORKFramework.BattleTextsSettings.GetNames ( bool  addIndex)
virtual

Gets a list of names of all data.

Returns
The list of names.
Parameters
addIndexIf true, the index of the data will be added to the names.

Implements ORKFramework.CoreSettings.

◆ Move()

override void ORKFramework.BattleTextsSettings.Move ( int  index,
bool  down 
)
virtual

Moves the data with the specified index.

Parameters
indexThe data index.
downIf true, the data will be moved down.

Implements ORKFramework.CoreSettings.

◆ Remove()

override void ORKFramework.BattleTextsSettings.Remove ( int  index)
virtual

Removes the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ SetData()

override void ORKFramework.BattleTextsSettings.SetData ( DataObject  data)
virtual

Sets the variables of the class using a ORKFramework.DataObject.

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.CoreSettings.

◆ SetRealIDs()

override void ORKFramework.BattleTextsSettings.SetRealIDs ( )
virtual

Sets the RealID values (indexes).

Implements ORKFramework.CoreSettings.

Member Data Documentation

◆ defendCommandText

LanguageContent [] ORKFramework.BattleTextsSettings.defendCommandText
Initial value:
= ArrayHelper.CreateArray<LanguageContent>(ORK.Languages.Count,
new System.Type[] {typeof(string)}, new System.Object[] {"Defend"})

◆ escapeCommandText

LanguageContent [] ORKFramework.BattleTextsSettings.escapeCommandText
Initial value:
= ArrayHelper.CreateArray<LanguageContent>(ORK.Languages.Count,
new System.Type[] {typeof(string)}, new System.Object[] {"Escape"})

◆ gridExamineCommandText

LanguageContent [] ORKFramework.BattleTextsSettings.gridExamineCommandText
Initial value:
= ArrayHelper.CreateArray<LanguageContent>(ORK.Languages.Count,
new System.Type[] {typeof(string)}, new System.Object[] {"Examine"})

◆ gridMoveCommandText

LanguageContent [] ORKFramework.BattleTextsSettings.gridMoveCommandText
Initial value:
= ArrayHelper.CreateArray<LanguageContent>(ORK.Languages.Count,
new System.Type[] {typeof(string)}, new System.Object[] {"Move"})

◆ gridOrientationCommandText

LanguageContent [] ORKFramework.BattleTextsSettings.gridOrientationCommandText
Initial value:
= ArrayHelper.CreateArray<LanguageContent>(ORK.Languages.Count,
new System.Type[] {typeof(string)}, new System.Object[] {"Rotate"})

◆ noneCommandText

LanguageContent [] ORKFramework.BattleTextsSettings.noneCommandText
Initial value:
= ArrayHelper.CreateArray<LanguageContent>(ORK.Languages.Count,
new System.Type[] {typeof(string)}, new System.Object[] {"End Turn"})