MessageMgr::AddSnapshotSender

Defined in: C4Messages.h

Registers a snapshot-sending object.

Prototype

void AddSnapshotSender(SnapshotSender *sender);

Parameters

sender A pointer to a SnapshotSender object.

Description

The AddSnapshotSender function registers a snapshot-sending object that is able to send snapshot messages whenever the Message Manager sends a snapshot to client machines in a multiplayer game. When the Message Manager sends a snapshot, the SnapshotSender::SendSnapshot function of the object specified by the sender parameter is called.

A snapshot-sending function is unregistered by either destroying the SnapshotSender object or calling the MessageMgr::RemoveSnapshotSender function.