Dev Tools Regionkit Guide?

[InvaderBatflight]

When ingame and accessing the dev tools in order to add objects and decorations to a custom level, there are a bunch of things in the Objects menu which I have no idea how to get to work, and the information isn't readily available.

It would be nice if somebody with extensive knowledge about the Room settings could give a run down on what each object is and does so that those of us who aren't in the know don't have to figure out via trial and error and wondering why the level won't load after adding particular objects.

[thalber]

Have you read Regionkit's readme file? It has instructions for a lot of the modules (not all of them unfortunately).

[InvaderBatflight]

I have. But like you said, it doesn't cover all of them, in fact it doesn't even cover half of the stuff in the editor, nor does it go in depth on how to get the more complicated stuff to work.

A lot of the objects have names which are self explanatory but there's a bunch that don't. Like in RegionKit-CG what's CGOrganicLining? Why is it that when I try to add CGCosmeticLeaves, the level crashes when I try to reload? What is the CircleZone? What does FreeformDecalOrSprite do? Why is it when I try to add SpinningFan all it does is alter the palette of the entire room?

There's also the Effects that Region kit adds for Room settings. What's PWMalfunction? What the heck is HiveColorAlpha?

You know what I mean?

[thalber]

CG module in general is pretty old.

CGOrganicLining depends on CGOrganicShelterCoordinator, a bunch of other CG shelter related objects probably do too.

I don't know why CosmeticLeaves crash, probably something lost in port. I'll open an issue ig.

CircleZone and RectZone are a stub for generalized trigger zones that could be used by other objects (I don't remember if I added more than like 2 subscribers) and don't do anything on their own.

FreeformDecalOrSprite is like CustomDecal, but you can choose what shader it uses and which container it goes into + some other settings.

Spinning fan is... I honestly have no idea how an object this simple is broken after ~3 fix attempts lol.

PWMalfunction is some homebrew variant of BrokenZeroG from Substratum, no one else used it ever.

BatColorAlpha changes color intensity of bat hives.

I agree that documentation upgrades are needed but I myself am not up for it.

[thalber]

Oh, hold on, I remember now. SpinningFan is broken because it uses a vanilla shader that is broken in 1.9.