ORK Framework  2.25.2
API Documentation
ORKFramework.CombatantSetting Class Reference
Inheritance diagram for ORKFramework.CombatantSetting:
ORKFramework.BaseLanguageData ORKFramework.IContent ORKFramework.BaseIndexData ORKFramework.IContentSimple ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

 CombatantSetting (string name)
 
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
int GetBuyPrice (Combatant user, VariableHandler localVariables, SelectedDataHandler selectedData)
 
void DoDeathChanges (Combatant combatant)
 
GameObject GetPrefab (Combatant combatant, ref int prefabIndex)
 
void PrefabRegisterStatusChanges (Combatant combatant, IStatusChanged notify)
 
void PrefabUnregisterStatusChanges (Combatant combatant, IStatusChanged notify)
 
IContentSimple GetTypeContent ()
 
string GetInfo (Combatant c)
 
string GetName ()
 
string GetDescription ()
 
string GetDescription (string name)
 
string GetIconTextCode ()
 
Texture GetIcon ()
 
GUIContent GetContent ()
 
IPortrait GetPortrait (int setIndex, int typeID)
 
- Public Member Functions inherited from ORKFramework.BaseLanguageData
 BaseLanguageData (string name)
 
- Public Member Functions inherited from ORKFramework.BaseData
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...
 

Public Attributes

int typeID = 0
 
FloatValue buyPriceValue = new FloatValue(50)
 
CombatantPrefab prefab = new CombatantPrefab()
 
bool setObjectName = false
 
CombatantConditionalPrefab [] conditionalPrefab = new CombatantConditionalPrefab[0]
 
Sound [] battleSound = new Sound[0]
 
CombatantPortraitSet [] portraitSet = new CombatantPortraitSet[0]
 
int [] controlMap = new int[0]
 
bool useObjectVariables = false
 
ObjectVariableSetting objectVariables
 
bool ownConsoleAddDefend = false
 
ConsoleTextActionSimple consoleAddDefend
 
bool ownConsoleDefend = false
 
ConsoleTextActionSimple consoleDefend
 
bool ownConsoleAddEscape = false
 
ConsoleTextActionSimple consoleAddEscape
 
bool ownConsoleEscape = false
 
ConsoleTextActionSimple consoleEscape
 
bool ownConsoleAddDeath = false
 
ConsoleTextActionSimple consoleAddDeath
 
bool ownConsoleDeath = false
 
ConsoleTextActionSimple consoleDeath
 
bool ownConsoleAddNone = false
 
ConsoleTextActionSimple consoleAddNone
 
bool ownConsoleNone = false
 
ConsoleTextActionSimple consoleNone
 
bool ownConsoleAddChangeMember = false
 
ConsoleTextActionSingle consoleAddChangeMember
 
bool ownConsoleChangeMember = false
 
ConsoleTextActionSingle consoleChangeMember
 
bool ownConsoleAddJoinBattle = false
 
ConsoleTextActionSimple consoleAddJoinBattle
 
bool ownConsoleJoinBattle = false
 
ConsoleTextActionSimple consoleJoinBattle
 
bool ownConsoleAddGridMove = false
 
ConsoleTextActionSimple consoleAddGridMove
 
bool ownConsoleGridMove = false
 
ConsoleTextActionSimple consoleGridMove
 
bool ownConsoleLevelUp = false
 
ConsoleTextLevelUp consoleLevelUp
 
bool ownConsoleLevelUpClass = false
 
ConsoleTextLevelUp consoleLevelUpClass
 
bool ownConsoleJoinGroup = false
 
ConsoleTextCombatant consoleJoinGroup
 
bool ownConsoleLeaveGroup = false
 
ConsoleTextCombatant consoleLeaveGroup
 
bool blockNotificationsStatusValue = false
 
bool blockNotificationsStatusEffect = false
 
bool blockFlyingTextsAttributeImmunity = false
 
bool blockFlyingTextsLevelUp = false
 
bool blockFlyingTextsCastCancel = false
 
bool blockFlyingTextsMiss = false
 
bool blockFlyingTextsBlocking = false
 
bool ownPlayerGroupNotifications = false
 
PlayerGroupNotifications playerGroupNotifications
 
CombatantEventSettings eventSettings = new CombatantEventSettings()
 
int startLevel = 1
 
int startClassID = 0
 
int startClassLevel = 1
 
bool notScanable = false
 
bool noBestiaryEntry = false
 
bool noStatusDevelopment = false
 
int [] startValue
 
int statusDevelopmentID = 0
 
bool useExpReward = false
 
ExperienceReward [] expReward
 
NormalStatusValueReward [] normalSVReward = new NormalStatusValueReward[0]
 
StatusTimeChange [] fieldStatusChange = new StatusTimeChange[0]
 
StatusTimeChange [] battleStatusChange = new StatusTimeChange[0]
 
int [] defenceAttributeID = new int[ORK.DefenceAttributes.Count]
 
AtkAttrStartValue [] atkAttrStart = new AtkAttrStartValue[0]
 
DefAttrStartValue [] defAttrStart = new DefAttrStartValue[0]
 
BonusSettings bonus = new BonusSettings()
 
AutoEffects autoEffects = new AutoEffects()
 
bool ownLvlUp = false
 
LevelUpBonus lvlUp
 
ActiveAbilitySelection [] baseAttack = new ActiveAbilitySelection[] {new ActiveAbilitySelection()}
 
ActiveAbilitySelection counterAttack = new ActiveAbilitySelection()
 
