mirrors/OpenRCT2
1
0
Fork 0
mirror of https://github.com/OpenRCT2/OpenRCT2 synced 2026-01-24 15:24:30 +01:00
Code Issues Releases Wiki Activity

Add map changed hook

Browse Source
This commit is contained in:
Ted John
2022-02-20 02:05:24 +00:00
parent 1128f76a97
commit 84fdd44e6a
12 changed files with 52 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
distribution/openrct2.d.ts vendored
View File

@@ -287,6 +287,11 @@ declare global {
subscribe(hook: "vehicle.crash", callback: (e: VehicleCrashArgs) => void): IDisposable;
subscribe(hook: "map.save", callback: () => void): IDisposable;
/**
* Can only be used in intransient plugins.
*/
subscribe(hook: "map.changed", callback: () => void): IDisposable;
/**
* Registers a function to be called every so often in realtime, specified by the given delay.
* @param callback The function to call every time the delay has elapsed.
@@ -387,7 +392,7 @@ declare global {
"interval.tick" | "interval.day" |
"network.chat" | "network.action" | "network.join" | "network.leave" |
"ride.ratings.calculate" | "action.location" | "vehicle.crash" |
"map.save";
"map.changed" | "map.save";
type ExpenditureType =
"ride_construction" |

12
src/openrct2-ui/title/TitleSequencePlayer.cpp
View File

@@ -288,7 +288,11 @@ private:
{
loadSuccess = LoadParkFromStream(parkHandle->Stream.get(), parkHandle->HintPath);
}
if (!loadSuccess)
if (loadSuccess)
{
game_notify_map_changed();
}
else
{
if (_sequence->Saves.size() > saveIndex)
{
@@ -307,7 +311,11 @@ private:
{
loadSuccess = LoadParkFromFile(scenario->path);
}
if (!loadSuccess)
if (loadSuccess)
{
game_notify_map_changed();
}
else
{
Console::Error::WriteLine("Failed to load: \"%s\" for the title sequence.", command.Scenario);
return false;

1
src/openrct2-ui/windows/TitleMenu.cpp
View File

@@ -108,6 +108,7 @@ static void WindowTitleMenuScenarioselectCallback(const utf8* path)
{
OpenRCT2::GetContext()->LoadParkFromFile(path, false, true);
game_load_scripts();
game_notify_map_changed();
}
static void WindowTitleMenuMouseup(rct_window* w, rct_widgetindex widgetIndex)

1
src/openrct2-ui/windows/TopToolbar.cpp
View File

@@ -537,6 +537,7 @@ static void WindowTopToolbarScenarioselectCallback(const utf8* path)
window_close_by_class(WC_EDITOR_OBJECT_SELECTION);
GetContext()->LoadParkFromFile(path, false, true);
game_load_scripts();
game_notify_map_changed();
}
/**

1
src/openrct2/Context.cpp
View File

@@ -918,6 +918,7 @@ namespace OpenRCT2
#endif // DISABLE_NETWORK
{
game_load_scripts();
game_notify_map_changed();
}
break;
}

12
src/openrct2/Game.cpp
View File

@@ -513,6 +513,17 @@ void game_unload_scripts()
#endif
}
void game_notify_map_changed()
{
#ifdef ENABLE_SCRIPTING
using namespace OpenRCT2::Scripting;
auto& scriptEngine = GetContext()->GetScriptEngine();
auto& hookEngine = scriptEngine.GetHookEngine();
hookEngine.Call(HOOK_TYPE::MAP_CHANGE, false);
#endif
}
/**
*
* rct2: 0x0069E9A7
@@ -696,6 +707,7 @@ static void game_load_or_quit_no_save_prompt_callback(int32_t result, const utf8
window_close_by_class(WC_EDITOR_OBJECT_SELECTION);
context_load_park_from_file(path);
game_load_scripts();
game_notify_map_changed();
}
}

1
src/openrct2/Game.h
View File

@@ -160,6 +160,7 @@ void load_from_sv6(const char* path);
void game_load_init();
void game_load_scripts();
void game_unload_scripts();
void game_notify_map_changed();
void pause_toggle();
bool game_is_paused();
bool game_is_not_paused();

2
src/openrct2/network/NetworkBase.cpp
View File

@@ -403,6 +403,7 @@ bool NetworkBase::BeginServer(uint16_t port, const std::string& address)
_advertiser = CreateServerAdvertiser(listening_port);
game_load_scripts();
game_notify_map_changed();
return true;
}
@@ -2688,6 +2689,7 @@ void NetworkBase::Client_Handle_MAP([[maybe_unused]] NetworkConnection& connecti
{
game_load_init();
game_load_scripts();
game_notify_map_changed();
_serverState.tick = gCurrentTicks;
// window_network_status_open("Loaded new map from network");
_serverState.state = NetworkServerState::Ok;

10
src/openrct2/scripting/HookEngine.cpp
View File

@@ -31,6 +31,7 @@ static const EnumMap<HOOK_TYPE> HooksLookupTable({
{ "action.location", HOOK_TYPE::ACTION_LOCATION },
{ "guest.generation", HOOK_TYPE::GUEST_GENERATION },
{ "vehicle.crash", HOOK_TYPE::VEHICLE_CRASH },
{ "map.change", HOOK_TYPE::MAP_CHANGE },
{ "map.save", HOOK_TYPE::MAP_SAVE },
});
@@ -97,6 +98,15 @@ bool HookEngine::HasSubscriptions(HOOK_TYPE type) const
return !hookList.Hooks.empty();
}
bool HookEngine::IsValidHookForPlugin(HOOK_TYPE type, Plugin& plugin) const
{
if (type == HOOK_TYPE::MAP_CHANGE && plugin.GetMetadata().Type != PluginType::Intransient)
{
return false;
}
return true;
}
void HookEngine::Call(HOOK_TYPE type, bool isGameStateMutable)
{
auto& hookList = GetHookList(type);

2
src/openrct2/scripting/HookEngine.h
View File

@@ -40,6 +40,7 @@ namespace OpenRCT2::Scripting
ACTION_LOCATION,
GUEST_GENERATION,
VEHICLE_CRASH,
MAP_CHANGE,
MAP_SAVE,
COUNT,
UNDEFINED = -1,
@@ -87,6 +88,7 @@ namespace OpenRCT2::Scripting
void UnsubscribeAll(std::shared_ptr<const Plugin> owner);
void UnsubscribeAll();
bool HasSubscriptions(HOOK_TYPE type) const;
bool IsValidHookForPlugin(HOOK_TYPE type, Plugin& plugin) const;
void Call(HOOK_TYPE type, bool isGameStateMutable);
void Call(HOOK_TYPE type, const DukValue& arg, bool isGameStateMutable);
void Call(

5
src/openrct2/scripting/bindings/game/ScContext.hpp
View File

@@ -278,6 +278,11 @@ namespace OpenRCT2::Scripting
duk_error(ctx, DUK_ERR_ERROR, "Not in a plugin context");
}
if (!_hookEngine.IsValidHookForPlugin(hookType, *owner))
{
duk_error(ctx, DUK_ERR_ERROR, "Hook type not available for this plugin type.");
}
auto cookie = _hookEngine.Subscribe(hookType, owner, callback);
return std::make_shared<ScDisposable>([this, hookType, cookie]() { _hookEngine.Unsubscribe(hookType, cookie); });
}

1
src/openrct2/title/TitleScreen.cpp
View File

@@ -336,6 +336,7 @@ bool TitleScreen::TryLoadSequence(bool loadPreview)
if (!loadPreview)
{
GetContext()->GetGameState()->InitAll(DEFAULT_MAP_SIZE);
game_notify_map_changed();
}
return false;
}