diff --git a/Assets/Fungus/Audio/Scripts/Commands/PlayUsfxrSound.cs b/Assets/Fungus/Audio/Scripts/Commands/PlayUsfxrSound.cs index c61a96b1..8f3c6733 100644 --- a/Assets/Fungus/Audio/Scripts/Commands/PlayUsfxrSound.cs +++ b/Assets/Fungus/Audio/Scripts/Commands/PlayUsfxrSound.cs @@ -6,10 +6,17 @@ "Play Usfxr Sound", "Plays a usfxr synth sound. Use the usfxr editor [Tools > Fungus > Utilities > Generate usfxr Sound Effects] to create the SettingsString. Set a ParentTransform if using positional sound. See https://github.com/zeh/usfxr for more information about usfxr.")] [AddComponentMenu("")] - public class PlayUsfxrSound : Command { + public class PlayUsfxrSound : Command + { protected SfxrSynth _synth = new SfxrSynth(); + + [Tooltip("Transform to use for positional audio")] public Transform ParentTransform = null; - public String SettingsString = ""; + + [Tooltip("Settings string which describes the audio")] + public String SettingsString = ""; + + [Tooltip("Time to wait before executing the next command")] public float waitDuration = 0; //Call this if the settings have changed diff --git a/Assets/Fungus/Flowchart/Scripts/Commands/DebugLog.cs b/Assets/Fungus/Flowchart/Scripts/Commands/DebugLog.cs index 46086af5..9b59c1b0 100644 --- a/Assets/Fungus/Flowchart/Scripts/Commands/DebugLog.cs +++ b/Assets/Fungus/Flowchart/Scripts/Commands/DebugLog.cs @@ -16,8 +16,10 @@ namespace Fungus Error } + [Tooltip("Display type of debug log info")] public DebugLogType logType; + [Tooltip("Text to write to the debug log. Supports variable substitution, e.g. {$Myvar}")] public StringData logMessage; public override void OnEnter () diff --git a/Assets/Fungus/Flowchart/Scripts/Commands/Jump.cs b/Assets/Fungus/Flowchart/Scripts/Commands/Jump.cs index c2489821..06e19749 100644 --- a/Assets/Fungus/Flowchart/Scripts/Commands/Jump.cs +++ b/Assets/Fungus/Flowchart/Scripts/Commands/Jump.cs @@ -10,6 +10,7 @@ namespace Fungus [AddComponentMenu("")] public class Jump : Command { + [Tooltip("Label to jump to")] public Label targetLabel; public override void OnEnter() diff --git a/Assets/Fungus/Flowchart/Scripts/Commands/Label.cs b/Assets/Fungus/Flowchart/Scripts/Commands/Label.cs index 5455f3de..a5c3754c 100644 --- a/Assets/Fungus/Flowchart/Scripts/Commands/Label.cs +++ b/Assets/Fungus/Flowchart/Scripts/Commands/Label.cs @@ -10,6 +10,7 @@ namespace Fungus [AddComponentMenu("")] public class Label : Command { + [Tooltip("Display name for the label")] public string key = ""; public override void OnEnter() diff --git a/Assets/Fungus/Flowchart/Scripts/Commands/SendMessage.cs b/Assets/Fungus/Flowchart/Scripts/Commands/SendMessage.cs index 30632f41..75effc67 100644 --- a/Assets/Fungus/Flowchart/Scripts/Commands/SendMessage.cs +++ b/Assets/Fungus/Flowchart/Scripts/Commands/SendMessage.cs @@ -5,7 +5,7 @@ namespace Fungus { [CommandInfo("Flow", "Send Message", - "Sends a message to either the owner Flowchart or all Flowcharts in the scene. Blocks can listen for this message to start execution.")] + "Sends a message to either the owner Flowchart or all Flowcharts in the scene. Blocks can listen for this message using a Message Received event handler.")] [AddComponentMenu("")] public class SendMessage : Command { @@ -15,7 +15,10 @@ namespace Fungus AllFlowcharts } + [Tooltip("Target flowchart(s) to send the message to")] public MessageTarget messageTarget; + + [Tooltip("Name of the message to send")] public string message = ""; public override void OnEnter() diff --git a/Assets/Fungus/Flowchart/Scripts/EventHandlers/KeyPressed.cs b/Assets/Fungus/Flowchart/Scripts/EventHandlers/KeyPressed.cs index b62e6c74..cee5de5b 100644 --- a/Assets/Fungus/Flowchart/Scripts/EventHandlers/KeyPressed.cs +++ b/Assets/Fungus/Flowchart/Scripts/EventHandlers/KeyPressed.cs @@ -16,8 +16,10 @@ namespace Fungus KeyRepeat // Execute once per frame when key is held down } + [Tooltip("The type of keypress to activate on")] public KeyPressType keyPressType; + [Tooltip("Keycode of the key to activate on")] public KeyCode keyCode; protected virtual void Update() diff --git a/Assets/Fungus/Flowchart/Scripts/EventHandlers/MessageReceived.cs b/Assets/Fungus/Flowchart/Scripts/EventHandlers/MessageReceived.cs index 940dd165..91ae6707 100644 --- a/Assets/Fungus/Flowchart/Scripts/EventHandlers/MessageReceived.cs +++ b/Assets/Fungus/Flowchart/Scripts/EventHandlers/MessageReceived.cs @@ -9,6 +9,7 @@ namespace Fungus [AddComponentMenu("")] public class MessageReceived : EventHandler { + [Tooltip("Fungus message to listen for")] public string message = ""; public void OnSendFungusMessage(string message) diff --git a/Assets/Fungus/Narrative/Scripts/Commands/MenuTimer.cs b/Assets/Fungus/Narrative/Scripts/Commands/MenuTimer.cs index c2720432..dbee1b84 100644 --- a/Assets/Fungus/Narrative/Scripts/Commands/MenuTimer.cs +++ b/Assets/Fungus/Narrative/Scripts/Commands/MenuTimer.cs @@ -13,9 +13,11 @@ namespace Fungus [AddComponentMenu("")] public class MenuTimer : Command { + [Tooltip("Length of time to display the timer for")] public float duration; [FormerlySerializedAs("targetSequence")] + [Tooltip("Block to execute when the timer expires")] public Block targetBlock; public override void OnEnter() diff --git a/Assets/Fungus/Narrative/Scripts/Commands/SetLanguage.cs b/Assets/Fungus/Narrative/Scripts/Commands/SetLanguage.cs index 57be8053..3b1fcfe2 100644 --- a/Assets/Fungus/Narrative/Scripts/Commands/SetLanguage.cs +++ b/Assets/Fungus/Narrative/Scripts/Commands/SetLanguage.cs @@ -9,6 +9,7 @@ namespace Fungus [AddComponentMenu("")] public class SetLanguage : Command { + [Tooltip("Code of the language to set. e.g. ES, DE, JA")] public string languageCode; public override void OnEnter() diff --git a/Assets/Fungus/Narrative/Scripts/Commands/SetMenuDialog.cs b/Assets/Fungus/Narrative/Scripts/Commands/SetMenuDialog.cs index 66236962..cf0cc93c 100644 --- a/Assets/Fungus/Narrative/Scripts/Commands/SetMenuDialog.cs +++ b/Assets/Fungus/Narrative/Scripts/Commands/SetMenuDialog.cs @@ -10,6 +10,7 @@ namespace Fungus [AddComponentMenu("")] public class SetMenuDialog : Command { + [Tooltip("The Menu Dialog to use for displaying menu buttons")] public MenuDialog menuDialog; public override void OnEnter() diff --git a/Assets/Fungus/Narrative/Scripts/Commands/SetSayDialog.cs b/Assets/Fungus/Narrative/Scripts/Commands/SetSayDialog.cs index 61ea2c74..3bfc9b46 100644 --- a/Assets/Fungus/Narrative/Scripts/Commands/SetSayDialog.cs +++ b/Assets/Fungus/Narrative/Scripts/Commands/SetSayDialog.cs @@ -10,6 +10,7 @@ namespace Fungus [AddComponentMenu("")] public class SetSayDialog : Command { + [Tooltip("The Say Dialog to use for displaying Say story text")] public SayDialog sayDialog; public override void OnEnter() diff --git a/Assets/Fungus/Sprite/Scripts/Commands/FadeSprite.cs b/Assets/Fungus/Sprite/Scripts/Commands/FadeSprite.cs index 613b23d0..e5647529 100644 --- a/Assets/Fungus/Sprite/Scripts/Commands/FadeSprite.cs +++ b/Assets/Fungus/Sprite/Scripts/Commands/FadeSprite.cs @@ -10,9 +10,16 @@ namespace Fungus [AddComponentMenu("")] public class FadeSprite : Command { + [Tooltip("Sprite object to be faded")] public SpriteRenderer spriteRenderer; + + [Tooltip("Length of time to perform the fade")] public float duration = 1f; + + [Tooltip("Target color to fade to. To only fade transparency level, set the color to white and set the alpha to required transparency.")] public Color targetColor = Color.white; + + [Tooltip("Wait until the fade has finished before executing the next command")] public bool waitUntilFinished = true; public override void OnEnter() diff --git a/Assets/Fungus/Sprite/Scripts/Commands/ShowSprite.cs b/Assets/Fungus/Sprite/Scripts/Commands/ShowSprite.cs index 357bace7..7bbd0ddd 100644 --- a/Assets/Fungus/Sprite/Scripts/Commands/ShowSprite.cs +++ b/Assets/Fungus/Sprite/Scripts/Commands/ShowSprite.cs @@ -10,7 +10,10 @@ namespace Fungus [AddComponentMenu("")] public class ShowSprite : Command { + [Tooltip("Sprite object to be made visible / invisible")] public SpriteRenderer spriteRenderer; + + [Tooltip("Make the sprite visible or invisible")] public bool visible = true; public override void OnEnter() diff --git a/Assets/Fungus/Sprite/Scripts/EventHandlers/DragCancelled.cs b/Assets/Fungus/Sprite/Scripts/EventHandlers/DragCancelled.cs index 5fd0b2e2..a0fca947 100644 --- a/Assets/Fungus/Sprite/Scripts/EventHandlers/DragCancelled.cs +++ b/Assets/Fungus/Sprite/Scripts/EventHandlers/DragCancelled.cs @@ -11,6 +11,7 @@ namespace Fungus [AddComponentMenu("")] public class DragCancelled : EventHandler { + [Tooltip("Draggable object to listen for drag events on")] public Draggable2D draggableObject; public virtual void OnDragCancelled(Draggable2D draggableObject) diff --git a/Assets/Fungus/Sprite/Scripts/EventHandlers/DragCompleted.cs b/Assets/Fungus/Sprite/Scripts/EventHandlers/DragCompleted.cs index 83fdedf0..6c355dc0 100644 --- a/Assets/Fungus/Sprite/Scripts/EventHandlers/DragCompleted.cs +++ b/Assets/Fungus/Sprite/Scripts/EventHandlers/DragCompleted.cs @@ -11,7 +11,10 @@ namespace Fungus [AddComponentMenu("")] public class DragCompleted : EventHandler { + [Tooltip("Draggable object to listen for drag events on")] public Draggable2D draggableObject; + + [Tooltip("Drag target object to listen for drag events on")] public Collider2D targetObject; // There's no way to poll if an object is touching another object, so diff --git a/Assets/Fungus/Sprite/Scripts/EventHandlers/DragEntered.cs b/Assets/Fungus/Sprite/Scripts/EventHandlers/DragEntered.cs index ff27bf04..d6772cf4 100644 --- a/Assets/Fungus/Sprite/Scripts/EventHandlers/DragEntered.cs +++ b/Assets/Fungus/Sprite/Scripts/EventHandlers/DragEntered.cs @@ -12,7 +12,10 @@ namespace Fungus [AddComponentMenu("")] public class DragEntered : EventHandler { + [Tooltip("Draggable object to listen for drag events on")] public Draggable2D draggableObject; + + [Tooltip("Drag target object to listen for drag events on")] public Collider2D targetObject; public virtual void OnDragEntered(Draggable2D draggableObject, Collider2D targetObject) diff --git a/Assets/Fungus/Sprite/Scripts/EventHandlers/DragExited.cs b/Assets/Fungus/Sprite/Scripts/EventHandlers/DragExited.cs index e52e12b6..a600ea8c 100644 --- a/Assets/Fungus/Sprite/Scripts/EventHandlers/DragExited.cs +++ b/Assets/Fungus/Sprite/Scripts/EventHandlers/DragExited.cs @@ -12,7 +12,10 @@ namespace Fungus [AddComponentMenu("")] public class DragExited : EventHandler { + [Tooltip("Draggable object to listen for drag events on")] public Draggable2D draggableObject; + + [Tooltip("Drag target object to listen for drag events on")] public Collider2D targetObject; public virtual void OnDragExited(Draggable2D draggableObject, Collider2D targetObject)