FiniteTimeAction.xml 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. <Type Name="FiniteTimeAction" FullName="Urho.Actions.FiniteTimeAction">
  2. <TypeSignature Language="C#" Value="public abstract class FiniteTimeAction : Urho.Actions.BaseAction" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit FiniteTimeAction extends Urho.Actions.BaseAction" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Actions.BaseAction</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>Base class for actions that have a time duration.</summary>
  14. <remarks>
  15. <para />
  16. </remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="protected FiniteTimeAction ();" />
  21. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters />
  27. <Docs>
  28. <summary>Initializes the action with a duration of zero.</summary>
  29. <remarks>To be added.</remarks>
  30. </Docs>
  31. </Member>
  32. <Member MemberName=".ctor">
  33. <MemberSignature Language="C#" Value="protected FiniteTimeAction (float duration);" />
  34. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(float32 duration) cil managed" />
  35. <MemberType>Constructor</MemberType>
  36. <AssemblyInfo>
  37. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  38. </AssemblyInfo>
  39. <Parameters>
  40. <Parameter Name="duration" Type="System.Single" />
  41. </Parameters>
  42. <Docs>
  43. <param name="duration">To be added.</param>
  44. <summary>Initializes the action with the specified duration in seconds.</summary>
  45. <remarks>To be added.</remarks>
  46. </Docs>
  47. </Member>
  48. <Member MemberName="Duration">
  49. <MemberSignature Language="C#" Value="public virtual float Duration { get; set; }" />
  50. <MemberSignature Language="ILAsm" Value=".property instance float32 Duration" />
  51. <MemberType>Property</MemberType>
  52. <AssemblyInfo>
  53. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  54. </AssemblyInfo>
  55. <ReturnValue>
  56. <ReturnType>System.Single</ReturnType>
  57. </ReturnValue>
  58. <Docs>
  59. <summary>Duration of the action.</summary>
  60. <value>To be added.</value>
  61. <remarks>To be added.</remarks>
  62. </Docs>
  63. </Member>
  64. <Member MemberName="Reverse">
  65. <MemberSignature Language="C#" Value="public abstract Urho.Actions.FiniteTimeAction Reverse ();" />
  66. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Urho.Actions.FiniteTimeAction Reverse() cil managed" />
  67. <MemberType>Method</MemberType>
  68. <AssemblyInfo>
  69. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  70. </AssemblyInfo>
  71. <ReturnValue>
  72. <ReturnType>Urho.Actions.FiniteTimeAction</ReturnType>
  73. </ReturnValue>
  74. <Parameters />
  75. <Docs>
  76. <summary>Subclasses should return the inverse of the operation.</summary>
  77. <returns>To be added.</returns>
  78. <remarks>To be added.</remarks>
  79. </Docs>
  80. </Member>
  81. <Member MemberName="StartAction">
  82. <MemberSignature Language="C#" Value="protected override Urho.Actions.ActionState StartAction (Urho.Node target);" />
  83. <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance class Urho.Actions.ActionState StartAction(class Urho.Node target) cil managed" />
  84. <MemberType>Method</MemberType>
  85. <AssemblyInfo>
  86. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  87. </AssemblyInfo>
  88. <ReturnValue>
  89. <ReturnType>Urho.Actions.ActionState</ReturnType>
  90. </ReturnValue>
  91. <Parameters>
  92. <Parameter Name="target" Type="Urho.Node" />
  93. </Parameters>
  94. <Docs>
  95. <param name="target">
  96. <para>The new <see cref="T:Urho.Actions.ActionState" /> that encapsulates the state and provides the implementation to perform your action.</para>
  97. </param>
  98. <summary>Creates the action state for this action, called on demand from the framework to start executing the recipe.</summary>
  99. <returns>To be added.</returns>
  100. <remarks>New action that will perform the inverse of this action</remarks>
  101. </Docs>
  102. </Member>
  103. </Members>
  104. </Type>