CoroutineHelper

命名空间: Cwl.Helper.Unity;

一种方便的方式来调用委托或协程，在任何上下文中，无论是否为 MonoBehaviour 实例。

立即

static void MyTask();

CoroutineHelper.Immediate(MyTask);
CoroutineHelper.Immediate(() => {
    // some other stuff
    MyTask();
});

在下一个 Unity Update 事件后立即调用委托。

static IEnumerator MyCoroutineTask();

CoroutineHelper.Immediate(MyCoroutineTask());

在下一个 Unity Update 事件后立即调用协程。

条件延迟

条件触发的核心。

static void CleanupTask();

CoroutineHelper.Deferred(CleanupTask, () => SomeCheck.ShouldClean);

static void AddStuffToPlayer(int id);

CoroutineHelper.Deferred(
    () => AddStuffToPlayer(114514),
    () => EMono.core.IsGameStarted);

当条件为真时调用委托。

帧延迟

有时你想延迟某些帧再执行你的动作。例如，在与 UI 相关的代码中，你可能希望先让 UI 刷新，然后在 1 帧后绘制你自己的内容，以适应新的位置/数据等。

static void AdjustPosition();

// default 1 frame
CoroutineHelper.Deferred(AdjustPosition);
// specify frames
CoroutineHelper.Deferred(AdjustPosition, 5);
// anonymous lambda works too
CoroutineHelper.Deferred(
    () => {
        // some other stuff
        AdjustPosition();
    },
    5);

时间延迟

有时你希望某个效果持续一段时间，然后再进行后续操作。

static void ClearEffects();

// wait 1.5s
CoroutineHelper.Deferred(ClearEffects, 1.5f);
CoroutineHelper.Deferred(
    () => {
        // some other stuff
        ClearEffects();
    },
    1.5f);

ProgressIndicator

为异步方法提供在屏幕右上角显示状态文本的帮助类。

static string currentLoading = "";
static bool shouldClose;

IEnumerator MyAsyncTask()
{
    var progress = ProgressIndicator.CreateProgress(
        onUpdate: () => new UpdateInfo(Text: currentLoading, Sprite: null, Color: null),
        shouldKill: () => shouldClose
    );

    foreach (var file in BunchOfFiles) {
        currentLoading = file.Name;
        yield return new SomeTask();
    }

    currentLoading = "finished loading";
    shouldClose = true;
}

也可使用只在当前作用域显示并自动关闭的便捷重载:

static string currentLoading = "";

IEnumerator MyAsyncTask()
{
    using var progress = ProgressIndicator.CreateProgress(
        () => new UpdateInfo(Text: currentLoading, Sprite: null, Color: null)
    );

    foreach (var file in BunchOfFiles) {
        currentLoading = file.Name;
        yield return new SomeTask();
    }

    currentLoading = "finished loading";
}

ProgressIndicator

用于在屏幕右上角显示异步操作的进度跟踪器。

static string currentLoading = "";
static bool shouldClose;

IEnumerator MyAsyncTask()
{
    var progress = ProgressIndicator.CreateProgress(
        onUpdate: () => new UpdateInfo(Text: currentLoading, Sprite: null, Color: null),
        shouldKill: () => shouldClose
    );

    foreach (var file in BunchOfFiles) {
        currentLoading = file.Name;
        yield return new SomeTask();
    }

    currentLoading = "加载完成";
    shouldClose = true;
}

您还可以使用作用域重载，它会在方法退出时自动关闭：

static string currentLoading = "";

IEnumerator MyAsyncTask()
{
    using var progress = ProgressIndicator.CreateProgressScoped(
        () => new UpdateInfo(currentLoading)
    );

    foreach (var file in BunchOfFiles) {
        currentLoading = file.Name;
        yield return new SomeTask();
    }

    currentLoading = "加载完成";
}

SpriteCreator

帮助加载 PNG 作为 Sprite，带有缓存和可选调整大小选项。

Sprite? LoadSprite(this string path, Vector2? pivot = null, string? name = null, int resizeWidth = 0, int resizeHeight = 0);

var filePath = "X:/someimage.png";
var sprite = filePath.LoadSprite(name: "SpriteNewName", resizeWidth: 900, resizeHeight: 600);

默认情况下，轴心位于中心（0.5, 0.5），不提供 name 参数时，Sprite 名称将使用内部缓存名称。如果 resizeWidth 和/或 resizeHeight 不为 0，则 Sprite 将被调整至指定大小。

SpriteReplacerHelper

用于快速向游戏内 SpriteSheet 添加贴图块，并带有可选调整大小选项。

// file at "X:/someimage_alt.png"
SpriteReplacerHelper.AppendSpriteSheet("someimage_alt", 32, 32);

全局中您应当为各贴图只调用该方法一次，且部分源表的贴图由 CWL 自动添加。

ChildrenIterator

帮助查找具有名称的 GameObject 的嵌套子对象。假设你想找到复合页面的布局组面板中列表元素的文本对象，你可以这样做：

var text = page.transform.GetFirstNestedChildWithName("Content View/Scroll View/Viewport/Content/Profile List/Entry (1)/text");

对于非嵌套访问，使用 GetFirstChildWithName。

如果未找到，则返回 null。

其他内容

一些你可能不需要的内容：

• PixelRaycast
• TextureResizer