Class AlignmentCondition | MARS | 1.0.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class AlignmentCondition

    Represents a situation where a given plane must match a given set of alignments

    Inheritance
    Object
    ConditionBase
    Condition
    Condition<Int32>
    AlignmentCondition
    Inherited Members
    Condition.traitName
    ConditionBase.proxy
    ConditionBase.drawWarning
    ConditionBase.OnValidate()
    Namespace: Unity.MARS
    Syntax
    [ComponentTooltip("Requires the object (a surface) to have the specified alignment (horizontal, vertical, or other).")]
    [MonoBehaviourComponentMenu(typeof(AlignmentCondition), "Condition/Alignment")]
    [CreateFromDataOptions(0, true)]
    public class AlignmentCondition : Condition<int>, ISimulatable, ICondition<int>, ICondition, IConditionBase, IRequiresTraits<int>, IRequiresTraits, ICreateFromData

    Properties

    alignment

    Declaration
    public MarsPlaneAlignment alignment { get; set; }
    Property Value
    Type Description
    MarsPlaneAlignment

    Methods

    FormatDataString(TraitDataSnapshot)

    Declaration
    public string FormatDataString(TraitDataSnapshot data)
    Parameters
    Type Name Description
    TraitDataSnapshot data
    Returns
    Type Description
    String
    Implements
    ICreateFromData.FormatDataString(TraitDataSnapshot)

    GetConditionRatingForData(TraitDataSnapshot)

    Declaration
    public float GetConditionRatingForData(TraitDataSnapshot data)
    Parameters
    Type Name Description
    TraitDataSnapshot data
    Returns
    Type Description
    Single
    Implements
    ICreateFromData.GetConditionRatingForData(TraitDataSnapshot)

    GetRequiredTraits()

    Declaration
    public override TraitRequirement[] GetRequiredTraits()
    Returns
    Type Description
    TraitRequirement[]
    Overrides
    Condition.GetRequiredTraits()

    IncludeData(TraitDataSnapshot)

    Declaration
    public void IncludeData(TraitDataSnapshot data)
    Parameters
    Type Name Description
    TraitDataSnapshot data
    Implements
    ICreateFromData.IncludeData(TraitDataSnapshot)

    OptimizeForData(TraitDataSnapshot)

    Declaration
    public void OptimizeForData(TraitDataSnapshot data)
    Parameters
    Type Name Description
    TraitDataSnapshot data
    Implements
    ICreateFromData.OptimizeForData(TraitDataSnapshot)

    RateDataMatch(ref Int32)

    Declaration
    public override float RateDataMatch(ref int data)
    Parameters
    Type Name Description
    Int32 data
    Returns
    Type Description
    Single
    Overrides
    Unity.MARS.Condition<System.Int32>.RateDataMatch(System.Int32)

    Extension Methods

    IRequiresTraitsMethods.TryGetTraitValue<T>(IRequiresTraits<T>, Int32, String, out T)
    IRequiresTraitsMethods.TryGetAllTraitsWithSemanticTag<T>(IRequiresTraits<T>, String, String, out Dictionary<Int32, T>)
    IRequiresTraitsMethods.ForEachContextIdWithTrait<T>(IRequiresTraits<T>, String, Action<Int32>)
    IConditionGenericMethods.PassesCondition<T>(ICondition<T>, ref T)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023