class MAGES::Recorder::ClientEnterEvent¶

Overview¶

An event created when a client enters the session. More…

class ClientEnterEvent: public MAGES::Recorder::ICapturedEvent
{
public:
    // properties

    double CreateTime;
    double CaptureTime;
    long CreateFrame;
    string ClientName;
    int ClientNumber;
    Interaction.AvatarData AvatarData;

    // methods

    ClientEnterEvent(
        long frameCount,
        string clientName,
        int clientNumber,
        AvatarData avatarData,
        double captureTime
    );
};

Inherited Members¶

public:
    // properties

    long CreateFrame;
    double CreateTime;
    double CaptureTime;

Detailed Documentation¶

An event created when a client enters the session.

This event will always be raised at least once even in single-player mode.

Properties¶

double CreateTime

Gets the estimated time (wall-clock time) when the event was created (NOT captured).

double CaptureTime

Gets the estimated time (wall-clock time) when the event was captured.

long CreateFrame

Gets the frame the event was captured on.

string ClientName

Gets the username of the client that entered the session.

int ClientNumber

Gets the client number of the client that entered the session.

Interaction.AvatarData AvatarData

Gets the avatar data.

Methods¶

ClientEnterEvent(
    long frameCount,
    string clientName,
    int clientNumber,
    AvatarData avatarData,
    double captureTime
)

Initializes a new instance of the ClientEnterEvent class.

Parameters: