QcControlContext Class

Member Function Documentation

std::optional<QcControlActiveCommand> &QcControlContext::active()

Returns the command that runs on the following ticks; nothing while none runs.

void QcControlContext::appendChat(const QString &text)

Keeps the received chat line text for the running request and the chat history.

void QcControlContext::begin(QcControlActiveCommand command)

Runs command on the following ticks until it completes.

const QStringList &QcControlContext::chatHistory() const

Returns every chat line received, oldest first, also while no request ran (at most chatHistoryLimit).

void QcControlContext::clearChatHistory()

Forgets the chat history.

void QcControlContext::clearChatLog()

Forgets the chat lines of the running request.

void QcControlContext::fail(const QJsonObject &request, const QString &message)

Writes a failure of request with the error message (with the request's id and command).

int QcControlContext::failedRequests() const

Returns the number of requests that failed.

void QcControlContext::finish(const QJsonObject &request, QJsonObject response)

Writes response to request as a success (with the request's id).

bool QcControlContext::isActive() const

Returns whether a command runs on the following ticks.

QcControlReports QcControlContext::reports() const

Returns the JSON views of the session; only valid while a session is set.

QcClientSession *QcControlContext::session() const

Returns the session the commands act on; null while there is none.

See also setSession().

void QcControlContext::setActiveError(const QString &error)

Sets error, set by a step that completes unsuccessfully; the active request then fails with it.

void QcControlContext::setSession(QcClientSession *session)

Switches to session.

See also session().

QString QcControlContext::takeActiveError()

Returns the error a step set and forgets it; empty for none.

void QcControlContext::waitTicks(const QJsonObject &request, quint64 startTick, int ticks, std::function<QJsonObject ()> result = {})

Completes request ticks client ticks after startTick with result (the player status when unset).