Mega Tree API

Registration

When to call, what comes back, the rules ids must follow, and what happens when two mods want the same one.

When to call

Register from your plugin's Awake(). That is early - before any scene exists - and it is fine, because registration only records data. Nothing touches Unity until the player opens the tree window.

You can also register later: mid-game, after a config reload, after the player unlocks something. A node that appears while the window is open shows up on the next repaint, and if the player already owned levels on that id from a previous session, those levels come back with it (see Persistence).

The API never throws

Register is called from inside your Awake(). If it threw, the exception would abort your plugin, not Mega Tree - which is a terrible failure mode for a mistake as small as a typo in an id. So it does not throw. Every failure comes back as a result and is written to the log with your guid.

UpgradeHandle handle = tree.Register(new UpgradeDefinition { /* ... */ });

if (!handle.Success)
{
    // handle.Result.Status  -> RegisterStatus enum
    // handle.Result.Message -> the same text that went to the log
    Logger.LogError($"Mega Tree refused the node: {handle.Result}");
    return;
}

int owned = handle.Level;   // 0 on a fresh save

RegisterStatus

Id rules

An id registered through the API must be in prefix.name form:

• lower case only, plus digits, _, - and dots
• at least one dot, not at the start or the end, never two in a row
• 3 to 64 characters
• not starting with megatree. or mt.

Duplicate ids

Limits

Removing a node

Unregister takes a node out of the tree. It does not delete the player's level - that stays in the save file and comes back if you register the id again. Use it for config toggles, not as a cleanup step on shutdown.

// Via the handle...
handle.Unregister();

// ...or by id, from the module.
tree.Unregister("bigboxes.capacity");