Vp console message - Revision history

Sleepy E: Added example, updated text, VP_TEXT_EFFECT...

2016-12-13T21:55:40Z

Added example, updated text, VP_TEXT_EFFECT...

← Older revision		Revision as of 21:55, 13 December 2016
Line 2:		Line 2:
	\|paramex=session, name, message, effects, red, green, blue		\|paramex=session, name, message, effects, red, green, blue
	\|parameters=		\|parameters=
	{{sdk parameter row\|int \|session\|~~Target session~~}}		{{sdk parameter row\|int \|session\|Session ID to send the message to. Zero to send to everyone}}
	{{sdk parameter row\|string\|name \|Name to ~~attach to~~ the message}}		{{sdk parameter row\|string\|name \|Name to use for the chat message. Empty string to hide name.}}
	{{sdk parameter row\|string\|message\|~~Message body~~}}		{{sdk parameter row\|string\|message\|Chat message contents}}
	{{sdk parameter row\|int \|effects\|~~Bitfield~~ of ~~message formatting~~}}		{{sdk parameter row\|int \|effects\|Text effects (combination of [[vp_text_effect]] flags)}}
	{{sdk parameter row\|uchar \|red \|~~Message~~ color ~~red value~~}}		{{sdk parameter row\|uchar \|red \|Red component of the text color(0-255)}}
	{{sdk parameter row\|uchar \|green \|~~Message~~ color ~~green value~~}}		{{sdk parameter row\|uchar \|green \|Green component of the text color(0-255)}}
	{{sdk parameter row\|uchar \|blue \|~~Message~~ color ~~blue value~~}}		{{sdk parameter row\|uchar \|blue \|Blue component of the text color(0-255)}}
	\|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}}
Line 14:		Line 14:
	{{sdk return code row\|STRING_TOO_LONG\|Name or message exceeds 255 characters in length}}		{{sdk return code row\|STRING_TOO_LONG\|Name or message exceeds 255 characters in length}}
	\|behavior=		\|behavior=
			* <i>effects</i> can be 0, or any combination of VP_TEXT_EFFECT_BOLD and VP_TEXT_EFFECT_ITALIC.
	\|caveats=		\|caveats=
			\|examples=
			This will output "<font color="red"><b><i>Postman: You have a letter</i></b></font>" in chat.
			<syntaxhighlight lang="c">
			vp_console_message(sdk, 0, "Postman", "You have a letter", VP_TEXT_EFFECT_BOLD \| VP_TEXT_EFFECT_ITALIC, 255, 0, 0);
			</syntaxhighlight>
	\|seealso=		\|seealso=
	* {{sdk method\|say}}		* {{sdk method\|say}}
	}}		}}

Sleepy E at 20:05, 13 December 2016

2016-12-13T20:05:04Z

← Older revision		Revision as of 20:05, 13 December 2016
Line 16:		Line 16:
	\|caveats=		\|caveats=
	\|seealso=		\|seealso=
	* {{sdk method\|~~chat~~}}		* {{sdk method\|say}}
	}}		}}

Roy Curtis: draft commit

2013-10-05T21:22:56Z

draft commit

New page

{{sdk method page|console_message|Makes a bot send a custom named and/or formatted message to the [[world]] or a specific session in-world.
|paramex=session, name, message, effects, red, green, blue
|parameters=
{{sdk parameter row|int |session|Target session}}
{{sdk parameter row|string|name |Name to attach to the message}}
{{sdk parameter row|string|message|Message body}}
{{sdk parameter row|int |effects|Bitfield of message formatting}}
{{sdk parameter row|uchar |red |Message color red value}}
{{sdk parameter row|uchar |green |Message color green value}}
{{sdk parameter row|uchar |blue |Message color blue value}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
{{sdk return code row|STRING_TOO_LONG|Name or message exceeds 255 characters in length}}
|behavior=
|caveats=
|seealso=
* {{sdk method|chat}}
}}