Class AliasExtensions

Inheritance

System.Object

AliasExtensions

Namespace: Eco.Gameplay.Aliases

Assembly: Eco.Gameplay.dll

Syntax

public static class AliasExtensions : Object

Methods

ContainsExactAlias(IEnumerable<IAlias>, IAlias)

Declaration

public static bool ContainsExactAlias(this IEnumerable<IAlias> aliases, IAlias query)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IAlias>	aliases
IAlias	query

Returns

Type	Description
System.Boolean

ContainsUser(IEnumerable<IAlias>, User)

Declaration

public static bool ContainsUser(this IEnumerable<IAlias> aliases, User user)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IAlias>	aliases
User	user

Returns

Type	Description
System.Boolean

FirstUser(IAlias)

If this alias has multiple users, return the first one.

Declaration

public static User FirstUser(this IAlias alias)

Parameters

Type	Name	Description
IAlias	alias

Returns

Type	Description
User

GetBackupOwner(IAlias)

Declaration

public static IAlias GetBackupOwner(this IAlias alias)

Parameters

Type	Name	Description
IAlias	alias

Returns

Type	Description
IAlias

Mail(IAlias, LocString, NotificationCategory)

Declaration

public static void Mail(this IAlias alias, LocString text, NotificationCategory tag)

Parameters

Type	Name	Description
IAlias	alias
LocString	text
NotificationCategory	tag

MailLoc(IAlias, FormattableString, NotificationCategory)

Declaration

public static void MailLoc(this IAlias alias, FormattableString text, NotificationCategory tag)

Parameters

Type	Name	Description
IAlias	alias
System.FormattableString	text
NotificationCategory	tag

MailLocStr(IAlias, String, NotificationCategory)

Declaration

public static void MailLocStr(this IAlias alias, string text, NotificationCategory tag)

Parameters

Type	Name	Description
IAlias	alias
System.String	text
NotificationCategory	tag

Msg(IAlias, LocString, Boolean, NotificationStyle, NotificationCategory)

Declaration

public static void Msg(this IAlias alias, LocString message, bool temp = true, NotificationStyle style, NotificationCategory tag)

Parameters

Type	Name	Description
IAlias	alias
LocString	message
System.Boolean	temp
NotificationStyle	style
NotificationCategory	tag

MsgLoc(IAlias, FormattableString, Boolean, NotificationStyle, NotificationCategory)

Declaration

public static void MsgLoc(this IAlias alias, FormattableString message, bool temp = true, NotificationStyle style, NotificationCategory tag)

Parameters

Type	Name	Description
IAlias	alias
System.FormattableString	message
System.Boolean	temp
NotificationStyle	style
NotificationCategory	tag

MsgLocStr(IAlias, String, Boolean, NotificationStyle, NotificationCategory)

Declaration

public static void MsgLocStr(this IAlias alias, string message, bool temp = true, NotificationStyle style, NotificationCategory tag)

Parameters

Type	Name	Description
IAlias	alias
System.String	message
System.Boolean	temp
NotificationStyle	style
NotificationCategory	tag

OneUser(IAlias)

If this alias is a single user, return it. This is used for parts of the game that can't handle something being multiple users. Over time we can add support to that (like housing values spreading across multiple people for example).

Declaration

public static User OneUser(this IAlias alias)

Parameters

Type	Name	Description
IAlias	alias

Returns

Type	Description
User

ToUsers(IEnumerable<IAlias>)

Get the full list of users in all these aliases, no repeats.

Declaration

public static IEnumerable<User> ToUsers(this IEnumerable<IAlias> aliases)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IAlias>	aliases

Returns

Type	Description
System.Collections.Generic.IEnumerable<User>