VP_EVENT_WORLD_LIST

Event set and handler snippet

vp_event_set(instance, VP_EVENT_WORLD_LIST, event_world_list);

void event_world_list(VPInstance instance) { }

This event is received:

• For each world when the universe's world list is requested with vp_world_list()
• Whenever the client enters a world
• Whenever a world changes state

Attributes

Attribute	Usage
string VP_WORLD_NAME	World's name
int VP_WORLD_STATE	World's current state
int VP_WORLD_USERS	World's current user count

Behavior

A world is considered to have changed state when:

• It goes online or offline
• A user enters or leaves it

Caveats

• There is currently no way to tell if the server has sent all worlds after a vp_world_list() call

Examples

This event has no usage examples; please add at least one to this page