Skip to content

Events

Ready Event

ready_event

ReadyEvent dataclass

Bases: Event, DataModel


              flowchart TD
              scurrypy.events.ready_event.ReadyEvent[ReadyEvent]
              scurrypy.events.base_event.Event[Event]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.events.base_event.Event --> scurrypy.events.ready_event.ReadyEvent
                                scurrypy.core.model.DataModel --> scurrypy.events.base_event.Event
                

                scurrypy.core.model.DataModel --> scurrypy.events.ready_event.ReadyEvent
                


              click scurrypy.events.ready_event.ReadyEvent href "" "scurrypy.events.ready_event.ReadyEvent"
              click scurrypy.events.base_event.Event href "" "scurrypy.events.base_event.Event"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Received when bot goes online.

dispatch_name = EventType.READY class-attribute instance-attribute

v: int instance-attribute

API version number.

user: UserModel instance-attribute

Information about the user.

guilds: list[ReadyGuildModel] instance-attribute

List of guilds bot is in.

session_id: str instance-attribute

Used for resuming connections.

resume_gateway_url: str instance-attribute

Gateway URL for resuming connections.

shard: list[int] instance-attribute

Shard information associated with this session.

application: ApplicationModel instance-attribute

Partial application object. Contains ID and flags.