Vp enter - Revision history

Sleepy E: Add example code

2016-12-17T17:39:51Z

Add example code

@@ Line 13: / Line 13: @@
 *If a {{sdk callback|enter}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method|wait}} in a loop until done.
 *If the bot was already in a world, it will automatically leave that world.
-*Successfully entering a world will trigger {{sdk event|world_setting}} for each world setting, provided that the instance has subscribed to it. See {{sdk method|event_set}}.
+*Entering a world will trigger {{sdk event|world_setting}} for each world setting. Followed by {{sdk event|world_settings_changed}} to signal that all settings have been sent. Provided that the instance has subscribed to them.  See {{sdk method|event_set}}.
 |caveats=
 *The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method|state_change}} is called at least once.
 *World names are case-sensitive.
 |seealso=
 * {{sdk callback|enter}}

Sleepy E at 17:27, 17 December 2016

2016-12-17T17:27:50Z

← Older revision		Revision as of 17:27, 17 December 2016
Line 13:		Line 13:
	*If a {{sdk callback\|enter}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.		*If a {{sdk callback\|enter}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.
	*If the bot was already in a world, it will automatically leave that world.		*If the bot was already in a world, it will automatically leave that world.
	*~~This~~ will trigger {{sdk event\|world_setting}} for each world setting, provided that the instance has subscribed to ~~the event~~. See {{sdk method\|event_set}}.		*Successfully entering a world will trigger {{sdk event\|world_setting}} for each world setting, provided that the instance has subscribed to it. See {{sdk method\|event_set}}.
	\|caveats=		\|caveats=
	*The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method\|state_change}} is called at least once.		*The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method\|state_change}} is called at least once.
Line 19:		Line 19:
	\|seealso=		\|seealso=
	* {{sdk callback\|enter}}		* {{sdk callback\|enter}}
			* {{sdk event\|world_setting}}
	* {{sdk method\|state_change}}		* {{sdk method\|state_change}}
	* {{sdk method\|leave}}		* {{sdk method\|leave}}
	}}		}}

Sleepy E: Removed reason code, inform about world setting event

2016-12-17T17:24:36Z

Removed reason code, inform about world setting event

← Older revision		Revision as of 17:24, 17 December 2016
Line 4:		Line 4:
	{{sdk parameter row\|string\|world\|Name of an online world to enter}}		{{sdk parameter row\|string\|world\|Name of an online world to enter}}
	\|returncodes=		\|returncodes=
	{{sdk return code row\|~~NOT_INITIALIZED \|SDK not initialized with {{sdk method\|init}} yet}}~~		{{sdk return code row\|string_too_long \|World name was longer than 255 bytes}}
	~~{{sdk return code row\|STRING_TOO_LONG~~ \|World name was longer than 255 bytes}}		{{sdk return code row\|connection_error \|Disconnected from universe while sending, or connecting to the world failed}}
	{{sdk return code row\|~~CONNECTION_ERROR~~ \|Disconnected from universe while sending, or connecting to the world failed}}		{{sdk return code row\|world_not_found \|No such world is connected to the [[universe]]}}
	{{sdk return code row\|~~WORLD_NOT_FOUND~~ \|No such world is connected to the [[universe]]}}		{{sdk return code row\|world_login_error \|Could not login to world (e.g. incorrect world address configured) or banned (not yet implemented)}}
	{{sdk return code row\|~~WORLD_LOGIN_ERROR~~\|Could not login to world (e.g. incorrect world address configured) or banned (not yet implemented)}}		{{sdk return code row\|timeout \|Connection attempt to the world server timed out (e.g. firewalled server)}}
	{{sdk return code row\|~~TIMEOUT~~ \|Connection attempt to the world server timed out (e.g. firewalled server)}}		{{sdk return code row\|not_in_universe \|Bot is not currently connected to universe}}
	{{sdk return code row\|~~NOT_IN_UNIVERSE~~ \|Bot is not currently connected to universe}}
	\|behavior=		\|behavior=
	*If a {{sdk callback\|~~ENTER~~}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.		*If a {{sdk callback\|enter}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.
	* If the bot was already in a world, it will automatically leave that world.		*If the bot was already in a world, it will automatically leave that world.
			*This will trigger {{sdk event\|world_setting}} for each world setting, provided that the instance has subscribed to the event. See {{sdk method\|event_set}}.
	\|caveats=		\|caveats=
	*The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method\|state_change}} is called at least once.		*The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method\|state_change}} is called at least once.
	*World names are case-sensitive.		*World names are case-sensitive.
	\|seealso=		\|seealso=
	* {{sdk callback\|~~ENTER~~}}		* {{sdk callback\|enter}}
	* {{sdk method\|state_change}}		* {{sdk method\|state_change}}
	* {{sdk method\|leave}}		* {{sdk method\|leave}}
	}}		}}

