VP EVENT WORLD LIST: Difference between revisions
Jump to navigation
Jump to search
Roy Curtis (talk | contribs) Created page with "{{sdk event page|world_list|This event is received: * For each world when the universe's world list is requested with {{sdk function|world_list}} * Whenever the client enters ..." |
Roy Curtis (talk | contribs) caveat |
||
| Line 12: | Line 12: | ||
* A user enters or leaves it | * A user enters or leaves it | ||
|caveats= | |caveats= | ||
* There is currently no way to tell if the server has sent all worlds after a {{sdk function|world_list}} call | |||
|examples= | |examples= | ||
|seealso= | |seealso= | ||
}} | }} | ||
Latest revision as of 01:29, 11 September 2013
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 | |
|---|---|---|
| VP_WORLD_NAME | World's name | |
| VP_WORLD_STATE | World's current state | |
| 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