docs.unity3d.com
    Show / Hide Table of Contents

    Interface IActionReceiver

    An interface that describes an object that can receive actions from a Reinforcement Learning network.

    Namespace: Unity.MLAgents.Actuators
    Syntax
    public interface IActionReceiver

    Methods

    OnActionReceived(ActionBuffers)

    Method called in order too allow object to execute actions based on the ActionBuffers contents. The structure of the contents in the ActionBuffers are defined by the ActionSpec.

    Declaration
    void OnActionReceived(ActionBuffers actionBuffers)
    Parameters
    Type Name Description
    ActionBuffers actionBuffers

    The data structure containing the action buffers for this object.

    WriteDiscreteActionMask(IDiscreteActionMask)

    Implement WriteDiscreteActionMask() to modify the masks for discrete actions. When using discrete actions, the agent will not perform the masked action.

    Declaration
    void WriteDiscreteActionMask(IDiscreteActionMask actionMask)
    Parameters
    Type Name Description
    IDiscreteActionMask actionMask

    The action mask for the agent.

    Remarks

    When using Discrete Control, you can prevent the Agent from using a certain action by masking it with SetActionEnabled(Int32, Int32, Boolean).

    See Agents - Actions for more information on masking actions.

    See Also
    OnActionReceived(ActionBuffers)
    Back to top
    Terms of use
    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