Interface IUnturnedUserDirectory

The service used for querying Unturned users. Unlike these methods are not async and are guaranteed to not block.

Namespace: OpenMod.Unturned.Users

Assembly: OpenMod.Unturned.dll

Syntax

public interface IUnturnedUserDirectory

Methods

| Improve this Doc View Source

FindPendingUser(CSteamID)

Tries to find a pending Unturned player user based on Steam ID.

Declaration

UnturnedPendingUser FindPendingUser(CSteamID steamId)

Parameters

Type	Name	Description
CSteamID	steamId	The Steam ID of the pending Unturned user to look for.

Returns

Type	Description
UnturnedPendingUser	The pending Unturned user if found; otherwise, null.

| Improve this Doc View Source

FindUser(CSteamID)

Tries to find a Unturned user based on Steam ID.

Declaration

UnturnedUser FindUser(CSteamID steamId)

Parameters

Type	Name	Description
CSteamID	steamId	The Steam ID of the Unturned user to look for.

Returns

Type	Description
UnturnedUser	The Unturned user if found; otherwise, null.

| Improve this Doc View Source

FindUser(String, UserSearchMode)

Tries to find a Unturned player user based on ID or name depending on .

Declaration

UnturnedUser FindUser(string searchString, UserSearchMode searchMode)

Parameters

Type	Name	Description
System.String	searchString	Name or ID of the user. The value depends on .
UserSearchMode	searchMode	The search mode. See .

Returns

Type	Description
UnturnedUser	The Unturned user if found; otherwise, null.

| Improve this Doc View Source

GetOnlineUsers()

Gets all online Unturned users.

Declaration

ICollection<UnturnedUser> GetOnlineUsers()

Returns

Type	Description
ICollection<UnturnedUser>	All online Unturned users.

| Improve this Doc View Source

GetPendingUser(SteamPending)

Gets the Unturned user instance for the given pending player.

Declaration

UnturnedPendingUser GetPendingUser(SteamPending pending)

Parameters

Type	Name	Description
SteamPending	pending	The pending player to get the Unturned user of.

Returns

Type	Description
UnturnedPendingUser	The Unturned user instance of the given pending player.

| Improve this Doc View Source

GetPendingUsers()

Gets all pending Unturned users.

Declaration

ICollection<UnturnedPendingUser> GetPendingUsers()

Returns

Type	Description
ICollection<UnturnedPendingUser>	All pending Unturned users.

| Improve this Doc View Source

GetUser(Player)

Gets the Unturned user instance for the given player.

Declaration

UnturnedUser GetUser(Player player)

Parameters

Type	Name	Description
Player	player	The player to get the Unturned user of.

Returns

Type	Description
UnturnedUser	The Unturned user instance of the given player.

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)