ORK Framework  2.27.1
API Documentation
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 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)
 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 Regenerate (Group group, bool onlyBattle, 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...
 

Member Function Documentation

◆ ChangeBattle()

virtual void 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.

◆ ChangeBattleSort()

virtual void 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 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 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.

◆ HideMember()

virtual void 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 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 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.

◆ Leave()

virtual void 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 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.

◆ LockBattleMember()

virtual void 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 ORKFramework.GroupAccessHandler.Regenerate ( Group  group,
bool  onlyBattle,
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.
onlyBattletrue if only members of the battle group should be used.
revivetrue if dead combatants should be revived.

◆ Remove()

virtual void 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 ORKFramework.GroupAccessHandler.SetBattleGroup ( Group  group,
List< Combatant list 
)
virtual

Sets the battle group of a group.

Parameters
groupThe group that will be used.
listThe combatants that will be used as battle group.

◆ SpawnGroup()

virtual void 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.