Class Notifications

Namespace

TinyLife.Uis

Assembly

TinyLife.dll

This class holds information about the current and past notifications that are displayed in the top center of the screen. To create custom notifications, use Add(MapObject, string, NotifType, bool) or Add(Icon, string, NotifType, bool).

public static class Notifications

Inheritance

object

Notifications

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

AchievementIcon

public static readonly Notifications.Icon AchievementIcon

Field Value

Notifications.Icon

BillsIcon

public static readonly Notifications.Icon BillsIcon

Field Value

Notifications.Icon

CheatsIcon

public static readonly Notifications.Icon CheatsIcon

Field Value

Notifications.Icon

DeathIcon

public static readonly Notifications.Icon DeathIcon

Field Value

Notifications.Icon

DebugIcon

public static readonly Notifications.Icon DebugIcon

Field Value

Notifications.Icon

ErrorIcon

public static readonly Notifications.Icon ErrorIcon

Field Value

Notifications.Icon

Icons

The registry of icons registered using RegisterIcon(string, TextureRegion). Can be used to gather modded icons for display in Add(Icon, string, NotifType, bool).

public static readonly ReadOnlyDictionary<string, Notifications.Icon> Icons

Field Value

ReadOnlyDictionary<string, Notifications.Icon>

JobIcon

public static readonly Notifications.Icon JobIcon

Field Value

Notifications.Icon

MailIcon

public static readonly Notifications.Icon MailIcon

Field Value

Notifications.Icon

MaxHistoryLength

The maximum amount of entries that can be in the notification history before the oldest entries start being deleted.

public const int MaxHistoryLength = 512

Field Value

int

NewspaperIcon

public static readonly Notifications.Icon NewspaperIcon

Field Value

Notifications.Icon

PredictionIcon

public static readonly Notifications.Icon PredictionIcon

Field Value

Notifications.Icon

RestoreIcon

public static readonly Notifications.Icon RestoreIcon

Field Value

Notifications.Icon

SpeechIcon

public static readonly Notifications.Icon SpeechIcon

Field Value

Notifications.Icon

SteamIcon

public static readonly Notifications.Icon SteamIcon

Field Value

Notifications.Icon

UpgradeIcon

public static readonly Notifications.Icon UpgradeIcon

Field Value

Notifications.Icon

WrenchIcon

public static readonly Notifications.Icon WrenchIcon

Field Value

Notifications.Icon

Properties

SkillIcons

public static IReadOnlyDictionary<SkillType, Notifications.Icon> SkillIcons { get; }

Property Value

IReadOnlyDictionary<SkillType, Notifications.Icon>

Methods

Add(MapObject, string, NotifType, bool)

Adds a new notification related to the given map object. The passed object is also the one that will be displayed in the notification.

public static void Add(MapObject obj, string content, NotifType type = NotifType.Info, bool center = false)

Parameters

obj MapObject

The map object that this notification relates to

content string

The content of the notification. Should be localized using Localization

type NotifType

The type that this notification should have, which determines the color of its background

center bool

Whether the notification should be displayed as a splash notification in the center of the screen, rather than in the notification area on the side.

Add(Icon, string, NotifType, bool)

Adds a new notification related to nothing. The passed icon is displayed instead of an object.

public static void Add(Notifications.Icon icon, string content, NotifType type = NotifType.Info, bool center = false)

Parameters

icon Notifications.Icon

The icon that should be displayed in the notification

content string

The content of the notification. Should be localized using Localization

type NotifType

The type that this notification should have, which determines the color of its background

center bool

Whether the notification should be displayed as a splash notification in the center of the screen, rather than in the notification area on the side.

RegisterIcon(string, TextureRegion)

Registers an icon that can be used as a notification icon in Add(Icon, string, NotifType, bool). Icons are registered so that notification instances remember them when the game is closed and loaded again.

public static Notifications.Icon RegisterIcon(string name, TextureRegion texture)

Parameters

name string

The name of the icon to register.

texture TextureRegion

The texture that the icon should display.

Returns

Notifications.Icon

The name, for registering and immediately storing in a variable.