Class InGameHint

Namespace

TinyLife.Uis

Assembly

TinyLife.dll

An in-game hint is a tutorial notification that can display with a given Condition, or that can be caused to be displayed manually using Display(). Each in-game hint is only displayed once, unless the list of displayed hints is reset in the Options.

public class InGameHint

Inheritance

object

InGameHint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Extensions.JsonCopy<T>(T)

Constructors

InGameHint(string, TextureRegion, bool, Func<GameImpl, bool>, Action<CoveringGroup, Panel>)

Creates a new hint with the given settings

public InGameHint(string name, TextureRegion icon, bool important, Func<GameImpl, bool> condition = null, Action<CoveringGroup, Panel> additionalContent = null)

Parameters

name string

The name of the hint

icon TextureRegion

The icon of this hint

important bool

Whether this hint is considered important.

condition Func<GameImpl, bool>

An optional condition to cause this hint to be displayed

additionalContent Action<CoveringGroup, Panel>

A function that can optionally add additional content to the hint's MLEM.Ui.Elements.Panel.

Fields

AdditionalContent

A function that can optionally add additional content to the hint's MLEM.Ui.Elements.Panel.

public readonly Action<CoveringGroup, Panel> AdditionalContent

Field Value

Action<CoveringGroup, Panel>

ClothesIntentions

public static readonly InGameHint ClothesIntentions

Field Value

InGameHint

Condition

An optional condition that causes this hint to be displayed

public readonly Func<GameImpl, bool> Condition

Field Value

Func<GameImpl, bool>

DeathEmotions

public static readonly InGameHint DeathEmotions

Field Value

InGameHint

EmotionInfluences

public static readonly InGameHint EmotionInfluences

Field Value

InGameHint

Hints

The registry for all InGameHint values. Use Register(InGameHint) to add to this list.

public static readonly ReadOnlyDictionary<string, InGameHint> Hints

Field Value

ReadOnlyDictionary<string, InGameHint>

Icon

The icon of this hint.

public readonly TextureRegion Icon

Field Value

TextureRegion

Important

Whether this hint is considered important.

public readonly bool Important

Field Value

bool

InteractionPages

public static readonly InGameHint InteractionPages

Field Value

InGameHint

Interactions

public static readonly InGameHint Interactions

Field Value

InGameHint

Introduction

public static readonly InGameHint Introduction

Field Value

InGameHint

LotEmployments

public static readonly InGameHint LotEmployments

Field Value

InGameHint

MultiMaps

public static readonly InGameHint MultiMaps

Field Value

InGameHint

Name

The name of this hint

public readonly string Name

Field Value

string

OutOfTownActions

public static readonly InGameHint OutOfTownActions

Field Value

InGameHint

Outfits

public static readonly InGameHint Outfits

Field Value

InGameHint

PersonalityTypes

public static readonly InGameHint PersonalityTypes

Field Value

InGameHint

Properties

HasBeenDisplayed

A property that determines whether this hint has already been displayed

public bool HasBeenDisplayed { get; }

Property Value

bool

Methods

Display()

Displays this hint as a Notifications panel and adds it to the list of already displayed hints in the Options

public void Display()

Register(InGameHint)

Registers the given hint to the Hints registry

public static InGameHint Register(InGameHint hint)

Parameters

hint InGameHint

The hint to register

Returns

InGameHint

The hint passed, for chaining