CodeSubWars::CSWEvent Class Reference

#include <CSWEvent.h>

Inherited by CSWPyEvent.

Public Member Functions
std::shared_ptr< CSWIMessage >	getMessage ()

Static Public Member Functions
static PtrType	create (std::shared_ptr< CSWObject > pSender, std::shared_ptr< CSWObject > pReceiver, std::shared_ptr< CSWIMessage > pMessage, double fExpireTime)

Detailed Description

This class encapsulates an event. An event will delivered from sender to an receiver. It contains a message and a time to life.

Member Function Documentation

create()

CSWEvent::PtrType CodeSubWars::CSWEvent::create ( std::shared_ptr< CSWObject >  pSender, std::shared_ptr< CSWObject >  pReceiver, std::shared_ptr< CSWIMessage >  pMessage, double  fExpireTime  )

static

Creates a new Event.

Parameters

pSender	The sender (should always be self, because you never know other submarines)
pReceiver	The receiver (should always be self, because you never know other submarines)
pMessage	The message that should be delivered.
fExpireTime	The time to life in seconds. This is clamped to range [0, 20].

getMessage()

CSWIMessage::PtrType CodeSubWars::CSWEvent::getMessage

(

)

Returns the containing message.

Returns

The containing message.