SCR_AISendMessageBase Interface Reference

Base class for nodes sending message. More...

Inheritance diagram for SCR_AISendMessageBase:

Public Member Functions
override TStringArray	GetVariablesIn ()
override void	OnInit (AIAgent owner)
Public Member Functions inherited from AITaskScripted
void	OnEnter (AIAgent owner)
void	OnAbort (AIAgent owner, Node nodeCausingAbort)
ENodeResult	EOnTaskSimulate (AIAgent owner, float dt)
	Scripted nodes are suposed to return SUCCESS, FAIL or RUNNING state.
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)

Public Attributes
AIAgent	m_Receiver
string	m_string

Static Public Attributes
static const string	PORT_RECEIVER = "Receiver"
static const string	PORT_STRING = "StringIn"

Protected Member Functions
bool	InitSendMessageInputs (AIAgent owner)
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
AICommunicationComponent	m_Mailbox

Static Protected Attributes
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 bool	VisibleInPalette ()
static string	GetOnHoverDescription ()
static bool	CanReturnRunning ()

Detailed Description

Base class for nodes sending message.

Member Function Documentation

GetVariablesIn()

override TStringArray SCR_AISendMessageBase.GetVariablesIn

(

)

Implements Node.

Implemented in SCR_AISendMessage_HealFailed, SCR_AISendMessageGeneric, and SCR_AISendOrder.

InitSendMessageInputs()

bool SCR_AISendMessageBase.InitSendMessageInputs ( AIAgent owner )

protected

Implemented in SCR_AISendMessageGeneric.

OnInit()

override void SCR_AISendMessageBase.OnInit

(

AIAgent

owner

)

Implements AITaskScripted.

SendMessage()

ENodeResult SCR_AISendMessageBase.SendMessage ( AIAgent owner, AIMessage msg )

protected

Calls this in inherited nodes to send the message.

Member Data Documentation

m_Mailbox

AICommunicationComponent SCR_AISendMessageBase.m_Mailbox

protected

m_Receiver

AIAgent SCR_AISendMessageBase.m_Receiver

m_string

string SCR_AISendMessageBase.m_string

PORT_RECEIVER

const string SCR_AISendMessageBase.PORT_RECEIVER = "Receiver"

static

PORT_STRING

const string SCR_AISendMessageBase.PORT_STRING = "StringIn"

static

s_aVarsInBase

ref TStringArray SCR_AISendMessageBase.s_aVarsInBase

staticprotected

Initial value:

= {
        PORT_RECEIVER,
        PORT_STRING
    }

---

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

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