logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityHudValueTransform

    Inspector-authored source for a HudValueTransform.

    Inheritance
    object
    UnityHudValueTransform
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.GameUi.Infrastructure.Settings
    Assembly: Serenity.UnityGameUi.Infrastructure.dll
    Syntax
    public class UnityHudValueTransform

    Constructors

    UnityHudValueTransform()

    Declaration
    public UnityHudValueTransform()

    Properties

    ClampsToDisplayRange

    Whether a REMAP_RANGE clamps its output.

    Declaration
    public bool ClampsToDisplayRange { get; }
    Property Value
    Type Description
    bool

    DisplayMaximum

    The high end of the range a REMAP_RANGE maps onto.

    Declaration
    public float DisplayMaximum { get; }
    Property Value
    Type Description
    float

    DisplayMinimum

    The low end of the range a REMAP_RANGE maps onto.

    Declaration
    public float DisplayMinimum { get; }
    Property Value
    Type Description
    float

    Kind

    Which reshaping, if any, is configured.

    Declaration
    public HudValueTransformKind Kind { get; }
    Property Value
    Type Description
    HudValueTransformKind

    Multiplier

    The factor a SCALE_AND_OFFSET multiplies the value by.

    Declaration
    public float Multiplier { get; }
    Property Value
    Type Description
    float

    Offset

    The amount a SCALE_AND_OFFSET adds after multiplying.

    Declaration
    public float Offset { get; }
    Property Value
    Type Description
    float

    SourceMaximum

    The high end of the range a REMAP_RANGE reads from.

    Declaration
    public float SourceMaximum { get; }
    Property Value
    Type Description
    float

    SourceMinimum

    The low end of the range a REMAP_RANGE reads from.

    Declaration
    public float SourceMinimum { get; }
    Property Value
    Type Description
    float

    Methods

    ToValueTransform()

    Converts this inspector data into the engine-agnostic value object.

    Declaration
    public HudValueTransform ToValueTransform()
    Returns
    Type Description
    HudValueTransform
    In this article
    © 2026 Serenity. All Rights Reserved