From df030a327d1935fc0a4308af2ded2f8a323b1c9f Mon Sep 17 00:00:00 2001 From: Christopher Date: Tue, 23 Aug 2016 15:21:46 +0100 Subject: [PATCH] Refactored iTween comments --- Assets/Fungus/iTween/Scripts/Commands/LookFrom.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/LookTo.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/MoveAdd.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/MoveFrom.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/MoveTo.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/PunchPosition.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/PunchRotation.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/PunchScale.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/RotateAdd.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/RotateFrom.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/RotateTo.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/ScaleAdd.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/ScaleFrom.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/ScaleTo.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/ShakePosition.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/ShakeRotation.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/ShakeScale.cs | 3 +++ Assets/Fungus/iTween/Scripts/Commands/StopTween.cs | 4 +++- Assets/Fungus/iTween/Scripts/Commands/StopTweens.cs | 4 +++- Assets/Fungus/iTween/Scripts/Commands/iTweenCommand.cs | 4 +++- 20 files changed, 60 insertions(+), 3 deletions(-) diff --git a/Assets/Fungus/iTween/Scripts/Commands/LookFrom.cs b/Assets/Fungus/iTween/Scripts/Commands/LookFrom.cs index 47fdbf3c..f2bad4f7 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/LookFrom.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/LookFrom.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Instantly rotates a GameObject to look at the supplied Vector3 then returns it to it's starting rotation over time. + /// [CommandInfo("iTween", "Look From", "Instantly rotates a GameObject to look at the supplied Vector3 then returns it to it's starting rotation over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/LookTo.cs b/Assets/Fungus/iTween/Scripts/Commands/LookTo.cs index 9e6871f8..d8be1cc1 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/LookTo.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/LookTo.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Rotates a GameObject to look at a supplied Transform or Vector3 over time. + /// [CommandInfo("iTween", "Look To", "Rotates a GameObject to look at a supplied Transform or Vector3 over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/MoveAdd.cs b/Assets/Fungus/iTween/Scripts/Commands/MoveAdd.cs index 3927475a..4eca0f88 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/MoveAdd.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/MoveAdd.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Moves a game object by a specified offset over time. + /// [CommandInfo("iTween", "Move Add", "Moves a game object by a specified offset over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/MoveFrom.cs b/Assets/Fungus/iTween/Scripts/Commands/MoveFrom.cs index 870d72f7..f01b6e14 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/MoveFrom.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/MoveFrom.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Moves a game object from a specified position back to its starting position over time. The position can be defined by a transform in another object (using To Transform) or by setting an absolute position (using To Position, if To Transform is set to None). + /// [CommandInfo("iTween", "Move From", "Moves a game object from a specified position back to its starting position over time. The position can be defined by a transform in another object (using To Transform) or by setting an absolute position (using To Position, if To Transform is set to None).")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/MoveTo.cs b/Assets/Fungus/iTween/Scripts/Commands/MoveTo.cs index bc89b6f4..a3e09f35 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/MoveTo.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/MoveTo.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Moves a game object to a specified position over time. The position can be defined by a transform in another object (using To Transform) or by setting an absolute position (using To Position, if To Transform is set to None). + /// [CommandInfo("iTween", "Move To", "Moves a game object to a specified position over time. The position can be defined by a transform in another object (using To Transform) or by setting an absolute position (using To Position, if To Transform is set to None).")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/PunchPosition.cs b/Assets/Fungus/iTween/Scripts/Commands/PunchPosition.cs index fa98b4fa..5d7e0f03 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/PunchPosition.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/PunchPosition.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Applies a jolt of force to a GameObject's position and wobbles it back to its initial position. + /// [CommandInfo("iTween", "Punch Position", "Applies a jolt of force to a GameObject's position and wobbles it back to its initial position.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/PunchRotation.cs b/Assets/Fungus/iTween/Scripts/Commands/PunchRotation.cs index be92547b..13a179bb 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/PunchRotation.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/PunchRotation.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Applies a jolt of force to a GameObject's rotation and wobbles it back to its initial rotation. + /// [CommandInfo("iTween", "Punch Rotation", "Applies a jolt of force to a GameObject's rotation and wobbles it back to its initial rotation.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/PunchScale.cs b/Assets/Fungus/iTween/Scripts/Commands/PunchScale.cs index 160c63d0..65237783 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/PunchScale.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/PunchScale.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Applies a jolt of force to a GameObject's scale and wobbles it back to its initial scale. + /// [CommandInfo("iTween", "Punch Scale", "Applies a jolt of force to a GameObject's scale and wobbles it back to its initial scale.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/RotateAdd.cs b/Assets/Fungus/iTween/Scripts/Commands/RotateAdd.cs index f447294d..692bdd09 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/RotateAdd.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/RotateAdd.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Rotates a game object by the specified angles over time. + /// [CommandInfo("iTween", "Rotate Add", "Rotates a game object by the specified angles over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/RotateFrom.cs b/Assets/Fungus/iTween/Scripts/Commands/RotateFrom.cs index 5366db42..5a151013 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/RotateFrom.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/RotateFrom.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Rotates a game object from the specified angles back to its starting orientation over time. + /// [CommandInfo("iTween", "Rotate From", "Rotates a game object from the specified angles back to its starting orientation over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/RotateTo.cs b/Assets/Fungus/iTween/Scripts/Commands/RotateTo.cs index dc3aaff2..eb3b9242 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/RotateTo.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/RotateTo.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Rotates a game object to the specified angles over time. + /// [CommandInfo("iTween", "Rotate To", "Rotates a game object to the specified angles over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/ScaleAdd.cs b/Assets/Fungus/iTween/Scripts/Commands/ScaleAdd.cs index 45b69091..8ffb4670 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/ScaleAdd.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/ScaleAdd.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Changes a game object's scale by a specified offset over time. + /// [CommandInfo("iTween", "Scale Add", "Changes a game object's scale by a specified offset over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/ScaleFrom.cs b/Assets/Fungus/iTween/Scripts/Commands/ScaleFrom.cs index f668d0af..9afdfc1a 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/ScaleFrom.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/ScaleFrom.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Changes a game object's scale to the specified value and back to its original scale over time. + /// [CommandInfo("iTween", "Scale From", "Changes a game object's scale to the specified value and back to its original scale over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/ScaleTo.cs b/Assets/Fungus/iTween/Scripts/Commands/ScaleTo.cs index cec361c3..aecc117a 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/ScaleTo.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/ScaleTo.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Changes a game object's scale to a specified value over time. + /// [CommandInfo("iTween", "Scale To", "Changes a game object's scale to a specified value over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/ShakePosition.cs b/Assets/Fungus/iTween/Scripts/Commands/ShakePosition.cs index a5324eaa..0b913580 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/ShakePosition.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/ShakePosition.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Randomly shakes a GameObject's position by a diminishing amount over time. + /// [CommandInfo("iTween", "Shake Position", "Randomly shakes a GameObject's position by a diminishing amount over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/ShakeRotation.cs b/Assets/Fungus/iTween/Scripts/Commands/ShakeRotation.cs index 959a195d..8f7336a8 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/ShakeRotation.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/ShakeRotation.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Randomly shakes a GameObject's rotation by a diminishing amount over time. + /// [CommandInfo("iTween", "Shake Rotation", "Randomly shakes a GameObject's rotation by a diminishing amount over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/ShakeScale.cs b/Assets/Fungus/iTween/Scripts/Commands/ShakeScale.cs index 8f6aa204..37992761 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/ShakeScale.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/ShakeScale.cs @@ -9,6 +9,9 @@ using System.Collections; namespace Fungus { + /// + /// Randomly shakes a GameObject's rotation by a diminishing amount over time. + /// [CommandInfo("iTween", "Shake Scale", "Randomly shakes a GameObject's rotation by a diminishing amount over time.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/StopTween.cs b/Assets/Fungus/iTween/Scripts/Commands/StopTween.cs index 0f06dee0..ef20e710 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/StopTween.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/StopTween.cs @@ -5,10 +5,12 @@ using UnityEngine; using UnityEngine.Serialization; -using System.Collections; namespace Fungus { + /// + /// Stops an active iTween by name. + /// [CommandInfo("iTween", "Stop Tween", "Stops an active iTween by name.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/StopTweens.cs b/Assets/Fungus/iTween/Scripts/Commands/StopTweens.cs index 3b8883aa..fa27339b 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/StopTweens.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/StopTweens.cs @@ -4,10 +4,12 @@ */ using UnityEngine; -using System.Collections; namespace Fungus { + /// + /// Stop all active iTweens in the current scene. + /// [CommandInfo("iTween", "Stop Tweens", "Stop all active iTweens in the current scene.")] diff --git a/Assets/Fungus/iTween/Scripts/Commands/iTweenCommand.cs b/Assets/Fungus/iTween/Scripts/Commands/iTweenCommand.cs index 4cb3e1d1..31e4a30f 100644 --- a/Assets/Fungus/iTween/Scripts/Commands/iTweenCommand.cs +++ b/Assets/Fungus/iTween/Scripts/Commands/iTweenCommand.cs @@ -5,7 +5,6 @@ using UnityEngine; using UnityEngine.Serialization; -using System.Collections; namespace Fungus { @@ -18,6 +17,9 @@ namespace Fungus Z } + /// + /// Abstract base class for iTween commands. + /// [ExecuteInEditMode] public abstract class iTweenCommand : Command {