Table of Contents

Networking

(NOTE) Event Bundle. Serialized event storage container.

Methods Properties Base Classes Derived Classes
AddEvent GameSession Object
Clear IsEmpty
Constructor
GetEvents
RemoveEvent

Properties


GameSession : gamesession

Returns the game session.

var GameSession : GameSession

IsEmpty : boolean

read-only

Returns true if the event bundle is empty (doesn't contain any events), else false.

var IsEmpty : Boolean

Methods


AddEvent : boolean

Adds the event to back of the event bundle. Returns true if successful, else false (an event of that type has already been added). |Name|Type|Description| |---|---|---| |event|event| |

function AddEvent(event : Event) : Boolean

Clear : Void

Clears the event bundle. |Name|Type|Description| |---|---|---|

function Clear()

EventBundle : Void

constructor

Constructors. |Name|Type|Description| |---|---|---|

function EventBundle()

EventBundle : Void

constructor

Constructors. |Name|Type|Description| |---|---|---| |event|event| |

function EventBundle(event : Event)

EventBundle : Void

constructor

Constructors. |Name|Type|Description| |---|---|---| |rhs|eventbundle| |

function EventBundle(rhs : EventBundle)

EventBundle : Void

constructor

Constructors. |Name|Type|Description| |---|---|---| |gameSession|gamesession| |

function EventBundle(gameSession : GameSession)

EventBundle : Void

constructor

Constructors. |Name|Type|Description| |---|---|---| |gameSession|gamesession| | |event|event| |

function EventBundle(gameSession : GameSession, event : Event)

GetEvents : eventrange

Returns all the events that have been added to the event bundle. |Name|Type|Description| |---|---|---|

function GetEvents() : EventRange

RemoveEvent : boolean

Removes the event specified from the event bundle. Returns true if successful, else false (an event of that type has already been added). |Name|Type|Description| |---|---|---| |event|event| |

function RemoveEvent(event : Event) : Boolean

RemoveEvent : boolean

Removes the event specified from the event bundle. Returns true if successful, else false (an event of that type has already been added). |Name|Type|Description| |---|---|---| ||string| |

function RemoveEvent( : String) : Boolean