Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

Effects

Provides common effects used by various DialoguePresenterBase implementations.
public static class Effects

Inherits from System.Object

#Methods

#FadeAlpha(CanvasGroup, float, float, float, CancellationToken)

public static IEnumerator FadeAlpha(CanvasGroup canvas, float from, float to, float duration, CancellationToken token = default)

Parameters

  • canvasCanvasGroup
  • fromfloat
  • tofloat
  • durationfloat
  • tokenCancellationToken

Returns IEnumerator

#FadeAlphaAsync(CanvasGroup, float, float, float, CancellationToken)

Fades a canvas group alpha value. Generally used to fade up and down the main dialogue canvas when dialogue starts and ends.
public static async YarnTask FadeAlphaAsync(CanvasGroup canvas, float from, float to, float duration, CancellationToken token)

Parameters

  • canvasCanvasGroup
    The canvas group to fade
  • fromfloat
    The starting value of the fade
  • tofloat
    The end value of the fade
  • durationfloat
    How long the fade should take
  • tokenCancellationToken
    Cancellation token for this task

Returns YarnTask

Generated from Yarn Spinner for Unity 3.3.