docs.unity3d.com
    Show / Hide Table of Contents

    Class IUsesMarsSceneEvaluationExtensionMethods

    Inheritance
    Object
    IUsesMarsSceneEvaluationExtensionMethods
    Namespace: Unity.MARS.Query
    Syntax
    public static class IUsesMarsSceneEvaluationExtensionMethods

    Methods

    GetEvaluationInterval(IUsesMarsSceneEvaluation)

    Get the scene evaluation interval in seconds

    Declaration
    public static float GetEvaluationInterval(this IUsesMarsSceneEvaluation caller)
    Parameters
    Type Name Description
    IUsesMarsSceneEvaluation caller
    Returns
    Type Description
    Single

    RequestSceneEvaluation(IUsesMarsSceneEvaluation, Action)

    Request that the results of all active queries be recalculated.

    Declaration
    public static MarsSceneEvaluationRequestResponse RequestSceneEvaluation(this IUsesMarsSceneEvaluation caller, Action onEvaluationComplete = null)
    Parameters
    Type Name Description
    IUsesMarsSceneEvaluation caller
    Action onEvaluationComplete

    A callback executed when the evaluation triggered by the request has completed

    Returns
    Type Description
    MarsSceneEvaluationRequestResponse

    An enum describing the system response to the request

    SetEvaluationInterval(IUsesMarsSceneEvaluation, Single)

    Set the scene evaluation interval. Will still set the interval even if not using Interval mode, but not change the mode.

    Declaration
    public static void SetEvaluationInterval(this IUsesMarsSceneEvaluation caller, float interval)
    Parameters
    Type Name Description
    IUsesMarsSceneEvaluation caller
    Single interval

    The evaluation interval in seconds

    SetEvaluationMode(IUsesMarsSceneEvaluation, MarsSceneEvaluationMode)

    Set the scheduling mode for evaluating the MARS scene. Changing the mode to EvaluateOnInterval will queue an evaluation.

    Declaration
    public static void SetEvaluationMode(this IUsesMarsSceneEvaluation caller, MarsSceneEvaluationMode mode)
    Parameters
    Type Name Description
    IUsesMarsSceneEvaluation caller
    MarsSceneEvaluationMode mode

    The mode to set

    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