Reme

添加新事件

2026年04月21日 1k 字 大概 4 分钟

简单多阶段事件

首先创建类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
using MegaCrit.Sts2.Core.Commands;
using MegaCrit.Sts2.Core.Entities.Gold;
using MegaCrit.Sts2.Core.Events;
using MegaCrit.Sts2.Core.GameActions.Multiplayer;
using MegaCrit.Sts2.Core.Helpers;
using MegaCrit.Sts2.Core.Localization.DynamicVars;
using MegaCrit.Sts2.Core.Rewards;
using MegaCrit.Sts2.Core.Runs;
using MegaCrit.Sts2.Core.ValueProps;
using STS2RitsuLib.Scaffolding.Content;

namespace Test.Scripts;

[RegisterActEvent(typeof(Glory))] // 指定只有荣耀这章生成
// [RegisterSharedEvent] // 如果需要自定义生成条件，可以注册成通用再重载isAllowed
public sealed class TestEvent : ModEventTemplate
{
    // 背景图位置
    public override EventAssetProfile AssetProfile => new(
        InitialPortraitPath: "res://images/events/battleworn_dummy.png"
    );

    // 设置一些数值
    protected override IEnumerable<DynamicVar> CanonicalVars =>
    [
        new DamageVar(10m, ValueProp.Unblockable | ValueProp.Unpowered),
        new GoldVar(60)
    ];

    // 什么时候会遇到。这里的条件是所有玩家的金币都大于等于60
    public override bool IsAllowed(IRunState runState) => runState.Players.All(p => p.Gold >= DynamicVars.Gold.BaseValue);

    // 事件开始前的逻辑。这里是禁止玩家移除药水
    protected override Task BeforeEventStarted(bool isPreFinished)
    {
        Owner!.CanRemovePotions = false;
        return Task.CompletedTask;
    }

    // 事件结束后的逻辑。这里是允许玩家移除药水
    protected override void OnEventFinished()
    {
        Owner!.CanRemovePotions = true;
    }

    // 生成事件初始选项。这里是两个选项：失去生命值或者失去金币，然后进入选择奖励阶段
    // 与 CustomEventModel.Option(delegate, pageKey) 一致：textKey = Id.Entry + ".pages." + page + ".options." + Slugify(方法名)
    protected override IReadOnlyList<EventOption> GenerateInitialOptions() =>
    [
        new EventOption(this, TakeDamage, InitialOptionKey("TAKE_DAMAGE")),
        new EventOption(this, LoseGold, InitialOptionKey("LOSE_GOLD")),
    ];

    // 失去生命
    private async Task TakeDamage()
    {
        await CreatureCmd.Damage(new ThrowingPlayerChoiceContext(), Owner!.Creature, DynamicVars.Damage, null, null);
        ChooseRewardTypePage();
    }

    // 失去金币
    private async Task LoseGold()
    {
        await PlayerCmd.LoseGold(DynamicVars.Gold.BaseValue, Owner!, GoldLossType.Stolen);
        ChooseRewardTypePage();
    }

    // 进入事件第二阶段，两个选项：选择药水或者选择卡牌
    private void ChooseRewardTypePage()
    {
        SetEventState(L10NLookup($"{Id.Entry}.pages.CHOOSE_TYPE.description"), [
            new EventOption(this, ChoosePotions, ModOptionKey("CHOOSE_TYPE", "CHOOSE_POTIONS")),
            new EventOption(this, ChooseCards, ModOptionKey("CHOOSE_TYPE", "CHOOSE_CARDS")),
        ]);
    }

    // 选择药水奖励，然后结束事件
    private async Task ChoosePotions()
    {
        await RewardsCmd.OfferCustom(Owner!, [new PotionReward(Owner!)]);
        SetEventFinished(L10NLookup($"{Id.Entry}.pages.POTIONS_CHOSEN.description"));
    }

