Browse Source

Added missing tooltips for Commands and Event Handlers

master
chrisgregan 10 years ago
parent
commit
0e1208fd07
  1. 11
      Assets/Fungus/Audio/Scripts/Commands/PlayUsfxrSound.cs
  2. 2
      Assets/Fungus/Flowchart/Scripts/Commands/DebugLog.cs
  3. 1
      Assets/Fungus/Flowchart/Scripts/Commands/Jump.cs
  4. 1
      Assets/Fungus/Flowchart/Scripts/Commands/Label.cs
  5. 5
      Assets/Fungus/Flowchart/Scripts/Commands/SendMessage.cs
  6. 2
      Assets/Fungus/Flowchart/Scripts/EventHandlers/KeyPressed.cs
  7. 1
      Assets/Fungus/Flowchart/Scripts/EventHandlers/MessageReceived.cs
  8. 2
      Assets/Fungus/Narrative/Scripts/Commands/MenuTimer.cs
  9. 1
      Assets/Fungus/Narrative/Scripts/Commands/SetLanguage.cs
  10. 1
      Assets/Fungus/Narrative/Scripts/Commands/SetMenuDialog.cs
  11. 1
      Assets/Fungus/Narrative/Scripts/Commands/SetSayDialog.cs
  12. 7
      Assets/Fungus/Sprite/Scripts/Commands/FadeSprite.cs
  13. 3
      Assets/Fungus/Sprite/Scripts/Commands/ShowSprite.cs
  14. 1
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragCancelled.cs
  15. 3
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragCompleted.cs
  16. 3
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragEntered.cs
  17. 3
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragExited.cs

11
Assets/Fungus/Audio/Scripts/Commands/PlayUsfxrSound.cs

@ -6,10 +6,17 @@
"Play Usfxr Sound", "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.")] "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("")] [AddComponentMenu("")]
public class PlayUsfxrSound : Command { public class PlayUsfxrSound : Command
{
protected SfxrSynth _synth = new SfxrSynth(); protected SfxrSynth _synth = new SfxrSynth();
[Tooltip("Transform to use for positional audio")]
public Transform ParentTransform = null; 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; public float waitDuration = 0;
//Call this if the settings have changed //Call this if the settings have changed

2
Assets/Fungus/Flowchart/Scripts/Commands/DebugLog.cs

@ -16,8 +16,10 @@ namespace Fungus
Error Error
} }
[Tooltip("Display type of debug log info")]
public DebugLogType logType; public DebugLogType logType;
[Tooltip("Text to write to the debug log. Supports variable substitution, e.g. {$Myvar}")]
public StringData logMessage; public StringData logMessage;
public override void OnEnter () public override void OnEnter ()

1
Assets/Fungus/Flowchart/Scripts/Commands/Jump.cs

