ThrottlePasses Class |
Implements a 'throttle' composite. This composite limits the number of times the child
will be run within a given time span. Returns cappedStatus if limit reached, otherwise
Returns result of child
Inheritance HierarchySystemObject
TreeSharpComposite
TreeSharpGroupComposite
TreeSharpDecorator
ff14bot.BehaviorThrottlePasses
TreeSharpComposite
TreeSharpGroupComposite
TreeSharpDecorator
ff14bot.BehaviorThrottlePasses
Namespace: ff14bot.Behavior
Assembly: RebornBuddy (in RebornBuddy.exe) Version: 3.3.1; net-4.5.win32; release
SyntaxC#
public class ThrottlePasses : Decorator
The ThrottlePasses type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ThrottlePasses(Int32, Composite) |
Implements a 'throttle' composite. This composite limits the number of times the child
will be run within a given time span. Returns Failure if limit reached, otherwise
Returns result of child
|
| ThrottlePasses(TimeSpan, Composite) |
Implements a 'throttle' composite. This composite limits the number of times the child
to running once within a given time span. Returns Failure if attempted to run after
limit reached in timeframe, otherwise returns result of child
|
| ThrottlePasses(Int32, Int32, Composite) |
Implements a 'throttle' composite. This composite limits the number of times the child
will be run within a given time span. Returns Failure for attempts after limit reached,
otherwise returns result of child
|
| ThrottlePasses(Int32, TimeSpan, Composite) |
Implements a 'throttle' composite. This composite limits the number of times the child
will be run within a given time span. Returns Failure for attempts after limit reached,
otherwise returns result of child
|
| ThrottlePasses(Int32, TimeSpan, RunStatus, Composite) |
Implements a 'throttle' composite. This composite limits the number of times the child
will be run within a given time span. Returns cappedStatus for attempts after limit reached,
otherwise returns result of child
|
Properties| Name | Description | |
|---|---|---|
 | Children | (Inherited from GroupComposite.) |
 | CleanupHandlers | (Inherited from Composite.) |
| ContextChanger | (Inherited from Composite.) |
| DecoratedChild | (Inherited from Decorator.) |
| Guid | (Inherited from Composite.) |
| IsRunning | (Inherited from Composite.) |
| LastStatus | (Inherited from Composite.) |
| Limit |
maximum number of child Successes that can occur within TimeFrame
|
| Parent | (Inherited from Composite.) |
| Runner | (Inherited from Decorator.) |
| Selection | (Inherited from GroupComposite.) |
| TimeFrame |
time span that Limit child Successes can occur
|
Methods| Name | Description | |
|---|---|---|
| AddChild | (Inherited from GroupComposite.) |
 | CanRun | (Inherited from Decorator.) |
| Cleanup | (Inherited from Composite.) |
| Equals(Object) | (Inherited from Composite.) |
| Equals(Composite) | (Inherited from Composite.) |
| Execute | (Overrides DecoratorExecute(Object).) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | (Inherited from Composite.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InsertChild | (Inherited from GroupComposite.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Start | (Overrides DecoratorStart(Object).) |
| Stop | (Overrides CompositeStop(Object).) |
| Tick | (Inherited from Composite.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ExecuteCoroutine |
Executes the composite inside a coroutine.
(Defined by CommonTasks.) |
Remarks
Created 10/28/2012.
See Also