Merge Track natives (pr-2973)

a242c82 - feat(extra-natives/five): track natives

code/components/extra-natives-five/src/TrackNatives.cpp

@@ -0,0 +1,186 @@
+/*
+* This file is part of the CitizenFX project - http://citizen.re/
+*
+* See LICENSE and MENTIONS in the root of the source tree for information
+* regarding licensing.
+*/
+
+#include "StdInc.h"
+#include <ScriptEngine.h>
+#include <Hooking.h>
+#include <limits>
+#include <MinHook.h>
+#include <rageVectors.h>
+
+struct TrackNode
+{
+public:
+	float m_x, m_y, m_z;
+	float m_unk;
+	uint8_t m_unk1;
+	int m_station;
+};
+
+struct TrackData
+{
+public:
+	uint32_t m_hash;
+	bool m_enabled;
+	bool m_isLooped;
+	bool m_stopsAtStation;
+	bool m_MPStopsAtStation;
+	uint32_t m_speed;
+	uint32_t m_brakeDistance;
+
+	int m_nodeCount;
+	TrackNode* m_nodes;
+
+	uint8_t m_pad[8];
+
+	bool m_disableAmbientTrains;
+	// and a bunch of other fields...
+};
+
+static hook::cdecl_stub<TrackData* (uint32_t)> getTrainTrack([]
+{
+	return hook::get_call(hook::get_pattern("E8 ? ? ? ? 33 DB 45 0F 57 DB"));
+});
+
+static float calculateDistance(const rage::Vector3& point1, const float& x, const float& y, const float& z)
+{
+	return (point1.x - x) * (point1.x - x) + (point1.y - y) * (point1.y - y) + (point1.z - z) * (point1.z - z);
+}
+
+// This has never changed.
+static constexpr int kMaxTrainTracks = 27;
+
+static int32_t FindClosestTrack(rage::Vector3& position, int8_t* outTrack)
+{
+	*outTrack = -1;
+	float closestDistance = std::numeric_limits<float>::infinity();
+	int closestNode = -1;
+
+	for (int i = 0; i < kMaxTrainTracks; i++)
+	{
+		TrackData* track = getTrainTrack(i);
+
+		// Skip if this track is a nullptr or is currently disabled. The game doesn't check for this.
+		if (!track || !track->m_enabled)
+		{
+			continue;
+		}
+
+		for (int n = 0; n < track->m_nodeCount; n++)
+		{
+			TrackNode node = track->m_nodes[n];
+
+			float Distance = calculateDistance(position, node.m_x, node.m_y, node.m_z);
+
+			if (Distance < closestDistance)
+			{
+				closestNode = n;
+				*outTrack = i;
+				closestDistance = Distance;
+			}
+		}
+	}
+
+	return closestNode;
+}
+
+
+static HookFunction hookFunction([]()
+{
+	MH_Initialize();
+	// add missing enabled check for script created trains.
+	MH_CreateHook(hook::get_call(hook::get_pattern("E8 ? ? ? ? 8B D8 E8 ? ? ? ? 44 8A CF")), FindClosestTrack, NULL);
+	MH_EnableHook(MH_ALL_HOOKS);
+
+	// Prevent game code from constantly setting the trains speed while in moving state if it has the "stopsAtStations" flag enabled from setting the train speed to the tracks max speed while moving.
+	hook::nop(hook::get_pattern("F3 0F 10 75 ? 8B 55"), 5);
+});
+
+static TrackData* getAndCheckTrack(fx::ScriptContext& context, std::string_view nn)
+{
+	int trackIndex = context.GetArgument<int>(0);
+	if (trackIndex < 0 || trackIndex > kMaxTrainTracks)
+	{
+		trace("Invalid track index %i passed to %s\n", trackIndex, nn);
+		context.SetResult(0);
+		return NULL;
+	}
+
+	TrackData* track = getTrainTrack(trackIndex);
+
+	if (!track || track->m_hash == 0)
+	{
+		trace("Track index %i passed to %s does not exist\n", trackIndex, nn);
+		context.SetResult(0);
+		return NULL;
+	}
+
+	return track;
+}
+
+static InitFunction initFunction([]()
+{
+	fx::ScriptEngine::RegisterNativeHandler("SET_TRACK_MAX_SPEED", [](fx::ScriptContext& context)
+	{
+		int maxSpeed = context.CheckArgument<int>(1);
+
+		if (TrackData* track = getAndCheckTrack(context, "SET_TRACK_MAX_SPEED"))
+		{
+			track->m_speed = maxSpeed;
+		}
+	});
+
+	fx::ScriptEngine::RegisterNativeHandler("GET_TRACK_MAX_SPEED", [](fx::ScriptContext& context)
+	{
+		if (TrackData* track = getAndCheckTrack(context, "GET_TRACK_MAX_SPEED"))
+		{
+			context.SetResult<int>(track->m_speed);
+		}
+	});
+
+	fx::ScriptEngine::RegisterNativeHandler("GET_TRACK_BRAKING_DISTANCE", [](fx::ScriptContext& context)
+	{
+		if (TrackData* track = getAndCheckTrack(context, "GET_TRACK_BRAKING_DISTANCE"))
+		{
+			context.SetResult<int>(track->m_brakeDistance);
+		}
+	});
+
+	fx::ScriptEngine::RegisterNativeHandler("SET_TRACK_BRAKING_DISTANCE", [](fx::ScriptContext& context)
+	{
+		int brakeDistance = context.CheckArgument<int>(1);
+		if (TrackData* track = getAndCheckTrack(context, "SET_TRACK_BRAKING_DISTANCE"))
+		{
+			track->m_brakeDistance = brakeDistance;
+		}
+	});
+
+	fx::ScriptEngine::RegisterNativeHandler("SET_TRACK_ENABLED", [](fx::ScriptContext& context)
+	{
+		bool state = context.GetArgument<bool>(1);
+		if (TrackData* track = getAndCheckTrack(context, "SET_TRACK_ENABLED"))
+		{
+			track->m_enabled = state;
+		}
+	});
+
+	fx::ScriptEngine::RegisterNativeHandler("IS_TRACK_ENABLED", [](fx::ScriptContext& context)
+	{
+		if (TrackData* track = getAndCheckTrack(context, "IS_TRACK_ENABLED"))
+		{
+			context.SetResult<bool>(track->m_enabled);
+		}
+	});
+
+	fx::ScriptEngine::RegisterNativeHandler("IS_TRACK_SWITCHED_OFF", [](fx::ScriptContext& context)
+	{
+		if (TrackData* track = getAndCheckTrack(context, "IS_TRACK_SWITCHED_OFF"))
+		{
+			context.SetResult<bool>(track->m_disableAmbientTrains);
+		}
+	});
+});

