VP EVENT WORLD SETTING

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
string VP_WORLD_SETTING_KEY	Setting key
string VP_WORLD_SETTING_VALUE	Setting value

Behavior

• When all settings have been sent, VP_EVENT_WORLD_SETTINGS_CHANGED is fired
• List of keys:

Key	Range	Usage
int "allow_debug_menu"	0 or 1	Enable/disable use of the debug menu.
int "allow_flying"	0 or 1	Enable/disable the ability for users to fly.
int "allow_passthrough"	0 or 1	Enable/disable the ability for users to pass through objects and terrain.
int "avatar<number>"	n/a	Not used anymore.
string "avatars_file"		Name of file containing avatar configuration.
??? "avatars_update_interval"		???
string "entry_point"		World entry point.
float "farplane"		???
float "fog_begin"		Distance at which fog should begin.
float "fog_color"	rrggbb	Color of the fog (rr, gg and bb are each a hexadecimal number between 00 and ff).
float "fog_density"		Density of fog.
float "fog_end"		Distance at which fog should be end.
string "fog_mode"	"none", "linear", "exp", "exponential", "exp2", "exponential2"	Fog mode.
int "fov"		Field of view angle.
string "ground"		Ground object.
int "groundrepeats"	0 or 1	Ground object is tiled.
float "nearplane"		???
string "objectpath"		Base url for object path.
string "objectpassword"		Password used to encrypt zip files in object path.
float "old_walking_speed"		???
int "override_visibility"		Fixed visibility in meters
int "recommend_light_count"		Recommended maximum number of lights.
int "recommend_per_pixel_lighting"		Recommend the use of a renderer that supports per pixel lighting.
float "run_speed"		Sets the run speed of users.
string "sky_clouds1"		Cloud layer 1 texture.
string "sky_clouds2"		Cloud layer 2 texture.
float x 3 "sky_clouds1_color"		SRGB (e.g. "0.65 0.65 0.65")
float x 3 "sky_clouds2_color"		SRGB (e.g. "0.65 0.65 0.65")
float "sky_clouds1_scale"		Scales the size of cloud layer 1.
float "sky_clouds2_scale"		Scales the size of cloud layer 2.
??? "sky_clouds1_velocity"		Cloud layer 1 velocity.
??? "sky_clouds2_velocity"		Cloud layer 2 velocity.
float x 3 "sky_color1"		Sky color 1 in SRGB (e.g. "0.65 0.65 0.65") - top
float x 3 "sky_color2"		Sky color 2 in SRGB (e.g. "0.65 0.65 0.65")
float x 3 "sky_color3"		Sky color 3 in SRGB (e.g. "0.65 0.65 0.65")
float x 3 "sky_color4"		Sky color 4 in SRGB (e.g. "0.65 0.65 0.65") - below horizon
string "skybox"		Base name of skybox textures.
int "skybox_swaplr"	0 or 1	Swap the left and right texture of the skybox.
string "skybox_extension"	(e.g. "png")	File-extension of skybox textures, to allow using non JPEG textures.
int "terrain"	0 or 1	Terrain enabled/disabled.
float "terrainoffset"		Sets a height offset for terrain, in meters.
float "terrainscale"		Scales the size of terrain cells.
float "walk_speed"		Sets the walking speed of users.
string "web_overlay"		???
string "welcome"		Welcome message.
float x 3 "worldlight_ambient"		Ambient light color in SRGB (e.g. "0.65 0.65 0.65")
float x 3 "worldlight_diffuse"		Diffuse light color in SRGB (e.g. "0.9 0.9 0.9")
float x 3 "worldlight_position"		Directional light position (e.g. "-1.842309 1.547655 -1.358088")
float x 3 "worldlight_specular"		Directional light specular (e.g. "1.0 1.0 0.95")
??? "worldlight_srgb_colors"		Directional light color in SRGB (e.g. "0.65 0.65 0.65")
string "worldname"		Name of world.

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