ORK Framework  3.10.0
API Documentation
GamingIsLove.ORKFramework.GroupAccessHandler Class Reference

Public Member Functions

virtual void Join (Group group, Combatant combatant, bool showNotification, bool showConsole)
 Lets a combatant join a group. More...
 
virtual void Leave (Group group, Combatant combatant, bool destroyPrefab, bool showNotification, bool showConsole)
 Lets a combatant leave a group. The combatant will be added to the group's inactive members. More...
 
virtual void Remove (Group group, Combatant combatant, bool setGroup, bool destroyPrefab, bool showNotification, bool showConsole)
 Removes a combatant from a group completely (i.e. no inactive member). More...
 
virtual void SwitchGroup (Group group, Combatant oldCombatant, Combatant newCombatant, Group otherGroup)
 Switches combatants between 2 groups. More...
 
virtual void ChangeMemberSort (Group group, Combatant combatant, Combatant otherCombatant)
 Moves a combatant in front of another combatant in a group (members). Both combatants must be members of the group. More...
 
virtual void SetBattleGroup (Group group, List< Combatant > list, bool enterBattle)
 Sets the battle group of a group. More...
 
virtual void JoinBattle (Group group, Combatant combatant)
 Lets a combatant join the battle group of a group. More...
 
virtual void ChangeBattle (Group group, 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...
 
virtual void LeaveBattle (Group group, Combatant combatant, bool destroyPrefab)
 Lets a combatant leave the battle group of a group. More...
 
virtual void ChangeBattleSort (Group group, Combatant combatant, Combatant otherCombatant)
 Moves a combatant in front of another combatant in the battle group of a group. Both combatants must be members of the battle group. More...
 
virtual void JoinBattleReserve (Group group, Combatant combatant)
 Lets a combatant join the battle reserve (only for player groups). More...
 
virtual void LeaveBattleReserve (Group group, Combatant combatant, bool destroyPrefab)
 Lets a combatant leave the battle reserve (only for player groups). More...
 
virtual void ChangeBattleReserve (Group group, Combatant oldCombatant, Combatant newCombatant)
 Changes a member of the battle reserve with another combatant currently not in the battle reserve (only for player groups). Both combatants must be members of the group. More...
 
void SetLockedLeader (Group group, 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...
 
virtual void SetLeader (Group group, 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...
 
virtual void Regenerate (Group group, MenuCombatantScope scope, bool revive)
 Sets the 'Consumable' type status values of members of a group to their maximum value. More...
 
virtual void LockBattleMember (Group group, Combatant combatant, bool doLock)
 Locks or unlocks a member of the battle group of a group. A locked battle group member can't be removed. More...
 
virtual void HideMember (Group group, Combatant combatant, bool doHide)
 Hides or unhides a member of a group. A hidden combatant isn't visible in any UI (e.g. menus). More...
 
virtual void SpawnGroup (Group group, bool onlyBattle, bool onlyNonCreated)
 Spawns members of a group. More...
 
virtual void DestroyInstances (Group group, bool includeLeader)
 Destroys all spawned members of a group. More...
 
virtual void EnableInstances (Group group, bool includeLeader, bool enable)
 Destroys all spawned members of a group. More...
 

Member Function Documentation

◆ ChangeBattle()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.ChangeBattle ( Group  group,
Combatant  oldCombatant,
Combatant  newCombatant 
)
virtual

Changes a member of the battle group with another combatant currently not in the battle group. Both combatants must be members of the group.

Parameters
groupThe group that will be used.
oldCombatantThe combatant currently in the battle group.
newCombatantThe combatant replacing the old combatant.

◆ ChangeBattleReserve()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.ChangeBattleReserve ( Group  group,
Combatant  oldCombatant,
Combatant  newCombatant 
)
virtual

Changes a member of the battle reserve with another combatant currently not in the battle reserve (only for player groups). Both combatants must be members of the group.

Parameters
groupThe group that will be used.
oldCombatantThe combatant currently in the battle reserve.
newCombatantThe combatant replacing the old combatant.

◆ ChangeBattleSort()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.ChangeBattleSort ( Group  group,
Combatant  combatant,
Combatant  otherCombatant 
)
virtual

Moves a combatant in front of another combatant in the battle group of a group. Both combatants must be members of the battle group.

Parameters
groupThe group that will be used.
combatantThe first combatant.
otherCombatantThe second combatant.

◆ ChangeMemberSort()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.ChangeMemberSort ( Group  group,
Combatant  combatant,
Combatant  otherCombatant 
)
virtual

Moves a combatant in front of another combatant in a group (members). Both combatants must be members of the group.

Parameters
groupThe group that will be used.
combatantThe first combatant.
otherCombatantThe second combatant.

◆ DestroyInstances()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.DestroyInstances ( Group  group,
bool  includeLeader 
)
virtual

Destroys all spawned members of a group.

Parameters
groupThe group that will be used.
includeLeadertrue if the group's leader should also be destroyed.

◆ EnableInstances()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.EnableInstances ( Group  group,
bool  includeLeader,
bool  enable 
)
virtual

Destroys all spawned members of a group.

Parameters
groupThe group that will be used.
includeLeadertrue if the group's leader should also be destroyed.
enabletrue to enable, false to disable the game object.

◆ HideMember()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.HideMember ( Group  group,
Combatant  combatant,
bool  doHide 
)
virtual

Hides or unhides a member of a group. A hidden combatant isn't visible in any UI (e.g. menus).

Parameters
groupThe group that will be used.
combatantThe combatant that will be hidden/unhidden
doHidetrue if the combatant will be hidden.

◆ Join()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.Join ( Group  group,
Combatant  combatant,
bool  showNotification,
bool  showConsole 
)
virtual

Lets a combatant join a group.

Parameters
groupThe group that will be used.
combatantThe combatant that will join.
showNotificationtrue if a notification should be displayed (player groups only).
showConsoletrue if a console line should be added (player groups only).

◆ JoinBattle()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.JoinBattle ( Group  group,
Combatant  combatant 
)
virtual

Lets a combatant join the battle group of a group.

Parameters
groupThe group that will be used.
combatantThe combatant that will join the battle group.

◆ JoinBattleReserve()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.JoinBattleReserve ( Group  group,
Combatant  combatant 
)
virtual

Lets a combatant join the battle reserve (only for player groups).

Parameters
groupThe group that will be used.
combatantThe combatant that will join the battle reserve.

◆ Leave()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.Leave ( Group  group,
Combatant  combatant,
bool  destroyPrefab,
bool  showNotification,
bool  showConsole 
)
virtual

Lets a combatant leave a group. The combatant will be added to the group's inactive members.

Parameters
groupThe group that will be used.
combatantThe combatant that will leave.
destroyPrefabtrue if the combatant's spawned prefab should be destroyed
showNotificationtrue if a notification should be displayed (player groups only).
showConsoletrue if a console line should be added (player groups only).

◆ LeaveBattle()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.LeaveBattle ( Group  group,
Combatant  combatant,
bool  destroyPrefab 
)
virtual

Lets a combatant leave the battle group of a group.

Parameters
groupThe group that will be used.
combatantThe combatant that will leave the battle group.
destroyPrefabtrue if the combatant's spawned prefab should be destroyed.

◆ LeaveBattleReserve()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.LeaveBattleReserve ( Group  group,
Combatant  combatant,
bool  destroyPrefab 
)
virtual

Lets a combatant leave the battle reserve (only for player groups).

Parameters
groupThe group that will be used.
combatantThe combatant that will leave the battle reserve.
destroyPrefabtrue if the combatant's spawned prefab should be destroyed.

◆ LockBattleMember()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.LockBattleMember ( Group  group,
Combatant  combatant,
bool  doLock 
)
virtual

Locks or unlocks a member of the battle group of a group. A locked battle group member can't be removed.

Parameters
groupThe group that will be used.
combatantThe combatant that will be locked/unlocked
doLocktrue if the combatant will be locked.

◆ Regenerate()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.Regenerate ( Group  group,
MenuCombatantScope  scope,
bool  revive 
)
virtual

Sets the 'Consumable' type status values of members of a group to their maximum value.

Parameters
groupThe group that will be used.
scopeThe scope of group members to regenerate.
revivetrue if dead combatants should be revived.

◆ Remove()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.Remove ( Group  group,
Combatant  combatant,
bool  setGroup,
bool  destroyPrefab,
bool  showNotification,
bool  showConsole 
)
virtual

Removes a combatant from a group completely (i.e. no inactive member).

Parameters
groupThe group that will be used.
combatantThe combatant that will be removed.
setGrouptrue if the combatant's group should be cleared.
destroyPrefabtrue if the combatant's spawned prefab should be destroyed
showNotificationtrue if a notification should be displayed (player groups only).
showConsoletrue if a console line should be added (player groups only).

◆ SetBattleGroup()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.SetBattleGroup ( Group  group,
List< Combatant list,
bool  enterBattle 
)
virtual

Sets the battle group of a group.

Parameters
groupThe group that will be used.
listThe combatants that will be used as battle group.
enterBattleThe combatants will enter the running battle.

◆ SetLeader()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.SetLeader ( Group  group,
Combatant  newLeader,
bool  moveOldBack 
)
virtual

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.

Parameters
groupThe group that will be used.
newLeaderThe new leader combatant.
moveOldBacktrue if the old leader should be moved to the back of the group.

◆ SetLockedLeader()

void GamingIsLove.ORKFramework.GroupAccessHandler.SetLockedLeader ( Group  group,
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.

Parameters
groupThe group that will be used.
combatantThe new, locked leader of the group, or null to reset/remove the locked leader.

◆ SpawnGroup()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.SpawnGroup ( Group  group,
bool  onlyBattle,
bool  onlyNonCreated 
)
virtual

Spawns members of a group.

Parameters
groupThe group that will be used.
onlyBattletrue if only battle group members should be spawned.
onlyNonCreatedtrue if only not yet spawned members should be spawned.

◆ SwitchGroup()

virtual void GamingIsLove.ORKFramework.GroupAccessHandler.SwitchGroup ( Group  group,
Combatant  oldCombatant,
Combatant  newCombatant,
Group  otherGroup 
)
virtual

Switches combatants between 2 groups.

Parameters
groupThe 1st group.
oldCombatantThe combatant from the 1st group. If null, only the 'newCombatant' will be transfered to the 1st group.
newCombatantThe combatant from the 2nd group. If null, only the 'oldCombatant' will be transfered to the 2nd group.
otherGroupThe 2nd group.