rc_runtime_get_richpresence

Gets a brief description of what the player is currently doing.

Syntax

int rc_runtime_get_richpresence(
    rc_runtime_t* runtime,
    char* buffer,
    unsigned buffersize,
    rc_peek_t peek,
    void* peek_ud,
    lua_State* L
);

Parameters

runtime

Pointer to the rc_runtime_t state.

buffer

Pointer to a buffer where the current rich presence display string should be written.

buffersize

Maximum number of characters (including null terminator) that buffer can hold.

peek

Pointer to a function that will be called to read memory from the emulator.

ud

Caller provided data to pass to the peek function.

L (NOT USED)

Return value

Number of characters written to buffer.

Remarks

Minimum version: 10.0.0

A simplified version of this function was available in 9.0.0 that just returned the value calculated every 60 frames. The function was modified in 10.0.0 to only evaluate the rich presence when requested.

See also

rc_runtime_activate_richpresence

rc_runtime_do_frame