SCR_AISendMessageGeneric Interface Reference

Class for generic nodes with extra input ports which send messages. More...

Inheritance diagram for SCR_AISendMessageGeneric:

Public Member Functions
override TStringArray	GetVariablesIn ()
override ENodeResult	EOnTaskSimulate (AIAgent owner, float dt)
	Scripted nodes are suposed to return SUCCESS, FAIL or RUNNING state.
Public Member Functions inherited from SCR_AISendMessageBase
override void	OnInit (AIAgent owner)
Public Member Functions inherited from AITaskScripted
void	OnEnter (AIAgent owner)
void	OnAbort (AIAgent owner, Node nodeCausingAbort)
Public Member Functions inherited from Node
proto external int	GetNodeID ()
proto external TypeName	GetVariableType (bool inputPort, string name)
proto bool	GetVariableIn (string name, out void val)
proto void	SetVariableOut (string name, void val)
proto void	ClearVariable (string name)
proto void	GetCallstackStr (out string val)
proto void	GetParentTreeName (out string val)

Static Public Member Functions
static override bool	VisibleInPalette ()

Public Attributes
int	m_integer
vector	m_vector
bool	m_bool
Public Attributes inherited from SCR_AISendMessageBase
AIAgent	m_Receiver
string	m_string

Static Public Attributes
static const string	PORT_ENTITY = "EntityIn"
static const string	PORT_INTEGER = "IntegerIn"
static const string	PORT_VECTOR = "VectorIn"
static const string	PORT_BOOL = "BoolIn"
static const string	PORT_FLOAT = "FloatIn"
static const string	PORT_TYPENAME = "TypenameIn"
static const string	PORT_SMARTACTION = "SmartActionComponent"
static const string	PORT_PRIORITY_LEVEL = "PriorityLevel"
Static Public Attributes inherited from SCR_AISendMessageBase
static const string	PORT_RECEIVER = "Receiver"
static const string	PORT_STRING = "StringIn"

Protected Member Functions
override bool	InitSendMessageInputs (AIAgent owner)
Protected Member Functions inherited from SCR_AISendMessageBase
ENodeResult	SendMessage (AIAgent owner, AIMessage msg)
	Calls this in inherited nodes to send the message.
Protected Member Functions inherited from AITaskScripted
string	GetNodeMiddleText ()
Protected Member Functions inherited from Node
TStringArray	GetVariablesOut ()

Protected Attributes
SCR_AIWorld	m_aiWorld
Protected Attributes inherited from SCR_AISendMessageBase
AICommunicationComponent	m_Mailbox

Static Protected Attributes
static ref TStringArray	s_aVarsIn
Static Protected Attributes inherited from SCR_AISendMessageBase
static ref TStringArray	s_aVarsInBase
Static Protected Attributes inherited from Node
static ref TStringArray	m_aEmptyVars = {}

Additional Inherited Members
Static Protected Member Functions inherited from Node
static string	GetOnHoverDescription ()
static bool	CanReturnRunning ()

Detailed Description

Class for generic nodes with extra input ports which send messages.

Member Function Documentation

EOnTaskSimulate()

override ENodeResult SCR_AISendMessageGeneric.EOnTaskSimulate	(	AIAgent	owner,
		float	dt )

Scripted nodes are suposed to return SUCCESS, FAIL or RUNNING state.

Implements AITaskScripted.

Implemented in SCR_AISendGoalMessage, and SCR_AISendInfoMessage.

GetVariablesIn()

override TStringArray SCR_AISendMessageGeneric.GetVariablesIn

(

)

Implements SCR_AISendMessageBase.

Implemented in SCR_AISendOrder.

InitSendMessageInputs()

override bool SCR_AISendMessageGeneric.InitSendMessageInputs ( AIAgent owner )

protected

Implements SCR_AISendMessageBase.

VisibleInPalette()

static override bool SCR_AISendMessageGeneric.VisibleInPalette ( )

static

Implements Node.

Member Data Documentation

m_aiWorld

SCR_AIWorld SCR_AISendMessageGeneric.m_aiWorld

protected

m_bool

bool SCR_AISendMessageGeneric.m_bool

m_integer

int SCR_AISendMessageGeneric.m_integer

m_vector

vector SCR_AISendMessageGeneric.m_vector

PORT_BOOL

const string SCR_AISendMessageGeneric.PORT_BOOL = "BoolIn"

static

PORT_ENTITY

const string SCR_AISendMessageGeneric.PORT_ENTITY = "EntityIn"

static

PORT_FLOAT

const string SCR_AISendMessageGeneric.PORT_FLOAT = "FloatIn"

static

PORT_INTEGER

const string SCR_AISendMessageGeneric.PORT_INTEGER = "IntegerIn"

static

PORT_PRIORITY_LEVEL

const string SCR_AISendMessageGeneric.PORT_PRIORITY_LEVEL = "PriorityLevel"

static

PORT_SMARTACTION

const string SCR_AISendMessageGeneric.PORT_SMARTACTION = "SmartActionComponent"

static

PORT_TYPENAME

const string SCR_AISendMessageGeneric.PORT_TYPENAME = "TypenameIn"

static

PORT_VECTOR

const string SCR_AISendMessageGeneric.PORT_VECTOR = "VectorIn"

static

s_aVarsIn

ref TStringArray SCR_AISendMessageGeneric.s_aVarsIn

staticprotected

Initial value:

= {
        PORT_RECEIVER,
        PORT_STRING,
        PORT_ENTITY,
        PORT_INTEGER,
        PORT_VECTOR,
        PORT_BOOL,
        PORT_FLOAT,
        PORT_TYPENAME,
        PORT_PRIORITY_LEVEL
    }

---

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

• Game/AI/ScriptedNodes/Messages/SCR_AISendMessage.c