PixelCrushers.MessageEvents Class Reference

Provides a in-editor way to listen for messages and invoke events when they occur, and to send a message on demand. More...

Inheritance diagram for PixelCrushers.MessageEvents:
Collaboration diagram for PixelCrushers.MessageEvents:

Classes

class  MessageEvent
 
class  MessageToSend
 

Public Member Functions

virtual void OnMessage (MessageArgs messageArgs)
 Handles a message that the message handler is listening for.
 
virtual void SendToMessageSystem (int index)
 

Protected Member Functions

virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual bool IsParticipantOk (GameObject requiredParticipant, object actualParticipant)
 

Properties

MessageEvent[] messagesToListenFor [get, set]
 Listen for these messages and invoke an event when each message occurs.
 
MessageToSend[] messagesToSend [get, set]
 Send this message on demand by calling SendToMessageSystem().
 

Detailed Description

Provides a in-editor way to listen for messages and invoke events when they occur, and to send a message on demand.

Member Function Documentation

◆ IsParticipantOk()

virtual bool PixelCrushers.MessageEvents.IsParticipantOk ( GameObject  requiredParticipant,
object  actualParticipant 
)
inlineprotectedvirtual

◆ OnDisable()

virtual void PixelCrushers.MessageEvents.OnDisable ( )
inlineprotectedvirtual

◆ OnEnable()

virtual void PixelCrushers.MessageEvents.OnEnable ( )
inlineprotectedvirtual

◆ OnMessage()

virtual void PixelCrushers.MessageEvents.OnMessage ( MessageArgs  messageArgs)
inlinevirtual

Handles a message that the message handler is listening for.

Parameters
messageArgsThe message that was sent to the MessageSystem.

Implements PixelCrushers.IMessageHandler.

◆ SendToMessageSystem()

virtual void PixelCrushers.MessageEvents.SendToMessageSystem ( int  index)
inlinevirtual

Property Documentation

◆ messagesToListenFor

MessageEvent [] PixelCrushers.MessageEvents.messagesToListenFor
getset

Listen for these messages and invoke an event when each message occurs.

◆ messagesToSend

MessageToSend [] PixelCrushers.MessageEvents.messagesToSend
getset

Send this message on demand by calling SendToMessageSystem().


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