Class InGameHint

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.

Inheritance
System.Object
InGameHint
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: TinyLife.Uis
Assembly: Tiny Life.dll
Syntax
public class InGameHint

Constructors

InGameHint(String, TextureRegion, Func<GameImpl, Boolean>, Action<CoveringGroup, Panel>)

Creates a new hint with the given settings

Declaration
public InGameHint(string name, TextureRegion icon, Func<GameImpl, bool> condition = null, Action<CoveringGroup, Panel> additionalContent = null)
Parameters
Type Name Description
System.String name

The name of the hint
MLEM.Textures.TextureRegion icon

The icon of this hint
System.Func<T, TResult><GameImpl, System.Boolean> condition

An optional condition to cause this hint to be displayed
System.Action<T1, T2><CoveringGroup, MLEM.Ui.Elements.Panel> additionalContent

Fields

AdditionalContent

Declaration
public readonly Action<CoveringGroup, Panel> AdditionalContent
Field Value
Type Description
System.Action<T1, T2><CoveringGroup, MLEM.Ui.Elements.Panel>

ClothesIntentions

Declaration
public static readonly InGameHint ClothesIntentions
Field Value
Type Description
InGameHint

Condition

An optional condition that causes this hint to be displayed

Declaration
public readonly Func<GameImpl, bool> Condition
Field Value
Type Description
System.Func<T, TResult><GameImpl, System.Boolean>

Hints

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

Declaration
public static readonly ReadOnlyDictionary<string, InGameHint> Hints
Field Value
Type Description
System.Collections.ObjectModel.ReadOnlyDictionary<TKey, TValue><System.String, InGameHint>

Icon

The icon of this hint.

Declaration
public readonly TextureRegion Icon
Field Value
Type Description
MLEM.Textures.TextureRegion

InteractionPages

Declaration
public static readonly InGameHint InteractionPages
Field Value
Type Description
InGameHint

Interactions

Declaration
public static readonly InGameHint Interactions
Field Value
Type Description
InGameHint

Introduction

Declaration
public static readonly InGameHint Introduction
Field Value
Type Description
InGameHint

LotEmployments

Declaration
public static readonly InGameHint LotEmployments
Field Value
Type Description
InGameHint

Name

The name of this hint

Declaration
public readonly string Name
Field Value
Type Description
System.String

Outfits

Declaration
public static readonly InGameHint Outfits
Field Value
Type Description
InGameHint

OutOfTownActions

Declaration
public static readonly InGameHint OutOfTownActions
Field Value
Type Description
InGameHint

PersonalityTypes

Declaration
public static readonly InGameHint PersonalityTypes
Field Value
Type Description
InGameHint

Properties

HasBeenDisplayed

A property that determines whether this hint has already been displayed

Declaration
public bool HasBeenDisplayed { get; }
Property Value
Type Description
System.Boolean

Methods

Display()

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

Declaration
public void Display()

Register(InGameHint)

Registers the given hint to the Hints registry

Declaration
public static InGameHint Register(InGameHint hint)
Parameters
Type Name Description
InGameHint hint

The hint to register
Returns
Type Description
InGameHint

The hint passed, for chaining

Extension Methods