    // 选择卡牌奖励，然后结束事件
    private async Task ChooseCards()
    {
        await RewardsCmd.OfferCustom(Owner!, [new CardReward(CardCreationOptions.ForNonCombatWithDefaultOdds([Owner!.Character.CardPool]), 3, Owner)]);
        SetEventFinished(L10NLookup($"{Id.Entry}.pages.CARDS_CHOSEN.description"));
    }
}

以上代码的字符串基本都和json中的文本键有关。

创建{modId}/localization/{Language}/events.json。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  // 事件标题
  "TEST_EVENT_TEST_EVENT.title": "与戈多相遇",
  // INITIAL是初始页面。这是初始页面的描述
  "TEST_EVENT_TEST_EVENT.pages.INITIAL.description": "岔路口的长椅上空无一人，只有风掠过草丛。\n\n[sine]然后你看见了他。[/sine]\n\n那个小小的、蓝蓝的剪影静静坐着，像在等一封永远不会寄到的信，又像在等某个永远「快好了」的构建结束。\n\n[gold]戈多[/gold]抬起眼睛——如果那算是眼睛——语气平淡得近乎温柔：\n\n「[sine]时间还早……也还很长。你愿意先付一点代价，换一点……打发等待的东西吗？[/sine]」",
  // 这是选项的标题。这个TAKE_DAMAGE是从你的函数生成的id名字。（从TakeDamage生成）
  "TEST_EVENT_TEST_EVENT.pages.INITIAL.options.TAKE_DAMAGE.title": "用疼痛记住这一刻",
  // 选项的描述。
  "TEST_EVENT_TEST_EVENT.pages.INITIAL.options.TAKE_DAMAGE.description": "受到[red]{Damage}[/red]点伤害。",
  "TEST_EVENT_TEST_EVENT.pages.INITIAL.options.LOSE_GOLD.title": "留下过路费",
  "TEST_EVENT_TEST_EVENT.pages.INITIAL.options.LOSE_GOLD.description": "失去[gold]{Gold}[/gold]枚金币。",
  // 这是第二页。CHOOSE_TYPE是我们自己设置的。
  "TEST_EVENT_TEST_EVENT.pages.CHOOSE_TYPE.description": "戈多从长椅底下摸出一个布包，又像是摸出了整个宇宙的耐心。\n\n「[sine]可以喝点什么……也可以领几张牌。反正，[/sine]」他顿了顿，「[sine]我们哪儿也不去。[/sine]」",
  "TEST_EVENT_TEST_EVENT.pages.CHOOSE_TYPE.options.CHOOSE_POTIONS.title": "接过一瓶药水",
  "TEST_EVENT_TEST_EVENT.pages.CHOOSE_TYPE.options.CHOOSE_POTIONS.description": "领取药水奖励，然后与这次等待道别。",
  "TEST_EVENT_TEST_EVENT.pages.CHOOSE_TYPE.options.CHOOSE_CARDS.title": "领张牌再走",
  "TEST_EVENT_TEST_EVENT.pages.CHOOSE_TYPE.options.CHOOSE_CARDS.description": "领取卡牌奖励，然后与这次等待道别。",
  // 结束页。POTIONS_CHOSEN也是我们设置的。
  "TEST_EVENT_TEST_EVENT.pages.POTIONS_CHOSEN.description": "液体在瓶里轻轻晃荡，像远处引擎空转的节奏。\n\n[gold]戈多[/gold]把空瓶口朝你举了举，像在敬酒，又像在敬时间本身。\n\n[sine]……好了。剩下的，你自己慢慢等吧。[/sine]",
  "TEST_EVENT_TEST_EVENT.pages.CARDS_CHOSEN.description": "纸牌边缘划过指缝，留下一点脆响——至少比沉默更热闹。\n\n[gold]戈多[/gold]望着你把牌收好，点点头。\n\n[sine]带走它们。路还长，别让自己……等得太安静。[/sine]"
}

alt text

战斗事件

TODO

Author： Reme
Link：https://glitchedreme.github.io/SlayTheSpire2ModdingTutorials/docs/04-ritsulib/04-12-add-event/
版权声明：本文采用 CC BY-NC-SA 4.0 CN 协议进行许可