diff --git a/Runtime/Commands/YarnCommandAttribute.cs b/Runtime/Commands/YarnCommandAttribute.cs index 67e039e2..2aededae 100644 --- a/Runtime/Commands/YarnCommandAttribute.cs +++ b/Runtime/Commands/YarnCommandAttribute.cs @@ -100,11 +100,20 @@ namespace Yarn.Unity /// This attribute may be attached to a coroutine. /// /// The determines if the method is a coroutine - /// if the method returns . + /// if the method returns , or if the method + /// returns a . /// /// - /// If the method is a coroutine, the DialogueRunner will pause execution - /// until the coroutine ends. + /// If the method is a coroutine, or returns a , the + /// DialogueRunner will pause execution until the coroutine ends. + /// + /// + /// Yarn Spinner for Unity finds methods with the YarnCommand attribute by + /// reading your source code. If your project uses Unity 2021.1 or earlier, + /// you will need to tell Yarn Spinner for Unity to do this manually, by + /// opening the Window method and choosing Yarn Spinner -> Update Yarn + /// Commands. You don't need to do this on later versions of Unity, as it + /// will be done for you automatically when your code compiles. /// /// public class YarnCommandAttribute : YarnActionAttribute diff --git a/Runtime/Commands/YarnFunctionAttribute.cs b/Runtime/Commands/YarnFunctionAttribute.cs index ecd635a8..9d8e24b1 100644 --- a/Runtime/Commands/YarnFunctionAttribute.cs +++ b/Runtime/Commands/YarnFunctionAttribute.cs @@ -10,12 +10,23 @@ namespace Yarn.Unity /// instance's library. /// /// + /// /// See and the /// generic overloads for what is and is not valid. - /// + /// + /// /// This will throw an error if you attempt to add a function that has /// more than 16 parameters, as that is the largest overload that /// etc has. + /// + /// + /// Yarn Spinner for Unity finds methods with the YarnFunction attribute by + /// reading your source code. If your project uses Unity 2021.1 or earlier, + /// you will need to tell Yarn Spinner for Unity to do this manually, by + /// opening the Window method and choosing Yarn Spinner -> Update Yarn + /// Commands. You don't need to do this on later versions of Unity, as it + /// will be done for you automatically when your code compiles. + /// /// public class YarnFunctionAttribute : YarnActionAttribute { [Obsolete("Use " + nameof(Name) + " instead.")]