Making rooms do stuff

[ErroneousCreationist]

Lets say you want to do something in your room. Like... a tutorial for your slugcat, that shows those text border things? Or a cutscene thing? Traditionally, this would be done with devtool objects, but you don't need to use them. Heres how I added tutorial text to my scugs campaign.

To do this, I hooked RoomSpecificScript.AddRoomSpecificScript, and used this code:

private void RoomSpecificScript_AddRoomSpecificScript(...)
{
    orig(...)
    if(room.abstractRoom.name == "MY ROOM ID")
    {
        room.AddObject(new MyTutorialObject(room));
    }
}

Okay, so this is run basically on every room, and you can just hook and add objects. For finer control of when an object is spawned, you can just add stuff to the if statement, e.g. if you wanted it only on cycle 0, you can go (room.game.session as StoryGameSession).saveState.cycleNumber ==0
However, we actually need an object to put in the room. Heres how to make one.
First, create a class that inherits from rain world's base object class, UpdatableAndDeletable, like this
class MyTutorialObject : UpdatableAndDeletable
Then, make the constructor. Might be helpful to put your room in the constructor, so you can get it easily.

public MyTutorialObject(Room room)
{
    this.room = room;
    //initialise any other stuff here
}

As the name implies, you can, in fact, use the Update function of this class. Heres some example code from my mod, but you can do anything you want here

public override void Update(bool eu)
{
    base.Update(eu);
    if (this.room.game.session.Players[0].realizedCreature == null || this.room.game.session.Players[0].realizedCreature.room != room || this.room.game.cameras[0].hud == null || this.room.game.cameras[0].hud.textPrompt == null || this.room.game.cameras[0].hud.textPrompt.messages.Count >= 1)
    {
        return;
    }
    while (currmessage < 3)
    {
        if (currmessage == 0)
        {
            this.room.game.cameras[0].hud.textPrompt.AddMessage(this.room.game.rainWorld.inGameTranslator.Translate("First message"), 20, 260, true, true);
        }
        else if (currmessage == 1)
        {
            this.room.game.cameras[0].hud.textPrompt.AddMessage(this.room.game.rainWorld.inGameTranslator.Translate("Second message"), 20, 220, true, true);
        }
        else if(currmessage==2)
        {
            this.room.game.cameras[0].hud.textPrompt.AddMessage(this.room.game.rainWorld.inGameTranslator.Translate("Third message"), 20, 200, true, true);
        }
        else
        {
            this.Destroy();
        }
        currmessage++;
    }
}

Basically, it plays 3 messages one after the other, and then destroys itself. It also checks if the player is in the room, and that the hud is playing (so it can wait to play the next message). This is not the best way to do it, you could totally just make a class that does all your text tutorials. Also, you don't have to use it to do tutorials, you can do anything with this, spawn effects, explode stuff, play sounds, whatever. Happy coding!