Skip to content
This repository has been archived by the owner on Jan 9, 2022. It is now read-only.

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillemsc committed Oct 22, 2020
1 parent a93e5fa commit 805d75d
Show file tree
Hide file tree
Showing 59 changed files with 1,608 additions and 32 deletions.
8 changes: 8 additions & 0 deletions Editor/Documentation/AudioSource.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 54 additions & 0 deletions Editor/Documentation/AudioSource/AudioSourcePitchDocumentation.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
using System;
using UnityEditor;
using UnityEngine;

namespace Juce.Feedbacks
{
public class AudioSourcePitchDocumentation : IFeedbackDocumentation
{
public Type FeedbackType => typeof(AudioSourcePitchFeedback);

public void DrawDocumentation()
{
GUILayout.Label("Changes the target AudioSource pitch value", EditorStyles.wordWrappedLabel);

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("- Target: AudioSource component that is going to be affected", EditorStyles.wordWrappedLabel);
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("- Use Starting Value: enables the starting pitch", EditorStyles.wordWrappedLabel);
GUILayout.Label("- Start: (if enabled) starting pitch value", EditorStyles.wordWrappedLabel);
GUILayout.Label("- End: end pitch value to reach", EditorStyles.wordWrappedLabel);
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.DelayDocumentation();
GenericsDocumentation.DurationDocumentation();
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.EasingDocumentation();
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.LoopDocumentation();
}

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("Sequencing:");
GenericsDocumentation.SameTimeSequencingDocumentation();
}
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

47 changes: 47 additions & 0 deletions Editor/Documentation/AudioSource/AudioSourcePlayDocumentation.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
using System;
using UnityEditor;
using UnityEngine;

namespace Juce.Feedbacks
{
public class AudioSourcePlayDocumentation : IFeedbackDocumentation
{
public Type FeedbackType => typeof(AudioSourcePlayFeedback);

public void DrawDocumentation()
{
GUILayout.Label("Plays an AudioSource", EditorStyles.wordWrappedLabel);

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("- Target: AudioSource component that is going to be affected", EditorStyles.wordWrappedLabel);
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("- Audio Clip: clip to be played", EditorStyles.wordWrappedLabel);
GUILayout.Label("- One Shot: does not cancel clips that are already being played if enabled", EditorStyles.wordWrappedLabel);
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.DelayDocumentation();
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.LoopDocumentation();
}

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("Sequencing:");
GenericsDocumentation.SameTimeSequencingDocumentation();
}
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 41 additions & 0 deletions Editor/Documentation/AudioSource/AudioSourceStopDocumentation.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
using System;
using UnityEditor;
using UnityEngine;

namespace Juce.Feedbacks
{
public class AudioSourceStopDocumentation : IFeedbackDocumentation
{
public Type FeedbackType => typeof(AudioSourceStopFeedback);

public void DrawDocumentation()
{
GUILayout.Label("Stops an AudioSource", EditorStyles.wordWrappedLabel);

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("- Target: AudioSource component that is going to be affected", EditorStyles.wordWrappedLabel);
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.DelayDocumentation();
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.LoopDocumentation();
}

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("Sequencing:");
GenericsDocumentation.SameTimeSequencingDocumentation();
}
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 54 additions & 0 deletions Editor/Documentation/AudioSource/AudioSourceVolumeDocumentation.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
using System;
using UnityEditor;
using UnityEngine;

namespace Juce.Feedbacks
{
public class AudioSourceVolumeDocumentation : IFeedbackDocumentation
{
public Type FeedbackType => typeof(AudioSourceVolumeFeedback);

public void DrawDocumentation()
{
GUILayout.Label("Changes the target AudioSource volume value", EditorStyles.wordWrappedLabel);

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("- Target: AudioSource component that is going to be affected", EditorStyles.wordWrappedLabel);
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("- Use Starting Value: enables the starting volume", EditorStyles.wordWrappedLabel);
GUILayout.Label("- Start: (if enabled) starting volume value", EditorStyles.wordWrappedLabel);
GUILayout.Label("- End: end volume value to reach", EditorStyles.wordWrappedLabel);
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.DelayDocumentation();
GenericsDocumentation.DurationDocumentation();
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.EasingDocumentation();
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.LoopDocumentation();
}

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("Sequencing:");
GenericsDocumentation.SameTimeSequencingDocumentation();
}
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Editor/Documentation/Debug.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 36 additions & 0 deletions Editor/Documentation/Debug/DebugLogDocumentation.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
using System;
using UnityEditor;
using UnityEngine;

namespace Juce.Feedbacks
{
public class DebugLogDocumentation : IFeedbackDocumentation
{
public Type FeedbackType => typeof(DebugLogFeedback);

public void DrawDocumentation()
{
GUILayout.Label("Prints a log to the Unity console", EditorStyles.wordWrappedLabel);

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("- Log: string to print on the console", EditorStyles.wordWrappedLabel);
}

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GenericsDocumentation.DelayDocumentation();
}

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("Sequencing:");
GenericsDocumentation.SameTimeSequencingDocumentation();
}
}
}
}
11 changes: 11 additions & 0 deletions Editor/Documentation/Debug/DebugLogDocumentation.cs.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Editor/Documentation/Flow.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions Editor/Documentation/Flow/LoopDocumentation.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
using System;
using UnityEditor;
using UnityEngine;

namespace Juce.Feedbacks
{
public class LoopDocumentation : IFeedbackDocumentation
{
public Type FeedbackType => typeof(LoopFeedback);

public void DrawDocumentation()
{
GUILayout.Label("Loops feedbacks that are over this feedback. If there is a LoopStartFeedback (not mandatory) " +
"on top, it will only loop the feedbacks that are in between the two. If there is a NewSequenceFeedback, " +
"it will only loop the feedbacks that are in between the two.", EditorStyles.wordWrappedLabel);

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("Sequencing:");
GenericsDocumentation.SameTimeSequencingDocumentation();
}
}
}
}
11 changes: 11 additions & 0 deletions Editor/Documentation/Flow/LoopDocumentation.cs.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions Editor/Documentation/Flow/NewSequenceDocumentation.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
using System;
using UnityEditor;
using UnityEngine;

namespace Juce.Feedbacks
{
public class NewSequenceDocumentation : IFeedbackDocumentation
{
public Type FeedbackType => typeof(NewSequenceFeedback);

public void DrawDocumentation()
{
GUILayout.Label("Normally, all feedbacks play at the same time. If you add this feedback, " +
"it will wait for all the feedbacks above to finish, before starting with the " +
"feedbacks that are under it", EditorStyles.wordWrappedLabel);

EditorGUILayout.Space(2);

using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
{
GUILayout.Label("Sequencing:");
GenericsDocumentation.SameTimeSequencingDocumentation();
}
}
}
}
Loading

0 comments on commit 805d75d

Please sign in to comment.