Sleepy E: Added reason codes and callback

2016-12-13T21:41:02Z

Added reason codes and callback

← Older revision		Revision as of 21:41, 13 December 2016
Line 5:		Line 5:
	\|returncodes=		\|returncodes=
	{{sdk return code row\|NOT_INITIALIZED \|SDK not initialized with {{sdk method\|init}} yet}}		{{sdk return code row\|NOT_INITIALIZED \|SDK not initialized with {{sdk method\|init}} yet}}
	{{sdk return code row\|~~CONNECTION_ERROR~~ \|~~Error connecting to the world server~~}}		{{sdk return code row\|STRING_TOO_LONG \|World name was longer than 255 bytes}}
	{{sdk return code row\|~~TIMEOUT~~ \|~~Connection attempt~~ to the world ~~server timed out (e.g. firewalled server)~~}}		{{sdk return code row\|CONNECTION_ERROR \|Disconnected from universe while sending, or connecting to the world failed}}
	{{sdk return code row\|WORLD_NOT_FOUND \|No such world is connected to the [[universe]]}}		{{sdk return code row\|WORLD_NOT_FOUND \|No such world is connected to the [[universe]]}}
	{{sdk return code row\|WORLD_LOGIN_ERROR\|Could not login to world (e.g. incorrect world address configured) or banned (not yet implemented)}}		{{sdk return code row\|WORLD_LOGIN_ERROR\|Could not login to world (e.g. incorrect world address configured) or banned (not yet implemented)}}
			{{sdk return code row\|TIMEOUT \|Connection attempt to the world server timed out (e.g. firewalled server)}}
			{{sdk return code row\|NOT_IN_UNIVERSE \|Bot is not currently connected to universe}}
	\|behavior=		\|behavior=
	* If the bot was already in a world, it will automatically leave that world		*If a {{sdk callback\|ENTER}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.
			* If the bot was already in a world, it will automatically leave that world.
	\|caveats=		\|caveats=
	The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method\|state_change}} is called at least once.		*The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method\|state_change}} is called at least once.
			*World names are case-sensitive.
	\|seealso=		\|seealso=
			* {{sdk callback\|ENTER}}
	* {{sdk method\|state_change}}		* {{sdk method\|state_change}}
	* {{sdk method\|leave}}		* {{sdk method\|leave}}
	}}		}}

Roy Curtis: Created page with "{{sdk method page|enter|Enters a bot into a world. |paramex=world |parameters= {{sdk parameter row|string|world|Name of an online world to enter}} |returncodes= {{sdk ..."

2013-09-30T15:08:59Z

Created page with "{{sdk method page|enter|Enters a bot into a world. |paramex=world |parameters= {{sdk parameter row|string|world|Name of an online world to enter}} |returncodes= {{sdk ..."

New page

{{sdk method page|enter|Enters a bot into a [[world]].
|paramex=world
|parameters=
{{sdk parameter row|string|world|Name of an online world to enter}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED |SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|CONNECTION_ERROR |Error connecting to the world server}}
{{sdk return code row|TIMEOUT |Connection attempt to the world server timed out (e.g. firewalled server)}}
{{sdk return code row|WORLD_NOT_FOUND |No such world is connected to the [[universe]]}}
{{sdk return code row|WORLD_LOGIN_ERROR|Could not login to world (e.g. incorrect world address configured) or banned (not yet implemented)}}
|behavior=
* If the bot was already in a world, it will automatically leave that world
|caveats=
The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method|state_change}} is called at least once.
|seealso=
* {{sdk method|state_change}}
* {{sdk method|leave}}
}}