@ -10,6 +10,7 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class Jump : Command public class Jump : Command
{ {
[Tooltip("Label to jump to")]
public Label targetLabel; public Label targetLabel;
public override void OnEnter() public override void OnEnter()

1
Assets/Fungus/Flowchart/Scripts/Commands/Label.cs

@ -10,6 +10,7 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class Label : Command public class Label : Command
{ {
[Tooltip("Display name for the label")]
public string key = ""; public string key = "";
public override void OnEnter() public override void OnEnter()

5
Assets/Fungus/Flowchart/Scripts/Commands/SendMessage.cs

@ -5,7 +5,7 @@ namespace Fungus
{ {
[CommandInfo("Flow", [CommandInfo("Flow",
"Send Message", "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("")] [AddComponentMenu("")]
public class SendMessage : Command public class SendMessage : Command
{ {
@ -15,7 +15,10 @@ namespace Fungus
AllFlowcharts AllFlowcharts
} }
[Tooltip("Target flowchart(s) to send the message to")]
public MessageTarget messageTarget; public MessageTarget messageTarget;
[Tooltip("Name of the message to send")]
public string message = ""; public string message = "";
public override void OnEnter() public override void OnEnter()

2
Assets/Fungus/Flowchart/Scripts/EventHandlers/KeyPressed.cs

@ -16,8 +16,10 @@ namespace Fungus
KeyRepeat // Execute once per frame when key is held down KeyRepeat // Execute once per frame when key is held down
} }
[Tooltip("The type of keypress to activate on")]
public KeyPressType keyPressType; public KeyPressType keyPressType;
[Tooltip("Keycode of the key to activate on")]
public KeyCode keyCode; public KeyCode keyCode;
protected virtual void Update() protected virtual void Update()

1
Assets/Fungus/Flowchart/Scripts/EventHandlers/MessageReceived.cs

@ -9,6 +9,7 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class MessageReceived : EventHandler public class MessageReceived : EventHandler
{ {
[Tooltip("Fungus message to listen for")]
public string message = ""; public string message = "";
public void OnSendFungusMessage(string message) public void OnSendFungusMessage(string message)

2
Assets/Fungus/Narrative/Scripts/Commands/MenuTimer.cs

@ -13,9 +13,11 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class MenuTimer : Command public class MenuTimer : Command
{ {
[Tooltip("Length of time to display the timer for")]
public float duration; public float duration;
[FormerlySerializedAs("targetSequence")] [FormerlySerializedAs("targetSequence")]
[Tooltip("Block to execute when the timer expires")]
public Block targetBlock; public Block targetBlock;
public override void OnEnter() public override void OnEnter()

1
Assets/Fungus/Narrative/Scripts/Commands/SetLanguage.cs

@ -9,6 +9,7 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class SetLanguage : Command public class SetLanguage : Command
{ {
[Tooltip("Code of the language to set. e.g. ES, DE, JA")]
public string languageCode; public string languageCode;
public override void OnEnter() public override void OnEnter()

1
Assets/Fungus/Narrative/Scripts/Commands/SetMenuDialog.cs

@ -10,6 +10,7 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class SetMenuDialog : Command public class SetMenuDialog : Command
{ {
[Tooltip("The Menu Dialog to use for displaying menu buttons")]
public MenuDialog menuDialog; public MenuDialog menuDialog;
public override void OnEnter() public override void OnEnter()

1
Assets/Fungus/Narrative/Scripts/Commands/SetSayDialog.cs

@ -10,6 +10,7 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class SetSayDialog : Command public class SetSayDialog : Command
{ {
[Tooltip("The Say Dialog to use for displaying Say story text")]
public SayDialog sayDialog; public SayDialog sayDialog;
public override void OnEnter() public override void OnEnter()

7
Assets/Fungus/Sprite/Scripts/Commands/FadeSprite.cs

@ -10,9 +10,16 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class FadeSprite : Command public class FadeSprite : Command
{ {
[Tooltip("Sprite object to be faded")]
public SpriteRenderer spriteRenderer; public SpriteRenderer spriteRenderer;
[Tooltip("Length of time to perform the fade")]
public float duration = 1f; 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; public Color targetColor = Color.white;
[Tooltip("Wait until the fade has finished before executing the next command")]
public bool waitUntilFinished = true; public bool waitUntilFinished = true;
public override void OnEnter() public override void OnEnter()

3
Assets/Fungus/Sprite/Scripts/Commands/ShowSprite.cs

@ -10,7 +10,10 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class ShowSprite : Command public class ShowSprite : Command
{ {
[Tooltip("Sprite object to be made visible / invisible")]
public SpriteRenderer spriteRenderer; public SpriteRenderer spriteRenderer;
[Tooltip("Make the sprite visible or invisible")]
public bool visible = true; public bool visible = true;
public override void OnEnter() public override void OnEnter()

1
Assets/Fungus/Sprite/Scripts/EventHandlers/DragCancelled.cs

@ -11,6 +11,7 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class DragCancelled : EventHandler public class DragCancelled : EventHandler
{ {
[Tooltip("Draggable object to listen for drag events on")]
public Draggable2D draggableObject; public Draggable2D draggableObject;
public virtual void OnDragCancelled(Draggable2D draggableObject) public virtual void OnDragCancelled(Draggable2D draggableObject)

3
Assets/Fungus/Sprite/Scripts/EventHandlers/DragCompleted.cs

@ -11,7 +11,10 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class DragCompleted : EventHandler public class DragCompleted : EventHandler
{ {
[Tooltip("Draggable object to listen for drag events on")]
public Draggable2D draggableObject; public Draggable2D draggableObject;
[Tooltip("Drag target object to listen for drag events on")]
public Collider2D targetObject; public Collider2D targetObject;
// There's no way to poll if an object is touching another object, so // There's no way to poll if an object is touching another object, so

3
Assets/Fungus/Sprite/Scripts/EventHandlers/DragEntered.cs

@ -12,7 +12,10 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class DragEntered : EventHandler public class DragEntered : EventHandler
{ {
[Tooltip("Draggable object to listen for drag events on")]
public Draggable2D draggableObject; public Draggable2D draggableObject;
[Tooltip("Drag target object to listen for drag events on")]
public Collider2D targetObject; public Collider2D targetObject;
public virtual void OnDragEntered(Draggable2D draggableObject, Collider2D targetObject) public virtual void OnDragEntered(Draggable2D draggableObject, Collider2D targetObject)

3
Assets/Fungus/Sprite/Scripts/EventHandlers/DragExited.cs

@ -12,7 +12,10 @@ namespace Fungus
[AddComponentMenu("")] [AddComponentMenu("")]
public class DragExited : EventHandler public class DragExited : EventHandler
{ {
[Tooltip("Draggable object to listen for drag events on")]
public Draggable2D draggableObject; public Draggable2D draggableObject;
[Tooltip("Drag target object to listen for drag events on")]
public Collider2D targetObject; public Collider2D targetObject;
public virtual void OnDragExited(Draggable2D draggableObject, Collider2D targetObject) public virtual void OnDragExited(Draggable2D draggableObject, Collider2D targetObject)

Loading…
Cancel
Save