AutoAttack autoAttack = new AutoAttack()
 
LearnAbilitySetting abilityDevelopment = new LearnAbilitySetting()
 
bool replaceDefaultActionCombos = false
 
int [] actionCombo = new int[0]
 
int [] money = new int[ORK.Currencies.Count]
 
ItemGain [] itemDrop = new ItemGain[0]
 
CombatantLootOrigin lootOrigin = CombatantLootOrigin.StartInventory
 
bool lootRandom = false
 
int [] lootID
 
bool ownEquipment = false
 
AvailableEquipment equipment
 
StartEquipment [] startEquipment = new StartEquipment[0]
 
bool ownBM = false
 
int menuID = 0
 
bool useTurnBasedMenu = false
 
int turnBasedMenuID = 0
 
bool useActiveTimeMenu = false
 
int activeTimeMenuID = 0
 
bool useRealTimeMenu = false
 
int realTimeMenuID = 0
 
bool usePhaseMenu = false
 
int phaseMenuID = 0
 
bool ownCounterChance = false
 
FloatValue counterChance
 
bool ownBlockChance = false
 
FloatValue blockChance
 
bool ownEscapeChance = false
 
FloatValue escapeChance
 
bool ownActionTime = false
 
FloatValue actionTime
 
bool ownExperienceFactor = false
 
FloatValue experienceFactor
 
bool ownAutoStartBattles = false
 
AutoStartBattleSettings autoStartBattles
 
BattleAnimationOverride [] battleAnimation = new BattleAnimationOverride[0]
 
bool ownGridMoveRange = false
 
FloatValue gridMoveRange
 
bool ownGridMoveHeightLimit = false
 
GridMoveHeightLimit gridMoveHeightLimit
 
bool useGridCellSize = false
 
GridCellAreaSettings gridCellSize
 
bool noRevive = false
 
bool leaveOnDeath = false
 
bool deathKeepPrefab = false
 
bool removeFromBattle = true
 
float sympathyChange = 0
 
bool learnLog = false
 
bool completeLog = false
 
int logTextID = 0
 
int logID = 0
 
bool logShowConsole = true
 
LootVariableOrigin deathVarOrigin = LootVariableOrigin.Global
 
VariableSetter variables = new VariableSetter()
 
bool stealItem = false
 
float stealItemFactor = 1.0f
 
bool stealFixItem = true
 
ItemDropTypeSimple stealItemType = ItemDropTypeSimple.Item
 
int stealItemID = 0
 
bool stealItemOnce = false
 
bool stealMoney = false
 
float stealMoneyFactor = 1.0f
 
int stealMoneyAmount = 0
 
bool stealMoneyOnce = false
 
bool aiControlled = true
 
bool aiControlledPlayer = false
 
bool notControllable = false
 
bool aiStartBlocked = false
 
bool aiAutoTarget = false
 
bool aiNearestTarget = false
 
bool attackLastTarget = false
 
bool attackGroupTarget = false
 
bool attackIndividualTarget = false
 
AggressionType aggressionType = AggressionType.Always
 
bool aggressionNotifyGroup = true
 
bool aggressionReactGroup = true
 
bool aggressionNotifyFaction = false
 
bool aggressionReactFaction = false
 
Range aggressionNotifyRangeGroup = new Range(20)
 
Range aggressionNotifyRangeFaction = new Range(20)
 
bool limitAIRange = false
 
Range aiRange
 
float aiTimeout = 0
 
bool ownAIDecisionTime = false
 
AIDecisionTime aiDecisionTime
 
BattleAISelection [] aiBehaviour = new BattleAISelection[0]
 
AIBehaviourSlotSetting [] aiBehaviourSlot = new AIBehaviourSlotSetting[0]
 
AIRulesetSlotSetting [] aiRulesetSlot = new AIRulesetSlotSetting[0]
 
bool useClassShortcuts = false
 
bool ownShortcutListCount = false
 
int shortcutListCount = 1
 
bool replaceDefaultShortcuts = false
 
ShortcutSlotAssignment [] defaultShortcut = new ShortcutSlotAssignment[0]
 
bool replaceDefaultAutoAddSlots = false
 
AutoShortcutSlots [] autoAddShortcuts = new AutoShortcutSlots[0]
 
bool replaceDefaultAutoArrangeSlots = false
 
AutoShortcutSlots [] autoArrangeShortcuts = new AutoShortcutSlots[0]
 
AnimationSystem animationSystem = AnimationSystem.Legacy
 
string animationCustomName = ""
 
int animationID = 0
 
bool useBattleAnims = false
 
int animationBattleID = 0
 
bool autoMoveAnimation = false
 
AutoAnimationSetting autoAnimation
 
MovementSettings moveSettings = new MovementSettings()
 
bool useMoveAI = false
 
int moveID = 0
 
bool useBattleMoveAI = false
 
int battleMoveID = 0
 
- Public Attributes inherited from ORKFramework.BaseLanguageData
LanguageInfo [] languageInfo
 

Properties

AutoStartBattleSettingsAutoStartBattles [get]
 
int TypeID [get]
 
int ItemTypeID [get]
 
int ID [get]
 
- Properties inherited from ORKFramework.BaseIndexData
virtual int RealID [get, set]
 
- Properties inherited from ORKFramework.IContent
int TypeID [get]
 
- Properties inherited from ORKFramework.IContentSimple
int ID [get]
 

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.BaseIndexData
int realID = 0
 

Member Function Documentation

◆ SetData()

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

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.