mirrors/OpenRCT2
1
0
Fork 0
mirror of https://github.com/OpenRCT2/OpenRCT2 synced 2026-01-04 13:42:55 +01:00
Code Issues Releases Wiki Activity

Merge pull request #12921 from OpenRCT2/plugin/extras

Browse Source 
Add quadrants and scenario info to plugin API
This commit is contained in:
Michael Steenbeek
2020-09-13 20:37:53 +02:00
committed by GitHub
parent d21da12f9f e79d4be5a5
commit 0fb307c12e
7 changed files with 522 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
distribution/changelog.txt
View File

@@ -1,9 +1,12 @@
0.3.0+ (in development)
------------------------------------------------------------------------
- Feature: [#10807] Add 2x and 4x zoom levels (currently limited to OpenGL).
- Feature: [#12703] Add scenario plugin APIs.
- Feature: [#12708] Add plugin-accessible names to all game actions.
- Feature: [#12712] Add TCP / socket plugin APIs.
- Feature: [#12840] Add Park.entranceFee to the plugin API.
- Feature: [#12884] Add BaseTileElement.occupiedQuadrants to the plugin API.
- Feature: [#12885] Add SmallSceneryElement.quadrant to the plugin API.
- Feature: [#12886] Make all scenery placement and remove actions available to the plugin API.
- Fix: [#400] Unable to place some saved tracks flush to the ground (original bug).
- Fix: [#5753] Entertainers make themselves happy instead of the guests.

135
distribution/openrct2.d.ts vendored
View File

@@ -35,6 +35,8 @@ declare global {
var network: Network;
/** APIs for the park and management of it. */
var park: Park;
/** APIs for the current scenario. */
var scenario: Scenario;
/**
* APIs for controlling the user interface.
* These will only be available to servers and clients that are not running headless mode.
@@ -504,6 +506,7 @@ declare global {
type: TileElementType;
baseHeight: number;
clearanceHeight: number;
occupiedQuadrants: number;
isHidden: boolean; /** Take caution when changing this field, it may invalidate TileElements you have stored in your script. */
}
@@ -552,6 +555,7 @@ declare global {
primaryColour: number;
secondaryColour: number;
direction: Direction;
quadrant: number;
}
interface EntranceElement extends BaseTileElement {
@@ -1424,6 +1428,21 @@ declare global {
subject?: number;
}
type ParkFlags =
"difficultGuestGeneration" |
"difficultParkRating" |
"forbidHighConstruction" |
"forbidLandscapeChanges" |
"forbidMarketingCampaigns" |
"forbidTreeRemoval" |
"freeParkEntry" |
"noMoney" |
"open" |
"preferLessIntenseRides" |
"preferMoreIntenseRides" |
"scenarioCompleteNameInput" |
"unlockAllPrices";
interface Park {
cash: number;
rating: number;
@@ -1438,10 +1457,126 @@ declare global {
name: string;
messages: ParkMessage[];
/**
* Gets whether a given flag is set or not.
* @param key The flag to test.
*/
getFlag(flag: ParkFlags): boolean;
/**
* Sets the given flag to the given value.
* @param key The flag to set.
* @param value Whether to set or clear the flag.
*/
setFlag(flag: ParkFlags, value: boolean): void;
postMessage(message: string): void;
postMessage(message: ParkMessageDesc): void;
}
type ScenarioObjectiveType =
"none" |
"guestsBy" |
"parkValueBy" |
"haveFun" |
"buildTheBest" |
"10Rollercoasters" |
"guestsAndRating" |
"monthlyRideIncome" |
"10RollercoastersLength" |
"finish5Rollercoasters" |
"replayLoanAndParkValue" |
"monthlyFoodIncome";
interface ScenarioObjective {
/**
* The objective type.
*/
type: ScenarioObjective;
/**
* The required number of guests.
*/
guests: number;
/**
* The year the objective must be completed by the end of.
*/
year: number;
/**
* The minimum length required for each rollercoaster.
*/
length: number;
/**
* The minimum excitement rating required for each rollercoaster.
*/
excitement: number;
/**
* The minimum park value required.
*/
parkValue: number;
/**
* The minimum monthly income from rides / food.
*/
monthlyIncome: number;
}
type ScenarioStatus = "inProgress" | "completed" | "failed";
interface Scenario {
/**
* The name of the scenario. This is not necessarily the name of the park.
*/
name: string;
/**
* The description of the scenario, shown above the scenario objective.
*/
details: string;
/**
* The entered player name if the scenario is complete.
*/
completedBy: string;
/**
* The filename of the scenario that is being played. Used to match the
* completion score with the scenario file.
*/
filename: string;
/**
* The criteria required to complete the scenario.
*/
objective: ScenarioObjective;
/**
* The number of consecutive days the park rating has been under the threshold for.
* This is reset when the park rating rises above the threshold again.
* Also used to post warning messages.
*/
parkRatingWarningDays: number;
/**
* The company value when the scenario was completed.
*/
completedCompanyValue?: number;
/**
* The current status of the scenario.
*/
status: ScenarioStatus;
/**
* The current highest recorded company value.
*/
companyValueRecord: number;
}
interface Cheats {
allowArbitraryRideTypeChanges: boolean;
allowTrackPlaceInvalidHeights: boolean;

1
src/openrct2/libopenrct2.vcxproj
View File

@@ -410,6 +410,7 @@
<ClInclude Include="scripting\ScPark.hpp" />
<ClInclude Include="scripting\ScRide.hpp" />
<ClInclude Include="scripting\ScriptEngine.h" />
<ClInclude Include="scripting\ScScenario.hpp" />
<ClInclude Include="scripting\ScSocket.hpp" />
<ClInclude Include="scripting\ScTile.hpp" />
<ClInclude Include="sprites.h" />

36
src/openrct2/scripting/ScPark.hpp
View File

@@ -229,6 +229,23 @@ namespace OpenRCT2::Scripting
}
};
static const DukEnumMap<uint32_t> ParkFlagMap({
{ "open", PARK_FLAGS_PARK_OPEN },
{ "scenarioCompleteNameInput", PARK_FLAGS_SCENARIO_COMPLETE_NAME_INPUT },
{ "forbidLandscapeChanges", PARK_FLAGS_FORBID_LANDSCAPE_CHANGES },
{ "forbidTreeRemoval", PARK_FLAGS_FORBID_TREE_REMOVAL },
{ "forbidHighConstruction", PARK_FLAGS_FORBID_HIGH_CONSTRUCTION },
{ "preferLessIntenseRides", PARK_FLAGS_PREF_LESS_INTENSE_RIDES },
{ "forbidMarketingCampaigns", PARK_FLAGS_FORBID_MARKETING_CAMPAIGN },
{ "preferMoreIntenseRides", PARK_FLAGS_PREF_MORE_INTENSE_RIDES },
{ "noMoney", PARK_FLAGS_NO_MONEY },
{ "difficultGuestGeneration", PARK_FLAGS_DIFFICULT_GUEST_GENERATION },
{ "freeParkEntry", PARK_FLAGS_PARK_FREE_ENTRY },
{ "difficultParkRating", PARK_FLAGS_DIFFICULT_PARK_RATING },
{ "noMoney", PARK_FLAGS_NO_MONEY_SCENARIO },
{ "unlockAllPrices", PARK_FLAGS_UNLOCK_ALL_PRICES },
});
class ScPark
{
public:
@@ -300,6 +317,23 @@ namespace OpenRCT2::Scripting
GetContext()->GetGameState()->GetPark().Name = value;
}
bool getFlag(const std::string& key) const
{
auto mask = ParkFlagMap[key];
return (gParkFlags & mask) != 0;
}
void setFlag(const std::string& key, bool value)
{
ThrowIfGameStateNotMutable();
auto mask = ParkFlagMap[key];
if (value)
gParkFlags |= mask;
else
gParkFlags &= ~mask;
gfx_invalidate_screen();
}
std::vector<std::shared_ptr<ScParkMessage>> messages_get() const
{
std::vector<std::shared_ptr<ScParkMessage>> result;
@@ -395,6 +429,8 @@ namespace OpenRCT2::Scripting
dukglue_register_property(ctx, &ScPark::entranceFee_get, &ScPark::entranceFee_set, "entranceFee");
dukglue_register_property(ctx, &ScPark::name_get, &ScPark::name_set, "name");
dukglue_register_property(ctx, &ScPark::messages_get, &ScPark::messages_set, "messages");
dukglue_register_method(ctx, &ScPark::getFlag, "getFlag");
dukglue_register_method(ctx, &ScPark::setFlag, "setFlag");
dukglue_register_method(ctx, &ScPark::postMessage, "postMessage");
}
};

310
src/openrct2/scripting/ScScenario.hpp Normal file
View File

@@ -0,0 +1,310 @@
/*****************************************************************************
* Copyright (c) 2014-2020 OpenRCT2 developers
*
* For a complete list of all authors, please refer to contributors.md
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
*
* OpenRCT2 is licensed under the GNU General Public License version 3.
*****************************************************************************/
#pragma once
#ifdef ENABLE_SCRIPTING
# include "../Context.h"
# include "../GameState.h"
# include "../common.h"
# include "../core/String.hpp"
# include "../scenario/Scenario.h"
# include "../world/Park.h"
# include "Duktape.hpp"
# include "ScriptEngine.h"
# include <algorithm>
namespace OpenRCT2::Scripting
{
static const DukEnumMap<uint32_t> ScenarioObjectiveTypeMap({
{ "none", OBJECTIVE_NONE },
{ "guestsBy", OBJECTIVE_GUESTS_BY },
{ "parkValueBy", OBJECTIVE_PARK_VALUE_BY },
{ "haveFun", OBJECTIVE_HAVE_FUN },
{ "buildTheBest", OBJECTIVE_BUILD_THE_BEST },
{ "10Rollercoasters", OBJECTIVE_10_ROLLERCOASTERS },
{ "guestsAndRating", OBJECTIVE_GUESTS_AND_RATING },
{ "monthlyRideIncome", OBJECTIVE_MONTHLY_RIDE_INCOME },
{ "10RollercoastersLength", OBJECTIVE_10_ROLLERCOASTERS_LENGTH },
{ "finish5Rollercoasters", OBJECTIVE_FINISH_5_ROLLERCOASTERS },
{ "replayLoanAndParkValue", OBJECTIVE_REPLAY_LOAN_AND_PARK_VALUE },
{ "monthlyFoodIncome", OBJECTIVE_MONTHLY_FOOD_INCOME },
});
class ScScenarioObjective
{
private:
std::string type_get()
{
return std::string(ScenarioObjectiveTypeMap[gScenarioObjective.Type]);
}
void type_set(const std::string& value)
{
ThrowIfGameStateNotMutable();
gScenarioObjective.Type = ScenarioObjectiveTypeMap[value];
}
uint16_t guests_get()
{
if (gScenarioObjective.Type == OBJECTIVE_GUESTS_BY || gScenarioObjective.Type == OBJECTIVE_GUESTS_AND_RATING)
{
return gScenarioObjective.NumGuests;
}
return 0;
}
void guests_set(uint16_t value)
{
ThrowIfGameStateNotMutable();
if (gScenarioObjective.Type == OBJECTIVE_GUESTS_BY || gScenarioObjective.Type == OBJECTIVE_GUESTS_AND_RATING)
{
gScenarioObjective.NumGuests = value;
}
}
uint8_t year_get()
{
if (gScenarioObjective.Type == OBJECTIVE_GUESTS_BY || gScenarioObjective.Type == OBJECTIVE_PARK_VALUE_BY)
{
return gScenarioObjective.Year;
}
return 0;
}
void year_set(uint8_t value)
{
ThrowIfGameStateNotMutable();
if (gScenarioObjective.Type == OBJECTIVE_GUESTS_BY || gScenarioObjective.Type == OBJECTIVE_PARK_VALUE_BY)
{
gScenarioObjective.Year = value;
}
}
uint16_t length_get()
{
if (gScenarioObjective.Type == OBJECTIVE_10_ROLLERCOASTERS_LENGTH)
{
return gScenarioObjective.NumGuests;
}
return 0;
}
void length_set(uint16_t value)
{
ThrowIfGameStateNotMutable();
if (gScenarioObjective.Type == OBJECTIVE_10_ROLLERCOASTERS_LENGTH)
{
gScenarioObjective.NumGuests = value;
}
}
money32 excitement_get()
{
if (gScenarioObjective.Type == OBJECTIVE_FINISH_5_ROLLERCOASTERS)
{
return gScenarioObjective.Currency;
}
return 0;
}
void excitement_set(money32 value)
{
ThrowIfGameStateNotMutable();
if (gScenarioObjective.Type == OBJECTIVE_FINISH_5_ROLLERCOASTERS)
{
gScenarioObjective.Currency = value;
}
}
money32 parkValue_get()
{
if (gScenarioObjective.Type == OBJECTIVE_PARK_VALUE_BY
|| gScenarioObjective.Type == OBJECTIVE_REPLAY_LOAN_AND_PARK_VALUE)
{
return gScenarioObjective.Currency;
}
return 0;
}
void parkValue_set(money32 value)
{
ThrowIfGameStateNotMutable();
if (gScenarioObjective.Type == OBJECTIVE_PARK_VALUE_BY
|| gScenarioObjective.Type == OBJECTIVE_REPLAY_LOAN_AND_PARK_VALUE)
{
gScenarioObjective.Currency = value;
}
}
money32 monthlyIncome_get()
{
if (gScenarioObjective.Type == OBJECTIVE_MONTHLY_RIDE_INCOME
|| gScenarioObjective.Type == OBJECTIVE_MONTHLY_FOOD_INCOME)
{
return gScenarioObjective.Currency;
}
return 0;
}
void monthlyIncome_set(money32 value)
{
ThrowIfGameStateNotMutable();
if (gScenarioObjective.Type == OBJECTIVE_PARK_VALUE_BY
|| gScenarioObjective.Type == OBJECTIVE_REPLAY_LOAN_AND_PARK_VALUE)
{
gScenarioObjective.Currency = value;
}
}
public:
static void Register(duk_context* ctx)
{
dukglue_register_property(ctx, &ScScenarioObjective::type_get, &ScScenarioObjective::type_set, "type");
dukglue_register_property(ctx, &ScScenarioObjective::guests_get, &ScScenarioObjective::guests_set, "guests");
dukglue_register_property(ctx, &ScScenarioObjective::year_get, &ScScenarioObjective::year_set, "year");
dukglue_register_property(
ctx, &ScScenarioObjective::excitement_get, &ScScenarioObjective::excitement_set, "excitement");
dukglue_register_property(
ctx, &ScScenarioObjective::monthlyIncome_get, &ScScenarioObjective::monthlyIncome_set, "monthlyIncome");
dukglue_register_property(
ctx, &ScScenarioObjective::parkValue_get, &ScScenarioObjective::parkValue_set, "parkValue");
}
};
class ScScenario
{
public:
std::string name_get()
{
return gScenarioName;
}
void name_set(const std::string& value)
{
ThrowIfGameStateNotMutable();
gScenarioName = value;
}
std::string details_get()
{
return gScenarioDetails;
}
void details_set(const std::string& value)
{
ThrowIfGameStateNotMutable();
gScenarioDetails = value;
}
std::string completedBy_get()
{
return gScenarioCompletedBy;
}
void completedBy_set(const std::string& value)
{
ThrowIfGameStateNotMutable();
gScenarioCompletedBy = value;
}
std::string filename_get()
{
return gScenarioFileName;
}
void filename_set(const std::string& value)
{
ThrowIfGameStateNotMutable();
String::Set(gScenarioFileName, std::size(gScenarioFileName), value.c_str());
}
std::shared_ptr<ScScenarioObjective> objective_get() const
{
return std::make_shared<ScScenarioObjective>();
}
uint16_t parkRatingWarningDays_get() const
{
return gScenarioParkRatingWarningDays;
}
void parkRatingWarningDays_set(uint16_t value)
{
ThrowIfGameStateNotMutable();
gScenarioParkRatingWarningDays = value;
}
DukValue completedCompanyValue_get() const
{
auto ctx = GetContext()->GetScriptEngine().GetContext();
if (gScenarioCompletedCompanyValue == MONEY32_UNDEFINED
|| gScenarioCompletedCompanyValue == COMPANY_VALUE_ON_FAILED_OBJECTIVE)
{
return ToDuk(ctx, nullptr);
}
return ToDuk(ctx, gScenarioCompletedCompanyValue);
}
void completedCompanyValue_set(int32_t value)
{
ThrowIfGameStateNotMutable();
gScenarioCompletedCompanyValue = value;
}
std::string status_get() const
{
if (gScenarioCompletedCompanyValue == MONEY32_UNDEFINED)
return "inProgress";
else if (gScenarioCompletedCompanyValue == COMPANY_VALUE_ON_FAILED_OBJECTIVE)
return "failed";
return "completed";
}
void status_set(const std::string& value)
{
ThrowIfGameStateNotMutable();
if (value == "inProgress")
gScenarioCompletedCompanyValue = MONEY32_UNDEFINED;
else if (value == "failed")
gScenarioCompletedCompanyValue = COMPANY_VALUE_ON_FAILED_OBJECTIVE;
else if (value == "completed")
gScenarioCompletedCompanyValue = gCompanyValue;
}
money32 companyValueRecord_get() const
{
return gScenarioCompanyValueRecord;
}
void companyValueRecord_set(money32 value)
{
ThrowIfGameStateNotMutable();
gScenarioCompanyValueRecord = value;
}
public:
static void Register(duk_context* ctx)
{
dukglue_register_property(ctx, &ScScenario::name_get, &ScScenario::name_set, "name");
dukglue_register_property(ctx, &ScScenario::details_get, &ScScenario::details_set, "details");
dukglue_register_property(ctx, &ScScenario::completedBy_get, &ScScenario::completedBy_set, "completedBy");
dukglue_register_property(ctx, &ScScenario::filename_get, &ScScenario::filename_set, "filename");
dukglue_register_property(
ctx, &ScScenario::parkRatingWarningDays_get, &ScScenario::parkRatingWarningDays_set, "parkRatingWarningDays");
dukglue_register_property(ctx, &ScScenario::objective_get, nullptr, "objective");
dukglue_register_property(ctx, &ScScenario::status_get, &ScScenario::status_set, "status");
dukglue_register_property(
ctx, &ScScenario::completedCompanyValue_get, &ScScenario::completedCompanyValue_set, "completedCompanyValue");
dukglue_register_property(
ctx, &ScScenario::companyValueRecord_get, &ScScenario::companyValueRecord_set, "companyValueRecord");
}
};
} // namespace OpenRCT2::Scripting
#endif

32
src/openrct2/scripting/ScTile.hpp
View File

@@ -615,6 +615,35 @@ namespace OpenRCT2::Scripting
}
}
uint8_t quadrant_get() const
{
auto el = _element->AsSmallScenery();
if (el != nullptr)
return el->GetSceneryQuadrant();
return 0;
}
void quadrant_set(uint8_t value)
{
ThrowIfGameStateNotMutable();
auto el = _element->AsSmallScenery();
if (el != nullptr)
{
el->SetSceneryQuadrant(value);
Invalidate();
}
}
uint8_t occupiedQuadrants_get() const
{
return _element->GetOccupiedQuadrants();
}
void occupiedQuadrants_set(uint8_t value)
{
ThrowIfGameStateNotMutable();
_element->SetOccupiedQuadrants(value);
Invalidate();
}
uint8_t primaryColour_get() const
{
switch (_element->GetType())
@@ -975,6 +1004,8 @@ namespace OpenRCT2::Scripting
dukglue_register_property(
ctx, &ScTileElement::clearanceHeight_get, &ScTileElement::clearanceHeight_set, "clearanceHeight");
dukglue_register_property(ctx, &ScTileElement::direction_get, &ScTileElement::direction_set, "direction");
dukglue_register_property(
ctx, &ScTileElement::occupiedQuadrants_get, &ScTileElement::occupiedQuadrants_set, "occupiedQuadrants");
// Some
dukglue_register_property(ctx, &ScTileElement::object_get, &ScTileElement::object_set, "object");
@@ -1010,6 +1041,7 @@ namespace OpenRCT2::Scripting
// Small Scenery only
dukglue_register_property(ctx, &ScTileElement::age_get, &ScTileElement::age_set, "age");
dukglue_register_property(ctx, &ScTileElement::quadrant_get, &ScTileElement::quadrant_set, "quadrant");
// Footpath only
dukglue_register_property(ctx, &ScTileElement::railings_get, &ScTileElement::railings_set, "railings");

6
src/openrct2/scripting/ScriptEngine.cpp
View File

@@ -33,6 +33,7 @@
# include "ScObject.hpp"
# include "ScPark.hpp"
# include "ScRide.hpp"
# include "ScScenario.hpp"
# include "ScSocket.hpp"
# include "ScTile.hpp"
@@ -42,7 +43,7 @@
using namespace OpenRCT2;
using namespace OpenRCT2::Scripting;
static constexpr int32_t OPENRCT2_PLUGIN_API_VERSION = 6;
static constexpr int32_t OPENRCT2_PLUGIN_API_VERSION = 7;
struct ExpressionStringifier final
{
@@ -398,6 +399,8 @@ void ScriptEngine::Initialise()
ScSocket::Register(ctx);
ScListener::Register(ctx);
# endif
ScScenario::Register(ctx);
ScScenarioObjective::Register(ctx);
ScStaff::Register(ctx);
dukglue_register_global(ctx, std::make_shared<ScCheats>(), "cheats");
@@ -407,6 +410,7 @@ void ScriptEngine::Initialise()
dukglue_register_global(ctx, std::make_shared<ScMap>(ctx), "map");
dukglue_register_global(ctx, std::make_shared<ScNetwork>(ctx), "network");
dukglue_register_global(ctx, std::make_shared<ScPark>(), "park");
dukglue_register_global(ctx, std::make_shared<ScScenario>(), "scenario");
_initialised = true;
_pluginsLoaded = false;