SCR_MailboxComponent Interface Reference

Inheritance diagram for SCR_MailboxComponent:

Public Member Functions
AIMessage	ReadMessage (bool remove)
AIOrder	ReadOrder (bool remove)
void	LogMessageStatistics (LogLevel logLevel=LogLevel.NORMAL)
bool	IsCommunicationEnabled ()
Public Member Functions inherited from AICommunicationComponent
proto AIMessage	CreateMessage (TypeName pClass)
proto external bool	RequestBroadcast (AIMessage pMessage, AIAgent receiver=null)
proto external AIOrder	GetOrder (int id)
proto external void	RemoveOrder (int id)
proto external int	GetOrderCount ()
proto external void	ClearOrders ()
proto external AIMessage	GetMessage (int id)
proto external void	RemoveMessage (int id)
proto external int	GetMessageCount ()
proto external void	ClearMessages ()
void	OnReceived (AIMessage pMessage)
	Called when message is received and added to receive queue.
void	OnFrame (IEntity owner, float timeSlice)
void	OnInit (IEntity owner)
Public Member Functions inherited from AIComponent
proto external AIAgent	GetAIAgent ()

Member Function Documentation

IsCommunicationEnabled()

bool SCR_MailboxComponent.IsCommunicationEnabled

(

)

Returns

LogMessageStatistics()

void SCR_MailboxComponent.LogMessageStatistics

(

LogLevel

logLevel = LogLevel::NORMAL

)

Parameters

[in]

logLevel

ReadMessage()

AIMessage SCR_MailboxComponent.ReadMessage

(

bool

remove

)

Parameters

[in]

remove

Returns

first message in the queue

ReadOrder()

AIOrder SCR_MailboxComponent.ReadOrder

(

bool

remove

)

Parameters

[in]

remove

Returns

first order in the order queue

---

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

• Game/AI/Components/SCR_MailboxComponent.c