SharedEventType ( )

Parameters

None.

Description

Returns the type of the current event.

It describes the event taken by the last RecvSharedEvent that returned True, until the next call. Compare it with the built-in constants:

SHARED_EVENT_PLAYER_JOINED (1) - a player joined
SHARED_EVENT_PLAYER_LEFT (2) - a player left
SHARED_EVENT_ENTITY_SPAWNED (3) - a shared entity appeared
SHARED_EVENT_ENTITY_DESPAWNED (4) - a shared entity was removed
SHARED_EVENT_SESSION_LOST (5) - the connection was lost
SHARED_EVENT_REJECTED (6) - setup or a request was refused
SHARED_EVENT_HOST_MIGRATING (7) - the host is changing
SHARED_EVENT_HOST_CHANGED (8) - the host has changed, or stayed
SHARED_EVENT_PLAYER_AWAY (9) - a server room's player lost their connection
SHARED_EVENT_PLAYER_RETURNED (10) - a server room's player came back

Returns 0 when there is no current event.

For the full story - services, hosting, sharing and host migration - see the Shared World guide and its complete Shared_World_Playground.bb sample.


See also: RecvSharedEvent, SharedEventPlayer, SharedEventEntity, SharedEventData, Constants.

Index