Method Notify

Namespace

Pillars.Notifications.Actors

Assembly

Pillars.dll

Notify(IEnumerable<PiPlayer>, NOTIFICATIONICON, string, string, float)

Notifies a set of player

public Task Notify(IEnumerable<PiPlayer> targets, NOTIFICATIONICON icon, string title, string text, float duration = 5)

Parameters

targets IEnumerable<PiPlayer>

The players to notify

icon NOTIFICATIONICON

NOTIFICATIONICON

title string

Title of the notification (first line)

text string

Text of the notification (second line)

duration float

Duration in seconds to display the notification

Returns

Task

Remarks

The notification duration is clamped at minimum 1 second on client

Notify(IEnumerable<PiPlayer>, int, string, string, float)

Notifies a set of player

public Task Notify(IEnumerable<PiPlayer> targets, int iconIdx, string title, string text, float duration = 5)

Parameters

targets IEnumerable<PiPlayer>

The players to notify

iconIdx int

The icon index of the clientside texture array

title string

Title of the notification (first line)

text string

Text of the notification (second line)

duration float

Duration in seconds to display the notification

Returns

Task

Remarks

The notification duration is clamped at minimum 1 second on client

Notify(PiPlayer, NOTIFICATIONICON, string, string, float)

Sends a notification to a given target.

public Task Notify(PiPlayer target, NOTIFICATIONICON icon, string title, string text, float duration = 5)

Parameters

target PiPlayer

The player to send the notification to

icon NOTIFICATIONICON

NOTIFICATIONICON

title string

Title of the notification (first line)

text string

Text of the notification (second line)

duration float

Duration in seconds to display the notification

Returns

Task

Remarks

The notification duration is clamped at minimum 1 second on client

Notify(PiPlayer, int, string, string, float)

Sends a notification to a given target.

public Task Notify(PiPlayer target, int iconIdx, string title, string text, float duration = 5)

Parameters

target PiPlayer

The player to send the notification to

iconIdx int

The icon index of the clientside texture array

title string

Title of the notification (first line)

text string

Text of the notification (second line)

duration float

Duration in seconds to display the notification

Returns

Task

Remarks

The notification duration is clamped at minimum 1 second on client