Vp join - Revision history

Sleepy E: Added reference number attribute

2018-07-31T23:31:06Z

Added reference number attribute

← Older revision		Revision as of 23:31, 31 July 2018
Line 3:		Line 3:
	\|parameters=		\|parameters=
	{{sdk parameter row\|int\|user_id\|User id}}		{{sdk parameter row\|int\|user_id\|User id}}
			\|attributes=
			{{sdk attribute row\|int\|reference_number\|Is passed to the callback to identify for which method call it is fired}}
	\|returncodes=		\|returncodes=
	{{sdk return code row\|NOT_IN_UNIVERSE\|Bot is not currently in the universe}}		{{sdk return code row\|NOT_IN_UNIVERSE\|Bot is not currently in the universe}}

Sleepy E: Test

2016-12-15T21:15:33Z

Test

Sleepy E at 23:02, 14 December 2016

2016-12-14T23:02:22Z

Sleepy E: Basic layout

2016-12-14T23:01:50Z

Basic layout

New page

{{sdk method page|join|Send a join request to a user.
|paramex=user_id
|parameters=
{{sdk parameter row|int|user_id|User id}}
|returncodes=
{{sdk return code row|NOT_IN_UNIVERSE|Bot is not currently in the universe}}
{{sdk return code row|JOIN_DECLINED|Join request was declined}}
{{sdk return code row|RC_TIMEOUT|Join request timeout (no accept/decline within 30 seconds)}}
|returnattributes=
{{sdk attribute row|int |JOIN_ID |Join id}}
{{sdk attribute row|int |USER_ID |User id}}
{{sdk attribute row|float |JOIN_NAME |Name of user}}
{{sdk attribute row|float |JOIN_X |User x coordinate}}
{{sdk attribute row|float |JOIN_Y |User y coordinate}}
{{sdk attribute row|float |JOIN_Z |User z coordinate}}
{{sdk attribute row|float |JOIN_YAW |User yaw angle}}
{{sdk attribute row|float |JOIN_PITCH |User pitch angle}}
{{sdk attribute row|float |JOIN_WORLD |World that user is in}}
|behavior=
* Upon sending a request, {{sdk event|JOIN}} is triggered for the user. See {{sdk method|event_set}}.
|caveats=
|examples=
<syntaxhighlight lang="c">
...
</syntaxhighlight>
|seealso=
* {{sdk event|JOIN}}
* {{sdk callback|JOIN}}
* {{sdk method|join_accept}}
* {{sdk method|join_decline}}
}}

← Older revision		Revision as of 21:15, 15 December 2016
Line 6:		Line 6:
	{{sdk return code row\|NOT_IN_UNIVERSE\|Bot is not currently in the universe}}		{{sdk return code row\|NOT_IN_UNIVERSE\|Bot is not currently in the universe}}
	{{sdk return code row\|JOIN_DECLINED\|Join request was declined}}		{{sdk return code row\|JOIN_DECLINED\|Join request was declined}}
	{{sdk return code row\|~~RC_TIMEOUT~~\|Join request timeout (no accept/decline within 30 seconds)}}		{{sdk return code row\|TIMEOUT\|Join request timeout (no accept/decline within 30 seconds)}}
	\|returnattributes=		\|returnattributes=
	{{sdk attribute row\|int \|JOIN_ID \|Join id}}		{{sdk attribute row\|int \|JOIN_ID \|Join id \|{{code\|VP_RC_JOIN_DECLINED}}}}
	{{sdk attribute row\|int \|USER_ID \|User id}}		{{sdk attribute row\|int \|USER_ID \|User id \|{{code\|VP_RC_JOIN_DECLINED}}}}
	{{sdk attribute row\|string \|JOIN_NAME \|Name of user}}		{{sdk attribute row\|string \|JOIN_NAME \|Name of user \|{{code\|VP_RC_JOIN_DECLINED}} and {{code\|VP_RC_TIMEOUT}}}}
	{{sdk attribute row\|float \|JOIN_X \|User x coordinate}}		{{sdk attribute row\|float \|JOIN_X \|User x coordinate \|}}
	{{sdk attribute row\|float \|JOIN_Y \|User y coordinate}}		{{sdk attribute row\|float \|JOIN_Y \|User y coordinate \|}}
	{{sdk attribute row\|float \|JOIN_Z \|User z coordinate}}		{{sdk attribute row\|float \|JOIN_Z \|User z coordinate \|}}
	{{sdk attribute row\|float \|JOIN_YAW \|User yaw angle}}		{{sdk attribute row\|float \|JOIN_YAW \|User yaw angle \|}}
	{{sdk attribute row\|float \|JOIN_PITCH \|User pitch angle}}		{{sdk attribute row\|float \|JOIN_PITCH \|User pitch angle \|}}
	{{sdk attribute row\|string \|JOIN_WORLD \|World that user is in}}		{{sdk attribute row\|string \|JOIN_WORLD \|World that user is in \|}}
	\|behavior=		\|behavior=
	* Upon sending a request, {{sdk event\|JOIN}} is triggered for the user. See {{sdk method\|event_set}}.		* Upon sending a request, {{sdk event\|JOIN}} is triggered for the user. See {{sdk method\|event_set}}.

← Older revision		Revision as of 23:02, 14 December 2016
Line 8:		Line 8:
	{{sdk return code row\|RC_TIMEOUT\|Join request timeout (no accept/decline within 30 seconds)}}		{{sdk return code row\|RC_TIMEOUT\|Join request timeout (no accept/decline within 30 seconds)}}
	\|returnattributes=		\|returnattributes=
	{{sdk attribute row\|int \|JOIN_ID \|Join id}}		{{sdk attribute row\|int \|JOIN_ID \|Join id}}
	{{sdk attribute row\|int \|USER_ID \|User id}}		{{sdk attribute row\|int \|USER_ID \|User id}}
	{{sdk attribute row\|~~float~~ \|JOIN_NAME \|Name of user}}		{{sdk attribute row\|string \|JOIN_NAME \|Name of user}}
	{{sdk attribute row\|float \|JOIN_X \|User x coordinate}}		{{sdk attribute row\|float \|JOIN_X \|User x coordinate}}
	{{sdk attribute row\|float \|JOIN_Y \|User y coordinate}}		{{sdk attribute row\|float \|JOIN_Y \|User y coordinate}}
	{{sdk attribute row\|float \|JOIN_Z \|User z coordinate}}		{{sdk attribute row\|float \|JOIN_Z \|User z coordinate}}
	{{sdk attribute row\|float \|JOIN_YAW \|User yaw angle}}		{{sdk attribute row\|float \|JOIN_YAW \|User yaw angle}}
	{{sdk attribute row\|float \|JOIN_PITCH \|User pitch angle}}		{{sdk attribute row\|float \|JOIN_PITCH \|User pitch angle}}
	{{sdk attribute row\|~~float~~ \|JOIN_WORLD \|World that user is in}}		{{sdk attribute row\|string \|JOIN_WORLD \|World that user is in}}
	\|behavior=		\|behavior=
	* Upon sending a request, {{sdk event\|JOIN}} is triggered for the user. See {{sdk method\|event_set}}.		* Upon sending a request, {{sdk event\|JOIN}} is triggered for the user. See {{sdk method\|event_set}}.