SCR_AIGroupCharactersMovementSpeedSettingBase Interface Reference

Group-level setting of movement speed of its characters. More...

Inheritance diagram for SCR_AIGroupCharactersMovementSpeedSettingBase:

Public Member Functions
override TypeName	GetCategorizationType ()
	Returns type which is used for identification of setting type.
EMovementType	GetSpeed (EMovementType desiredSpeed)
	desiredSpeed - speed wanted by AI
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.
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.
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()

Detailed Description

Group-level setting of movement speed of its characters.

Used by Move waypoint. It is meant for AIGroupMovementComponent.SetGroupCharactersWantedMovementType

Member Function Documentation

GetCategorizationType()

override TypeName SCR_AIGroupCharactersMovementSpeedSettingBase.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.

GetSpeed()

EMovementType SCR_AIGroupCharactersMovementSpeedSettingBase.GetSpeed

(

EMovementType

desiredSpeed

)

desiredSpeed - speed wanted by AI

Implemented in SCR_AIGroupCharactersMovementSpeedSetting.

---

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

• Game/AI/Settings/SCR_AIGroupCharactersMovementSpeedSetting.c