Base event parameter struct.
More...
#include "dispatcher.h"
Inherited by dpp::automod_rule_create_t, dpp::automod_rule_delete_t, dpp::automod_rule_execute_t, dpp::automod_rule_update_t, dpp::channel_create_t, dpp::channel_delete_t, dpp::channel_pins_update_t, dpp::channel_update_t, dpp::entitlement_create_t, dpp::entitlement_delete_t, dpp::entitlement_update_t, dpp::guild_audit_log_entry_create_t, dpp::guild_ban_add_t, dpp::guild_ban_remove_t, dpp::guild_create_t, dpp::guild_delete_t, dpp::guild_emojis_update_t, dpp::guild_integrations_update_t, dpp::guild_join_request_delete_t, dpp::guild_member_add_t, dpp::guild_member_remove_t, dpp::guild_member_update_t, dpp::guild_members_chunk_t, dpp::guild_role_create_t, dpp::guild_role_delete_t, dpp::guild_role_update_t, dpp::guild_scheduled_event_create_t, dpp::guild_scheduled_event_delete_t, dpp::guild_scheduled_event_update_t, dpp::guild_scheduled_event_user_add_t, dpp::guild_scheduled_event_user_remove_t, dpp::guild_stickers_update_t, dpp::guild_update_t, dpp::integration_create_t, dpp::integration_delete_t, dpp::integration_update_t, dpp::interaction_create_t, dpp::invite_create_t, dpp::invite_delete_t, dpp::log_t, dpp::message_create_t, dpp::message_delete_bulk_t, dpp::message_delete_t, dpp::message_poll_vote_add_t, dpp::message_poll_vote_remove_t, dpp::message_reaction_add_t, dpp::message_reaction_remove_all_t, dpp::message_reaction_remove_emoji_t, dpp::message_reaction_remove_t, dpp::message_update_t, dpp::presence_update_t, dpp::ready_t, dpp::resumed_t, dpp::stage_instance_create_t, dpp::stage_instance_delete_t, dpp::stage_instance_update_t, dpp::thread_create_t, dpp::thread_delete_t, dpp::thread_list_sync_t, dpp::thread_member_update_t, dpp::thread_members_update_t, dpp::thread_update_t, dpp::typing_start_t, dpp::user_update_t, dpp::voice_buffer_send_t, dpp::voice_client_disconnect_t, dpp::voice_client_speaking_t, dpp::voice_ready_t, dpp::voice_receive_t, dpp::voice_server_update_t, dpp::voice_state_update_t, dpp::voice_track_marker_t, dpp::voice_user_talking_t, and dpp::webhooks_update_t.
Base event parameter struct.
Each event you receive from the library will have its parameter derived from this class. The class contains the raw event data, and a pointer to the current shard's dpp::discord_client object. You can also use this object to cancel the current event, meaning that any listeners after yours do not get notified of the current event if you call it.
◆ event_dispatch_t() [1/5]
| dpp::event_dispatch_t::event_dispatch_t |
( |
| ) |
|
|
default |
◆ event_dispatch_t() [2/5]
◆ event_dispatch_t() [3/5]
◆ event_dispatch_t() [4/5]
| dpp::event_dispatch_t::event_dispatch_t |
( |
discord_client * |
client, |
|
|
const std::string & |
raw |
|
) |
| |
Construct a new event_dispatch_t object.
- Parameters
-
| client | The shard the event originated on. May be a nullptr, e.g. for voice events |
| raw | Raw event data as JSON or ETF |
◆ event_dispatch_t() [5/5]
| dpp::event_dispatch_t::event_dispatch_t |
( |
discord_client * |
client, |
|
|
std::string && |
raw |
|
) |
| |
◆ ~event_dispatch_t()
| virtual dpp::event_dispatch_t::~event_dispatch_t |
( |
| ) |
|
|
virtualdefault |
Destroy an event_dispatch_t object Protected because this object is to be derived from.
◆ cancel_event() [1/2]
Cancels the event in progress.
Any other attached lambdas for this event after this one are not called.
- Warning
- This will modify the event object in a non-thread-safe manner.
- Returns
- const event_dispatch_t& reference to self for chaining
◆ cancel_event() [2/2]
Cancels the event in progress.
Any other attached lambdas for this event after this one are not called.
- Warning
- This will modify the event object in a non-thread-safe manner.
- Returns
- const event_dispatch_t& reference to self for chaining
◆ is_cancelled()
| bool dpp::event_dispatch_t::is_cancelled |
( |
| ) |
const |
Returns true if the event is cancelled.
Note that event cancellation is a thread local state, and not stored in the object (because object which can be cancelled is const during the event, and cannot itself contain the changeable state).
- Returns
- true if the event is cancelled
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ cancelled
| bool dpp::event_dispatch_t::cancelled = false |
|
mutable |
◆ from
◆ raw_event
| std::string dpp::event_dispatch_t::raw_event = {} |
Raw event data.
If you are using json on your websocket, this will contain json, and if you are using ETF as your websocket protocol, it will contain raw ETF data.
The documentation for this struct was generated from the following files:
1.8.17