VP_EVENT_WORLD_SETTING

From Virtual Paradise Wiki
Revision as of 22:47, 25 August 2013 by Roy Curtis (talk | contribs) (Created page with "{{sdk event page|world_setting|Received for each setting of a world upon connecting to it. |attributes= {{sdk attribute row|string|WORLD_SETTING_KEY |Setting key}} {{sdk ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Event set and handler snippet

vp_event_set(instance, VP_EVENT_WORLD_SETTING, event_world_setting);

void event_world_setting(VPInstance instance) { }

Received for each setting of a world upon connecting to it.

Attributes

Attribute Usage
VP_WORLD_SETTING_KEY Setting key
VP_WORLD_SETTING_VALUE Setting value

Behavior

Caveats

  • Because these settings are always sent upon entering a world, it is recommended to register for this event before calling vp_enter(). Otherwise, some or all settings may be missed.
  • There is currently no method to force a resend or watch for settings changes, except by re-entering the world

Examples

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