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

Find player by name using autocompletion. Returns null and prints message if none or multiple players matched. Raises Player.SearchingForPlayer event, which may modify search results.

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

Syntax

   
 C# 
[CanBeNullAttribute]
public static Player FindPlayerOrPrintMatches(
	Player player,
	string name,
	bool includeHidden,
	bool raiseEvent
)

Parameters

player
Player
Player who initiated the search. This is where messages are sent.
name
String
Full or partial name of the search target.
includeHidden
Boolean
Whether to include hidden players in the search.
raiseEvent
Boolean
Whether to raise Server.SearchingForPlayer event.

Return Value

Player object, or null if no player was found.

See Also