SCR_AIGroupCombatModeSettingBase Interface Reference

Inheritance diagram for SCR_AIGroupCombatModeSettingBase:

Public Member Functions
override TypeName	GetCategorizationType ()
	Returns type which is used for identification of setting type.
EAIGroupCombatMode	GetCombatMode (EAIGroupCombatMode combatMode)
	combatMode - the combat mode wanted by AI now it is not used, since this setting propagates data downwards.
override void	ApplyEffects (SCR_AISettingsBaseComponent settingsComp)
	This is meant for settings which apply some permanent effect to AI (like setting skill), instead of some other system to look up current settings through GetCurrentSetting call.
Public Member Functions inherited from SCR_AIGroupSetting
override int	GetMaxActionCause ()
	When making own setting classes, DO NOT declare own constructor to pass data.
Public Member Functions inherited from SCR_AISettingBase
int	GetPriority ()
SCR_EAISettingOrigin	GetOrigin ()
SCR_AISettingBase	GetParentSetting ()
SCR_EAISettingFlags	GetFlags ()
bool	HasFlag (SCR_EAISettingFlags f)
SCR_AISettingBase	CreateCopy ()
	This method must make a deep copy of data describing this setting.
void	Internal_InitCopyFrom (SCR_AISettingBase from)
	Called right after this setting object was created as copy from elsewhere.
void	Internal_ConstructedAtProperty (SCR_EAISettingOrigin origin, SCR_EAISettingFlags flagsToSet)
	Must be called if the setting is part of some property.
void	Internal_SetFlag (SCR_EAISettingFlags flagsToSet)
void	OnAdded (SCR_AISettingsBaseComponent settingsComp)
	Called after the setting was added to SCR_AISettingsBaseComponent.
void	OnRemoved (SCR_AISettingsBaseComponent settingsComp)
	Called after the setting was removed from SCR_AISettingsBaseComponent.
string	GetDebugText ()

Additional Inherited Members
Static Public Attributes inherited from SCR_AISettingBase
const int	ACTION_CAUSE_NOT_SUPPORTED = int.MAX
Protected Member Functions inherited from SCR_AISettingBase
void	Init (SCR_EAISettingOrigin origin)
	Must be called from the factory method, if setting is created dynamically.
Protected Attributes inherited from SCR_AISettingBase
SCR_AISettingBase	m_ParentSetting
SCR_EAISettingOrigin	m_eOrigin
SCR_EAISettingFlags	m_eFlags
int	m_iPriority
Static Protected Attributes inherited from SCR_AISettingBase
static ref SCR_AISettingOriginPriorityTable	s_OriginPriorityTable = new SCR_AISettingOriginPriorityTable()

Member Function Documentation

ApplyEffects()

override void SCR_AIGroupCombatModeSettingBase.ApplyEffects

(

SCR_AISettingsBaseComponent

settingsComp

)

This is meant for settings which apply some permanent effect to AI (like setting skill), instead of some other system to look up current settings through GetCurrentSetting call.

The method is called when addition or removal of this or another setting causes this setting to be the one with highest priority among those of same categorization type. Keep in mind that now it might get called several times, and also we can't know if our setting unbecame highest priority. So here we should just propagate our values 'downwards' and do nothing else.

Implements SCR_AISettingBase.

GetCategorizationType()

override TypeName SCR_AIGroupCombatModeSettingBase.GetCategorizationType

(

)

Returns type which is used for identification of setting type.

There might be settings which inherit some base setting class and should be categorized according to that parent class. For instance, some specific classes of movement restriction can be categorized according to their base class of movement restriction.

Implements SCR_AISettingBase.

GetCombatMode()

EAIGroupCombatMode SCR_AIGroupCombatModeSettingBase.GetCombatMode

(

EAIGroupCombatMode

combatMode

)

combatMode - the combat mode wanted by AI now it is not used, since this setting propagates data downwards.

It is here for future compatibility.

Implemented in SCR_AIGroupCombatModeSetting.

---

The documentation for this interface was generated from the following file:

• Game/AI/Settings/SCR_AIGroupCombatModeSetting.c