Add research plugin API

[IntelOrca]

New APIs:

interface Park {
    ...
    readonly research: Research;
}

interface Research {
    inventedItems: ResearchItem[];
    uninventedItems: ResearchItem[];
    funding: ResearchFundingLevel;
    priorities: ResearchCategory[];
    stage: ResearchFundingStage;
    progress: number;
    readonly lastResearchedItem: ResearchItem | null;
    readonly expectedItem: ResearchItem | null;
    readonly expectedMonth: number | null;
    readonly expectedDay: number | null;

    isObjectResearched(type: ObjectType, index: number): boolean;
}

type ResearchItem = RideResearchItem | SceneryResearchItem;

interface RideResearchItem {
    readonly type: "ride";
    readonly category?: ResearchCategory;
    readonly rideType: number;
    readonly object: number;
}

interface SceneryResearchItem {
    readonly category?: ResearchCategory.SceneryGroup;
    readonly type: "scenery";
    readonly object: number;
}

type ResearchItemType = "scenery" | "ride";

type ResearchCategory =
    "transport" |
    "gentle" |
    "rollercoaster" |
    "thrill" |
    "water" |
    "shop" |
    "scenery";

enum ResearchFundingLevel {
    None,
    Minimum,
    Normal,
    Maximum
}

type ResearchFundingStage =
    "initial_research" |
    "designing" |
    "completing_design" |
    "unknown" |
    "finished_all";

[StephanSpengler]

Did not test ingame.

[rolfhermancoen]

The thing I am kind of missing is the current project that is being researched, this could be null/undefined or the ride/scenery. Would make it easier to work with for plugin developers. Other than that, this looks promising :)

[IntelOrca]

All comments resolved, categories are now strings everywhere.

[Basssiiie]

LGTM 😄

[Lastorder-DC]

Is there any way to manually mark item for research, except changing uninventedItems and inventedItems? or at least way to post message about research item?

Looks like rawValue of research item is not provided. and supplying neither ResearchItem.object or ResearchItem.rideType not woks for park.postMessage's subject.

because I'm developing some kind of "Gacha" plugin for OpenRCT, which randomly picks any research item and mark as complete, above is needed.

[IntelOrca]

@Lastorder-DC not yet, that can be done as a follow up API. It needs to do a bunch of internal state change, handle the case where it is already in the process of being researched, and allow you to provide a ride type and ride object pair.

The post message API will need improving to allow what you want (if the finish research API doesn't post it). I also would like to add a custom subject handler to messages.