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, 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

group	The group that will be used.
oldCombatant	The combatant currently in the battle group.
newCombatant	The combatant replacing the old combatant.

◆ ChangeBattleReserve()

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

group	The group that will be used.
oldCombatant	The combatant currently in the battle reserve.
newCombatant	The 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

group	The group that will be used.
combatant	The first combatant.
otherCombatant	The 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

group	The group that will be used.
combatant	The first combatant.
otherCombatant	The second combatant.

◆ DestroyInstances()

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

virtual

Destroys all spawned members of a group.

Parameters

group	The group that will be used.
includeLeader	`true` 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

group	The group that will be used.
combatant	The combatant that will be hidden/unhidden
doHide	`true` 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

group	The group that will be used.
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).

◆ JoinBattle()

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

virtual

Lets a combatant join the battle group of a group.

Parameters

group	The group that will be used.
combatant	The combatant that will join the battle group.

◆ JoinBattleReserve()

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

virtual

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

Parameters

group	The group that will be used.
combatant	The combatant that will join the battle reserve.

◆ 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

group	The group that will be used.
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).

◆ LeaveBattle()

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

virtual

Lets a combatant leave the battle group of a group.

Parameters

group	The group that will be used.
combatant	The combatant that will leave the battle group.
destroyPrefab	`true` if the combatant's spawned prefab should be destroyed.

◆ LeaveBattleReserve()

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

virtual

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

Parameters

group	The group that will be used.
combatant	The combatant that will leave the battle reserve.
destroyPrefab	`true` 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

group	The group that will be used.
combatant	The combatant that will be locked/unlocked
doLock	`true` 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

group	The group that will be used.
onlyBattle	`true` if only members of the battle group should be used.
revive	`true` 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

group	The group that will be used.
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).

◆ SetBattleGroup()

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

virtual

Sets the battle group of a group.

Parameters

group	The group that will be used.
list	The combatants that will be used as battle group.
enterBattle	The combatants will enter the running battle.

◆ SetLeader()

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

group	The group that will be used.
newLeader	The new leader combatant.
moveOldBack	`true` if the old leader should be moved to the back of the group.

◆ SetLockedLeader()

void 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

group	The group that will be used.
combatant	The new, locked leader of the group, or `null` to reset/remove the locked leader.

◆ SpawnGroup()

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

virtual

Spawns members of a group.

Parameters

group	The group that will be used.
onlyBattle	`true` if only battle group members should be spawned.
onlyNonCreated	`true` if only not yet spawned members should be spawned.

◆ SwitchGroup()

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

virtual

Switches combatants between 2 groups.

Parameters

group	The 1st group.
oldCombatant	The combatant from the 1st group. If `null`, only the 'newCombatant' will be transfered to the 1st group.
newCombatant	The combatant from the 2nd group. If `null`, only the 'oldCombatant' will be transfered to the 2nd group.
otherGroup	The 2nd group.

Public Member Functions

Member Function Documentation

◆ ChangeBattle()

◆ ChangeBattleReserve()

◆ ChangeBattleSort()

◆ ChangeMemberSort()

◆ DestroyInstances()

◆ HideMember()

◆ Join()

◆ JoinBattle()

◆ JoinBattleReserve()

◆ Leave()

◆ LeaveBattle()

◆ LeaveBattleReserve()

◆ LockBattleMember()

◆ Regenerate()

◆ Remove()

◆ SetBattleGroup()

◆ SetLeader()

◆ SetLockedLeader()

◆ SpawnGroup()

◆ SwitchGroup()