urho3d.UrhoSharp/docs/Urho.Actions/ActionManager.xml

<Type Name="ActionManager" FullName="Urho.Actions.ActionManager">
  <TypeSignature Language="C#" Value="public class ActionManager : IDisposable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ActionManager extends System.Object implements class System.IDisposable" />
  <AssemblyInfo>
    <AssemblyName>Urho</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>The manager for all executing actions.</summary>
    <remarks>
      <para>This class manages all the executing actions.   The provided interface can be used to query and probe the running actions.</para>
      <para />
      <para>This class is a singleton.</para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ActionManager ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Constructor, instantiated internally.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddAction">
      <MemberSignature Language="C#" Value="public Urho.Actions.ActionState AddAction (Urho.Actions.BaseAction action, Urho.Node target, bool paused = false);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Actions.ActionState AddAction(class Urho.Actions.BaseAction action, class Urho.Node target, bool paused) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.Actions.ActionState</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="action" Type="Urho.Actions.BaseAction" />
        <Parameter Name="target" Type="Urho.Node" />
        <Parameter Name="paused" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="action">To be added.</param>
        <param name="target">To be added.</param>
        <param name="paused">To be added.</param>
        <summary>Low-level: adds the specified action to the node.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Releases the resources of the action manager.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="disposing">To be added.</param>
        <summary>Releases the resources of the action manager.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Finalize">
      <MemberSignature Language="C#" Value="~ActionManager ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Finalizer</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetAction">
      <MemberSignature Language="C#" Value="public Urho.Actions.BaseAction GetAction (int tag, Urho.Node target);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Actions.BaseAction GetAction(int32 tag, class Urho.Node target) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.Actions.BaseAction</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tag" Type="System.Int32" />
        <Parameter Name="target" Type="Urho.Node" />
      </Parameters>
      <Docs>
        <param name="tag">To be added.</param>
        <param name="target">To be added.</param>
        <summary>Returns the action that has the specified tag ID on the specified target.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetActionState">
      <MemberSignature Language="C#" Value="public Urho.Actions.ActionState GetActionState (int tag, Urho.Node target);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Actions.ActionState GetActionState(int32 tag, class Urho.Node target) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.Actions.ActionState</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tag" Type="System.Int32" />
        <Parameter Name="target" Type="Urho.Node" />
      </Parameters>
      <Docs>
        <param name="tag">To be added.</param>
        <param name="target">To be added.</param>
        <summary>Returns the ActionState associated with the specified tag ID on the specified target.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NumberOfRunningActionsInTarget">
      <MemberSignature Language="C#" Value="public int NumberOfRunningActionsInTarget (Urho.Node target);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 NumberOfRunningActionsInTarget(class Urho.Node target) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="target" Type="Urho.Node" />
      </Parameters>
      <Docs>
        <param name="target">To be added.</param>
        <summary>Returns the number of actions executing on the given target</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PauseAllRunningActions">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.List&lt;object&gt; PauseAllRunningActions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.List`1&lt;object&gt; PauseAllRunningActions() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.List&lt;System.Object&gt;</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Pauses all the running actions and returns a list of the elements that were paused.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PauseTarget">
      <MemberSignature Language="C#" Value="public void PauseTarget (Urho.Node target);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PauseTarget(class Urho.Node target) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="target" Type="Urho.Node" />
      </Parameters>
      <Docs>
        <param name="target">To be added.</param>
        <summary>Pauses the specified target.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RemoveAction">
      <MemberSignature Language="C#" Value="public void RemoveAction (Urho.Actions.ActionState actionState);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveAction(class Urho.Actions.ActionState actionState) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="actionState" Type="Urho.Actions.ActionState" />
      </Parameters>
      <Docs>
        <param name="actionState">To be added.</param>
        <summary>Removes a specific action that is currently executing (based on its actionState).</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RemoveAction">
      <MemberSignature Language="C#" Value="public void RemoveAction (int tag, Urho.Node target);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveAction(int32 tag, class Urho.Node target) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tag" Type="System.Int32" />
        <Parameter Name="target" Type="Urho.Node" />
      </Parameters>
      <Docs>
        <param name="tag">To be added.</param>
        <param name="target">To be added.</param>
        <summary>Removes the specified action from a node, using a tag ID.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RemoveAllActions">
      <MemberSignature Language="C#" Value="public void RemoveAllActions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveAllActions() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Removes all running actions.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RemoveAllActionsFromTarget">
      <MemberSignature Language="C#" Value="public void RemoveAllActionsFromTarget (Urho.Node target);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveAllActionsFromTarget(class Urho.Node target) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="target" Type="Urho.Node" />
      </Parameters>
      <Docs>
        <param name="target">To be added.</param>
        <summary>Removes all running actions from a specific node.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResumeTarget">
      <MemberSignature Language="C#" Value="public void ResumeTarget (Urho.Node target);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResumeTarget(class Urho.Node target) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="target" Type="Urho.Node" />
      </Parameters>
      <Docs>
        <param name="target">To be added.</param>
        <summary>Resumes the actions on the specified node.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResumeTargets">
      <MemberSignature Language="C#" Value="public void ResumeTargets (System.Collections.Generic.List&lt;Urho.Node&gt; targetsToResume);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResumeTargets(class System.Collections.Generic.List`1&lt;class Urho.Node&gt; targetsToResume) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="targetsToResume" Type="System.Collections.Generic.List&lt;Urho.Node&gt;" />
      </Parameters>
      <Docs>
        <param name="targetsToResume">To be added.</param>
        <summary>Resumes all the targets in the provided list.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Update">
      <MemberSignature Language="C#" Value="public void Update (float dt);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Update(float32 dt) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="dt" Type="System.Single" />
      </Parameters>
      <Docs>
        <param name="dt">To be added.</param>
        <summary>Action tick method, invoked externally.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>