Class PlayerExtensions

Inheritance

System.Object

PlayerExtensions

Namespace: Eco.Gameplay.Players

Assembly: Eco.Gameplay.dll

Syntax

public static class PlayerExtensions : Object

Methods

ConfirmBox(User, LocString)

Declaration

public static Task<bool> ConfirmBox(this User user, LocString msg)

Parameters

Type	Name	Description
User	user
LocString	msg

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

ConfirmBoxLoc(User, FormattableString)

Declaration

public static Task<bool> ConfirmBoxLoc(this User user, FormattableString msg)

Parameters

Type	Name	Description
User	user
System.FormattableString	msg

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

Mail(User, LocString, NotificationCategory)

Declaration

public static void Mail(this User user, LocString text, NotificationCategory tag)

Parameters

Type	Name	Description
User	user
LocString	text
NotificationCategory	tag

Mail(IEnumerable<User>, LocString, NotificationCategory)

Declaration

public static void Mail(this IEnumerable<User> users, LocString text, NotificationCategory tag)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<User>	users
LocString	text
NotificationCategory	tag

MailLoc(User, FormattableString, NotificationCategory)

Declaration

public static MailMessage MailLoc(this User user, FormattableString text, NotificationCategory tag)

Parameters

Type	Name	Description
User	user
System.FormattableString	text
NotificationCategory	tag

Returns

Type	Description
MailMessage

MailLoc(IEnumerable<User>, FormattableString, NotificationCategory)

Declaration

public static void MailLoc(this IEnumerable<User> users, FormattableString text, NotificationCategory tag)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<User>	users
System.FormattableString	text
NotificationCategory	tag

MailLocStr(IEnumerable<User>, String, NotificationCategory)

Declaration

public static void MailLocStr(this IEnumerable<User> users, string text, NotificationCategory tag)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<User>	users
System.String	text
NotificationCategory	tag

Msg(IEnumerable<User>, LocString, NotificationCategory, NotificationStyle)

Declaration

public static void Msg(this IEnumerable<User> users, LocString msg, NotificationCategory category, NotificationStyle style)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<User>	users
LocString	msg
NotificationCategory	category
NotificationStyle	style

Msg(IEnumerable<User>, LocString, NotificationStyle)

Declaration

public static void Msg(this IEnumerable<User> users, LocString msg, NotificationStyle style)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<User>	users
LocString	msg
NotificationStyle	style

MsgLoc(IEnumerable<User>, FormattableString, NotificationStyle)

Declaration

public static void MsgLoc(this IEnumerable<User> users, FormattableString msg, NotificationStyle style)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<User>	users
System.FormattableString	msg
NotificationStyle	style

MsgLocStr(IEnumerable<User>, String, NotificationStyle)

Declaration

public static void MsgLocStr(this IEnumerable<User> users, string msg, NotificationStyle style)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<User>	users
System.String	msg
NotificationStyle	style

MsgOrMail(User, LocString, NotificationCategory, NotificationStyle)

Sends a message to the user if online. if the user is offline the same message will be sent but to the mail, so that it gets seen when the user logs in.

Declaration

public static void MsgOrMail(this User user, LocString text, NotificationCategory mailTag, NotificationStyle msgStyle)

Parameters

Type	Name	Description
User	user
LocString	text
NotificationCategory	mailTag
NotificationStyle	msgStyle

MsgOrMailLoc(User, FormattableString, NotificationCategory, NotificationStyle)

Sends a message to the user if online. if the user is offline the same message will be sent but to the mail, so that it gets seen when the user logs in.

Declaration

public static void MsgOrMailLoc(this User user, FormattableString text, NotificationCategory mailTag, NotificationStyle msgStyle)

Parameters

Type	Name	Description
User	user
System.FormattableString	text
NotificationCategory	mailTag
NotificationStyle	msgStyle

OkBox(User, LocString)

Declaration

public static void OkBox(this User user, LocString msg)

Parameters

Type	Name	Description
User	user
LocString	msg

OkBox(User, LocString, Boolean)

Declaration

public static Result OkBox(this User user, LocString msg, bool succeeded)

Parameters

Type	Name	Description
User	user
LocString	msg
System.Boolean	succeeded

Returns

Type	Description
Result

OkBoxLoc(User, FormattableString)

Declaration

public static void OkBoxLoc(this User user, FormattableString msg)

Parameters

Type	Name	Description
User	user
System.FormattableString	msg