Skip to content

Commit 4954551

Browse files
authored
Adjust method comments
1 parent 1a373df commit 4954551

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Example Project/Assets/Scripts/AnimationManager.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ public enum AnimationError {
3131
}
3232

3333
/// <summary>
34-
/// Plays the Animation with the given name on the given layer and with the given startTime,
35-
/// if it isn't already playing and if it actually exist on the given Layer and Animator.
34+
/// Plays the animation with the given name on the given layer and with the given startTime,
35+
/// if it isn't already playing and if it actually exist on the given layer and animator.
3636
/// </summary>
37-
/// <param name="animator">Animator we wan't to call the Animations on.</param>
38-
/// <param name="newAnimation">Name of the Animation we wan't to play.</param>
39-
/// <param name="delayTime">Time until we want to start the Animation.</param>
40-
/// <param name="startTime">Time we want to start the Animation from.</param>
41-
/// <param name="layer">Layer we find the given Animation Name on.</param>
42-
/// <returns>AnimationError with all possible Error States of the function.</returns>
37+
/// <param name="animator">Animator we wan't to call the animations on.</param>
38+
/// <param name="newAnimation">Name of the animation we wan't to play.</param>
39+
/// <param name="delayTime">Time until we want to start the animation.</param>
40+
/// <param name="startTime">Time we want to start the animation from.</param>
41+
/// <param name="layer">Layer we find the given animation name on.</param>
42+
/// <returns>AnimationError, showing wheter and how playing the file failed.</returns>
4343
private AnimationError PlayAnimation(Animator animator, string newAnimation, float delayTime = 0.0f, float startTime = 0.0f, int layer = 0) {
4444
AnimationError message = AnimationError.OK;
4545

@@ -75,11 +75,11 @@ private AnimationError PlayAnimation(Animator animator, string newAnimation, fl
7575
}
7676

7777
/// <summary>
78-
/// Check if the given Animator acutally contains the given AnimationClip.
78+
/// Check if the given animator acutally contains the given animationClip.
7979
/// </summary>
8080
/// <param name="animator">Animator component to get all animationclips from.</param>
8181
/// <param name="newAnimation">Animation Name we want to check for.</param>
82-
/// <returns>Boolean that is true if any clips in the given Animator have the given name.</returns>
82+
/// <returns>Wheter any clips in the given animator have the given name.</returns>
8383
private bool AnimationExists(Animator animator, string newAnimation) {
8484
// Fetch all Animations from the given Animator.
8585
AnimationClip[] allclips = animator.runtimeAnimatorController.animationClips;
@@ -89,7 +89,7 @@ private bool AnimationExists(Animator animator, string newAnimation) {
8989
}
9090

9191
/// <summary>
92-
/// Get the Length of the Animation that is playing currently on the given Animator in the given Layer.
92+
/// Get the length of the animation that is playing currently on the given animator in the given Layer.
9393
/// </summary>
9494
/// <param name="animator">Animator component to get all animationclips from.</param>
9595
/// <param name="layer">Layer we find the currently playing Animation on.</param>

0 commit comments

Comments
 (0)