SCR_AIGroupSettingsComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_AIGroupSettingsComponentClass

Functions
void	OnSettingAdded (notnull SCR_AISettingBase setting)
void	OnSettingRemoved (notnull SCR_AISettingBase setting)
override void	OnPostInit (IEntity owner)
	Editable Mine.
void	AddSettingToMembers (notnull SCR_AICharacterSetting setting)
void	RemoveSettingFromMembers (notnull SCR_AICharacterSetting setting)
	Iterates all group members and removes from them all settings which are linked to passed setting.
void	OnAgentAdded (AIAgent agent)
void	OnAgentRemoved (AIGroup group, AIAgent agent)
void	OnCurrentWaypointChanged (AIWaypoint _currentWp, AIWaypoint _prevWp)

Variables
SCR_AIGroupSettingsComponentClass	m_Group
ref array< ref SCR_AISettingBase >	m_aDefaultSettings

Function Documentation

AddSettingToMembers()

void AddSettingToMembers ( notnull SCR_AICharacterSetting setting )

protected

Creates copy and adds setting to all group members. createCopy - when true, a copy of the setting object will be created. When false, this component takes ownership of passed setting object. It also makes copy of passed object for each group member, but it's not related to createCopy parameter.

Definition at line 73 of file SCR_AIGroupSettingsComponent.c.

OnAgentRemoved()

void OnAgentRemoved ( AIGroup group, AIAgent agent )

protected

Definition at line 141 of file SCR_AIGroupSettingsComponent.c.

OnSettingAdded()

void OnSettingAdded ( notnull SCR_AISettingBase setting )

protected

Definition at line 30 of file SCR_AIGroupSettingsComponent.c.

OnSettingRemoved()

void OnSettingRemoved ( notnull SCR_AISettingBase setting )

protected

Definition at line 38 of file SCR_AIGroupSettingsComponent.c.

RemoveSettingFromMembers()

void RemoveSettingFromMembers ( notnull SCR_AICharacterSetting setting )

protected

Iterates all group members and removes from them all settings which are linked to passed setting.

Definition at line 103 of file SCR_AIGroupSettingsComponent.c.

Variable Documentation

m_aDefaultSettings

ref array<ref SCR_AISettingBase> m_aDefaultSettings

protected

Definition at line 24 of file SCR_AIGroupSettingsComponent.c.

m_Group

SCR_AIGroupSettingsComponentClass m_Group

SCR_AIGroupSettingsComponent can store settings intended both for group itself and for group members.

Settings inheriting from SCR_AIGroupSetting are treated as usual. They are meant to be used by group.

Settings inheriting from SCR_AICharacterSetting are stored here but are meant for group members. They are automatically distributed to group members when added. When a new member joins the group, group's character settings are passed to the new member. When a member leaves the group, settings added to it from this group are removed from it.

To add settings, call AddSetting.