[This is preliminary documentation and is subject to change.]

Formats and broadcasts a message, prefixing wrapped lines.

Namespace: fCraft
Assembly: fCraft (in fCraft.dll) Version: 0.6.3.2 (0.6.3.2)

Syntax

   
 C# 
[StringFormatMethodAttribute("message")]
public static int MessagePrefixed(
	this IEnumerable<Player> source,
	string prefix,
	string message,
	params Object[] formatArgs
)

Parameters

source
IEnumerable<(Of <(<'Player>)>)>
List of players who will receive the message.
prefix
String
Prefix to prepend to prepend to each line after the 1st, if any line-wrapping occurs. Does NOT get prepended to first line.
message
String
String/message to send.
formatArgs
array<Object>[]()[][]
Format parameters. Same semantics as String.Format

Return Value

Number of message packets that were sent out.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<(Of <(<'Player>)>)>. When you use instance method syntax to call this method, omit the first parameter.

See Also