ext/native-decls/GetTrackBrakingDistance.md

@@ -0,0 +1,16 @@
+---
+ns: CFX
+apiset: client
+game: gta5
+---
+## GET_TRACK_BRAKING_DISTANCE
+
+```c
+float GET_TRACK_BRAKING_DISTANCE(int track);
+```
+
+## Parameters
+* **track**: The track id (between 0 - 27)
+
+## Return Value
+The braking distance of the track. Used by trains to determine the point to slow down at when entering a station.

ext/native-decls/GetTrackMaxSpeed.md

@@ -0,0 +1,16 @@
+---
+ns: CFX
+apiset: client
+game: gta5
+---
+## GET_TRACK_MAX_SPEED
+
+```c
+float GET_TRACK_MAX_SPEED(int track);
+```
+
+## Parameters
+* **track**: The track id (between 0 - 27)
+
+## Return Value
+The max speed of the track

ext/native-decls/IsTrackEnabled.md

@@ -0,0 +1,18 @@
+---
+ns: CFX
+apiset: client
+game: gta5
+---
+## IS_TRACK_ENABLED
+
+```c
+bool IS_TRACK_ENABLED(int track);
+```
+
+Getter for [SET_TRACK_ENABLED](?_0x4b41e84c)
+
+## Parameters
+* **track**: The track id (between 0 - 27)
+
+## Return Value
+If this track is enabled.

ext/native-decls/IsTrackSwitchedOff.md

@@ -0,0 +1,18 @@
+---
+ns: CFX
+apiset: client
+game: gta5
+---
+## IS_TRACK_SWITCHED_OFF
+
+```c
+bool IS_TRACK_SWITCHED_OFF(int track);
+```
+
+Getter for [SWITCH_TRAIN_TRACK](?_0xFD813BB7DB977F20). Determines if ambient trains are able to spawn on this track.
+
+## Parameters
+* **track**: The track id (between 0 - 27)
+
+## Return Value
+If this track allows ambient trains to spawn

ext/native-decls/SetTrackBrakingDistance.md

@@ -0,0 +1,16 @@
+---
+ns: CFX
+apiset: client
+game: gta5
+---
+## SET_TRACK_BRAKING_DISTANCE
+
+```c
+void SET_TRACK_BRAKING_DISTANCE(int track, float brakingDistance);
+```
+
+Sets the braking distance of the track. Used by trains to determine the point to slow down when entering a station.
+
+## Parameters
+* **track**: The track id (between 0 - 27)
+* **brakingDistance**: The new braking distance

ext/native-decls/SetTrackEnabled.md

@@ -0,0 +1,16 @@
+---
+ns: CFX
+apiset: client
+game: gta5
+---
+## SET_TRACK_ENABLED
+
+```c
+void SET_TRACK_ENABLED(int track, bool enabled);
+```
+
+Toggles the track being active. If disabled mission trains will not be able to spawn on this track and will look for the next closest track to spawn
+
+## Parameters
+* **track**: The track id (between 0 - 27)
+* **enabled**: Should this track be enabled

ext/native-decls/SetTrackMaxSpeed.md

@@ -0,0 +1,16 @@
+---
+ns: CFX
+apiset: client
+game: gta5
+---
+## SET_TRACK_MAX_SPEED
+
+```c
+void SET_TRACK_MAX_SPEED(int track, int newSpeed);
+```
+
+Sets the max speed for the train tracks. Used by ambient trains and for station calculations
+
+## Parameters
+* **track**: The track id (between 0 - 27)
+* **newSpeed**: The tracks new speed