 | Shake2D Class |
An object that can shake a Vector2 over time.
Inheritance HierarchyNamespace: Archon.SwissArmyLib.Utils.Shake
Assembly: Archon.SwissArmyLib (in Archon.SwissArmyLib.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe Shake2D type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Amplitude |
Gets the amplitude of the shake.
(Inherited from BaseShakeT.) |
 | CurrentTime |
Gets the current scaled or unscaled time.
(Inherited from BaseShakeT.) |
| Duration |
Gets how long the shake last.
(Inherited from BaseShakeT.) |
| Frequency |
Gets the frequency of the shake.
(Inherited from BaseShakeT.) |
| IsDone |
Gets whether the shake is done.
(Inherited from BaseShakeT.) |
| NormalizedTime |
Gets the shake's current progress in the range 0 to 1.
(Inherited from BaseShakeT.) |
| StartTime |
Gets or sets the time that the shake started.
(Inherited from BaseShakeT.) |
| UnscaledTime |
Gets or sets whether the shake should use time or unscaledTime.
(Inherited from BaseShakeT.) |
Methods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified Object is equal to the current Object. (Inherited from 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.) |
| GetAmplitude |
Gets the amplitude at the current time.
(Inherited from BaseShakeT.) |
| GetAmplitude(Single) |
Gets the amplitude at a specific (normalized) time.
(Overrides BaseShakeTGetAmplitude(Single).) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Start |
Starts (or restarts) the shake with new parameters.
(Overrides BaseShakeTStart(Single, Int32, Single).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | Horizontal |
The shake used for shaking the x value of the Vector2.
|
| Vertical |
The shake used for shaking the y value of the Vector2.
|
See Also