ORK Framework
2.34.1
API Documentation
|
Public Member Functions | |
Group (int factionID) | |
Group (DataObject data) | |
void | FireChanged () |
void | Merge (Group other) |
Merges another group into this group, adding all combatants and inventory from the other group to this group. More... | |
void | Tick (float time, float battleTime) |
void | ClearTargets () |
bool | HasBattleReserve () |
List< Combatant > | GetGroup () |
List< Combatant > | GetGroupWithoutHidden () |
void | GetGroup (ref List< Combatant > list) |
List< Combatant > | GetBattle () |
void | GetBattle (ref List< Combatant > list) |
List< Combatant > | GetLockedBattle () |
void | GetLockedBattle (ref List< Combatant > list) |
List< Combatant > | GetBattleReserve () |
void | GetBattleReserve (ref List< Combatant > list) |
List< Combatant > | GetNonBattle () |
void | GetNonBattle (ref List< Combatant > list) |
List< Combatant > | GetNonBattleReserve () |
void | GetNonBattleReserve (ref List< Combatant > list) |
List< Combatant > | GetInactiveGroup () |
void | GetInactiveGroup (ref List< Combatant > list) |
List< Combatant > | GetHiddenGroup () |
void | GetHiddenGroup (ref List< Combatant > list) |
void | GetMembers (MenuCombatantScope scope, ref List< Combatant > list) |
List< Combatant > | GetBattleSorted () |
bool | IsPlayerControlled () |
Checks if this group is the active player group. More... | |
bool | IsPlayerGroup () |
Checks if this group is a player group (doesn't have to be the active player group). More... | |
bool | IsEnemy (Combatant combatant) |
bool | IsEnemy (int id) |
void | SetLockedLeader (Combatant combatant) |
Sets a combatant as the (field) leader of the group and locks it as the leader. The locked (field) leader will remain the group's leader, even if the first member is changed. More... | |
void | SetLeader (Combatant newLeader, bool moveOldBack) |
Set the (field) leader of the group. The (field) leader is the first member of the group. Has no effect if a locked leader is set. More... | |
void | FindNewBattleLeader () |
Combatant | GetSpawnedBattleLeader () |
int | MemberCount (int id) |
bool | IsMember (int id) |
bool | IsMember (Combatant combatant) |
bool | IsBattleMember (int id) |
bool | IsBattleMember (Combatant combatant) |
bool | IsBattleReserveMember (int id) |
bool | IsBattleReserveMember (Combatant combatant) |
bool | IsNonBattleMember (int id) |
bool | IsNonBattleMember (Combatant combatant) |
bool | IsInactive (int id) |
bool | IsInactive (Combatant combatant) |
bool | AllDeadBattle () |
bool | AllDeadBattleReserve () |
bool | AllDeadNonBattle () |
bool | AllDead () |
virtual void | Join (Combatant combatant, bool showNotification, bool showConsole) |
Lets a combatant join the group. More... | |
virtual void | Leave (Combatant combatant, bool destroyPrefab, bool showNotification, bool showConsole) |
Lets a combatant leave the group. More... | |
virtual void | Remove (Combatant combatant, bool setGroup, bool destroyPrefab, bool showNotification, bool showConsole) |
Removes a combatant from the group completely (i.e. no inactive member). More... | |
virtual void | SwitchGroup (Combatant oldCombatant, Combatant newCombatant, Group otherGroup) |
Switches combatants between this group and another group. More... | |
virtual void | Regenerate (bool onlyBattle, bool revive) |
Sets the 'Consumable' type status values of group members to their maximum value. More... | |
virtual void | MarkHUDUpdateShortcuts () |
virtual void | FireBeforeTargetChange () |
virtual void | FireAfterTargetChange () |
void | CheckMaxGroup () |
void | SetBattleGroup (List< Combatant > list, bool enterBattle) |
Sets the battle group. More... | |
bool | CanJoinBattle (Combatant combatant) |
void | JoinBattle (Combatant combatant) |
Lets a combatant join the battle group. More... | |
void | LeaveBattle (Combatant combatant, bool destroyPrefab) |
Lets a combatant leave the battle group. More... | |
bool | CanChangeBattle (Combatant oldCombatant, Combatant newCombatant) |
void | ChangeBattle (Combatant oldCombatant, Combatant newCombatant) |
Changes a member of the battle group with another combatant currently not in the battle group. Both combatants must be members of the group. More... | |
void | PlayerChangeCheck (Combatant combatant) |
void | CheckMaxBattleGroup () |
void | JoinBattleReserve (Combatant combatant) |
Lets a combatant join the battle reserve (only for player groups). More... | |
void | LeaveBattleReserve (Combatant combatant, bool destroyPrefab) |
Lets a combatant leave the battle reserve (only for player groups). More... | |
void | ChangeBattleReserve (Combatant oldCombatant, Combatant newCombatant) |
Changes a member of the battle reserve with another combatant currently not in the battle reserve. Both combatants must be members of the group. More... | |
void | CheckMaxBattleReserve () |
Combatant | GetOffset (Combatant combatant, int offset, bool battleGroup) |
Combatant | GetOffset (Combatant combatant, int offset, MenuCombatantScope scope) |
Combatant | GetOffsetControllable (Combatant combatant, int offset, bool battleGroup, bool notDead) |
Combatant | GetNextInLine (Combatant combatant, int offset, bool battleGroup) |
int | GetMemberIndex (Combatant combatant) |
Combatant | MemberAt (int index) |
int | GetBattleMemberIndex (Combatant combatant) |
Combatant | BattleMemberAt (int index) |
Combatant | BattleReserveMemberAt (int index) |
Combatant | NonBattleMemberAt (int index) |
Combatant | Get (int id) |
Combatant | GetBattle (int id) |
Combatant | GetInactive (int id) |
Combatant | GetMember (int id) |
Combatant | GetFirstAlive () |
void | LockBattleMember (Combatant combatant, bool doLock) |
Locks or unlocks a member of the battle group. A locked battle group member can't be removed. More... | |
bool | IsLockedBattleMember (Combatant combatant) |
bool | HasLockedBattleMembers () |
void | HideMember (Combatant combatant, bool doHide) |
Hides or unhides a member of the group. A hidden combatant isn't visible in any UI (e.g. menus). More... | |
bool | IsHiddenMember (Combatant combatant) |
Combatant | GetFirstNonHiddenMember () |
void | RespawnGroup () |
void | SpawnGroup (bool onlyBattle, bool onlyNonCreated) |
Spawns members of the group. More... | |
void | DestroyInstances (bool includeLeader) |
Destroys all spawned group members. More... | |
void | AggressionChangeGroup (Combatant combatant) |
void | AggressionChangeFaction (Combatant combatant) |
int | GetAbilityCount (AbilityShortcut shortcut) |
List< Combatant > | GetAbilityOwners (AbilityShortcut shortcut) |
void | SortVisual (List< Combatant > list) |
void | ChangeVisualSorting (int index, int newIndex) |
void | ChangeVisualSorting (Combatant combatant, Combatant otherCombatant) |
void | RemoveFromSort (Combatant combatant) |
void | ChangeBattleSort (Combatant combatant, Combatant otherCombatant) |
Moves a combatant in front of another combatant in the battle group. Both combatants must be members of the battle group. More... | |
void | ChangeMemberSort (Combatant combatant, Combatant otherCombatant) |
Moves a combatant in front of another combatant (members). Both combatants must be members of the group. More... | |
bool | IsFormation (int formationID) |
bool | IsInFormation (Combatant combatant) |
void | SetFormation (int formationID) |
void | CheckFormationGridFormation () |
void | UpdateFormationPositions () |
bool | GetFormationPosition (Combatant combatant, out Vector3 position) |
bool | GetFormationBattlePosition (Combatant combatant, out Vector3 position) |
DataObject | SaveGame () |
Used to save the data - you need to add the data to a ORKFramework.DataObject. More... | |
void | LoadGame (DataObject data) |
Used to load the data - you need to get the data from the ORKFramework.DataObject. More... | |
void | LoadMembers (DataObject data, bool loadPositions) |
Static Public Member Functions | |
static Combatant | GetOffsetGroup (Combatant combatant, int offset, List< Combatant > group) |
static Combatant | GetOffsetGroup (Combatant combatant, int offset, List< Combatant > group, ref int cycles) |
Properties | |
NotifyGroup | Changed |
int | FactionID [get, set] |
string | GUID [get, set] |
int | SizeLimit [get, set] |
Inventory | Inventory [get] |
bool | HasLoot [get] |
List< IShortcut > | Loot [get] |
int | Size [get] |
int | BattleSize [get] |
int | MaxBattleSize [get] |
int? | BattleReserveSize [get] |
int | NonBattleSize [get] |
GroupAbilities | Abilities [get] |
GroupShortcuts | Shortcuts [get] |
GroupGridFormation | GridFormation [get] |
bool | InGridFormation [get] |
SelectedTargets | SelectedTargets [get] |
int | AverageLevel [get] |
int | AverageBattleLevel [get] |
int | AverageMaxLevel [get] |
int | AverageBattleMaxLevel [get] |
int | AverageClassLevel [get] |
int | AverageBattleClassLevel [get] |
int | AverageMaxClassLevel [get] |
int | AverageBattleMaxClassLevel [get] |
int | AverageTurn [get] |
int | AverageBattleTurn [get] |
float | AverageTurnValue [get] |
float | AverageBattleTurnValue [get] |
float | AverageActionBar [get] |
float | AverageBattleActionBar [get] |
float | AverageUsedActionBar [get] |
float | AverageBattleUsedActionBar [get] |
float | AverageBattleActionTime [get] |
float | AverageActionTime [get] |
float | AverageBattleActionTimeMax [get] |
float | AverageActionTimeMax [get] |
float | AverageBattleGridMoveRange [get] |
float | AverageGridMoveRange [get] |
float | AverageBattleGridMoveRangeMax [get] |
float | AverageGridMoveRangeMax [get] |
Combatant | Leader [get] |
Combatant | FieldLeader [get] |
Combatant | BattleLeader [get] |
BattleSystemType | BattleType [get, set] |
SpawnOrigin | SpawnOrigin [get, set] |
bool | InFormation [get] |
Properties inherited from ORKFramework.IGUID | |
string | GUID [get, set] |
Changes a member of the battle group with another combatant currently not in the battle group. Both combatants must be members of the group.
oldCombatant | The combatant currently in the battle group. |
newCombatant | The combatant replacing the old combatant. |
Changes a member of the battle reserve with another combatant currently not in the battle reserve. Both combatants must be members of the group.
oldCombatant | The combatant currently in the battle reserve. |
newCombatant | The combatant replacing the old combatant. |
Moves a combatant in front of another combatant in the battle group. Both combatants must be members of the battle group.
combatant | The combatant that will be moved. |
otherCombatant | The other combatant. |
Moves a combatant in front of another combatant (members). Both combatants must be members of the group.
combatant | The first combatant. |
otherCombatant | The second combatant. |
void ORKFramework.Group.DestroyInstances | ( | bool | includeLeader | ) |
Destroys all spawned group members.
includeLeader | true if the group's leader should also be destroyed. |
void ORKFramework.Group.HideMember | ( | Combatant | combatant, |
bool | doHide | ||
) |
Hides or unhides a member of the group. A hidden combatant isn't visible in any UI (e.g. menus).
combatant | The combatant that will be hidden/unhidden |
doHide | true if the combatant will be hidden. |
bool ORKFramework.Group.IsPlayerControlled | ( | ) |
Checks if this group is the active player group.
true
if the group is the active player group.bool ORKFramework.Group.IsPlayerGroup | ( | ) |
Checks if this group is a player group (doesn't have to be the active player group).
true
if the group is a player group.
|
virtual |
Lets a combatant join the group.
combatant | The combatant that will join. |
showNotification | true if a notification should be displayed (player groups only). |
showConsole | true if a console line should be added (player groups only). |
void ORKFramework.Group.JoinBattle | ( | Combatant | combatant | ) |
Lets a combatant join the battle group.
combatant | The combatant that will join the battle group. |
void ORKFramework.Group.JoinBattleReserve | ( | Combatant | combatant | ) |
Lets a combatant join the battle reserve (only for player groups).
combatant | The combatant that will join the battle reserve. |
|
virtual |
Lets a combatant leave the group.
combatant | The combatant that will leave. |
destroyPrefab | true if the combatant's spawned prefab should be destroyed |
showNotification | true if a notification should be displayed (player groups only). |
showConsole | true if a console line should be added (player groups only). |
void ORKFramework.Group.LeaveBattle | ( | Combatant | combatant, |
bool | destroyPrefab | ||
) |
Lets a combatant leave the battle group.
combatant | The combatant that will leave the battle group. |
destroyPrefab | true if the combatant's spawned prefab should be destroyed. |
void ORKFramework.Group.LeaveBattleReserve | ( | Combatant | combatant, |
bool | destroyPrefab | ||
) |
Lets a combatant leave the battle reserve (only for player groups).
combatant | The combatant that will leave the battle reserve. |
destroyPrefab | true if the combatant's spawned prefab should be destroyed. |
void ORKFramework.Group.LoadGame | ( | DataObject | data | ) |
Used to load the data - you need to get the data from the ORKFramework.DataObject.
data | A ORKFramework.DataObject containing the data. |
Implements ORKFramework.ISaveData.
void ORKFramework.Group.LockBattleMember | ( | Combatant | combatant, |
bool | doLock | ||
) |
Locks or unlocks a member of the battle group. A locked battle group member can't be removed.
combatant | The combatant that will be locked/unlocked |
doLock | true if the combatant will be locked. |
void ORKFramework.Group.Merge | ( | Group | other | ) |
Merges another group into this group, adding all combatants and inventory from the other group to this group.
other | The other group that will be joined to this group. |
|
virtual |
Sets the 'Consumable' type status values of group members to their maximum value.
onlyBattle | true if only members of the battle group should be used. |
revive | true if dead combatants should be revived. |
|
virtual |
Removes a combatant from the group completely (i.e. no inactive member).
combatant | The combatant that will be removed. |
setGroup | true if the combatant's group should be cleared. |
destroyPrefab | true if the combatant's spawned prefab should be destroyed |
showNotification | true if a notification should be displayed (player groups only). |
showConsole | true if a console line should be added (player groups only). |
DataObject ORKFramework.Group.SaveGame | ( | ) |
Used to save the data - you need to add the data to a ORKFramework.DataObject.
Implements ORKFramework.ISaveData.
void ORKFramework.Group.SetBattleGroup | ( | List< Combatant > | list, |
bool | enterBattle | ||
) |
Sets the battle group.
list | The combatants that will be used as battle group. |
enterBattle | The combatants will enter the running battle. |
void ORKFramework.Group.SetLeader | ( | Combatant | newLeader, |
bool | moveOldBack | ||
) |
Set the (field) leader of the group. The (field) leader is the first member of the group. Has no effect if a locked leader is set.
newLeader | The new leader combatant. |
moveOldBack | true if the old leader should be moved to the back of the group. |
void ORKFramework.Group.SetLockedLeader | ( | Combatant | combatant | ) |
Sets a combatant as the (field) leader of the group and locks it as the leader. The locked (field) leader will remain the group's leader, even if the first member is changed.
combatant | The new, locked leader of the group, or null to reset/remove the locked leader. |
void ORKFramework.Group.SpawnGroup | ( | bool | onlyBattle, |
bool | onlyNonCreated | ||
) |
Spawns members of the group.
onlyBattle | true if only battle group members should be spawned. |
onlyNonCreated | true if only not yet spawned members should be spawned. |
|
virtual |
Switches combatants between this group and another group.
oldCombatant | The combatant from this group. If null , only the 'newCombatant' will be transfered to this group. |
newCombatant | The combatant from the other group. If null , only the 'oldCombatant' will be transfered to the other group. |
otherGroup | The other group. |