can now add the YarnEnumParameter attribute onto functions and commands.

Provides hints to the editor that when writing these commands and functions to offer suggestions of enums.
This is a temporary solution to giving the editor more information until generation and declaration of Yarn enums works seamlessly between Yarn and C#

Author: McJones

CHANGELOG.md

@@ -16,6 +16,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Generated YSLS file now includes subtype information for instance commands
   - This means a command like `<<move gary left>>` now knows that the `"gary"` is the name of a game object and the specific game object subclass
   - Only works at a single level of monobehaviour depth, subclasses of a monobehaviour subclass will not be recognised
+- `YarnNodeParameterAttribute` can now be added to string parameters in function and command methods
+  - Intended to allow you to hint to the VSCode extension that when writing this parameter in commands and functions to limit suggestions to nodes
+- `YarnEnumParameterAttribute` can now be added to parameters in functions and command methods
+  - has one field which is the name the enum as declared in your Yarn
+  - Intended to allow you to hint to the VSCode extension to offer enum based suggestions
+  - this is temporary until forward declaration of Yarn enums into C# works
 
 ### Changed
 

Editor/Analysis/Action.cs

@@ -290,12 +290,31 @@ public string ToJSON()
                 }
                 else
                 {
-                    // there is one special case of the regular types which is if you are a string and attributed as a node parameter
+                    // there are two special case of the regular types:
+                    // if you are a string and attributed as a node parameter you get declared as being a node type
+                    // if you have an enum attribute it gets declared as an enum and it has the subtype as defined in the enum attribute
+
                     var isANodeType = p.Attributes?.Count(a => a.AttributeClass?.Name == "YarnNodeParameterAttribute") > 0;
+                    var isAnEnum = p.Attributes?.Count(a => a.AttributeClass?.Name == "YarnEnumParameterAttribute") > 0;
+
                     if (isANodeType && p.Type.SpecialType == SpecialType.System_String)
                     {
                         paramObject["type"] = "node";
                     }
+                    else if (isAnEnum)
+                    {
+                        paramObject["type"] = "enum";
+
+                        var attribute = p.Attributes?.Where(a => a.AttributeClass?.Name == "YarnEnumParameterAttribute").First();
+                        if (attribute != null && attribute.ConstructorArguments.Count() > 0)
+                        {
+                            var enumType = attribute.ConstructorArguments[0];
+                            if (enumType.Type?.SpecialType == SpecialType.System_String)
+                            {
+                                paramObject["subtype"] = enumType.Value as string ?? p.YarnTypeString;
+                            }
+                        }
+                    }
                     else
                     {
                         paramObject["type"] = p.YarnTypeString;
@@ -312,7 +331,7 @@ public string ToJSON()
 
                 if (!string.IsNullOrWhiteSpace(this.ReturnDescription))
                 {
-                    retvrn["description"] = this.ReturnDescription;
+                    retvrn["description"] = this.ReturnDescription!;
                 }
                 result["return"] = retvrn;
             }

Runtime/Commands/YarnEnumParameterAttribute.cs

@@ -0,0 +1,15 @@
+/*
+Yarn Spinner is licensed to you under the terms found in the file LICENSE.md.
+*/
+
+#nullable enable
+
+namespace Yarn.Unity.Attributes
+{
+    public class YarnEnumParameterAttribute: YarnParameterAttribute
+    {
+        public string Name { get; set; }
+
+        public YarnEnumParameterAttribute(string name) => Name = name;
+    }
+}