- add surface index to world Lua interface

Author: SoapyMan

Diff for: game/shared/world.cpp

@@ -69,6 +69,9 @@ void CWorld::Lua_Init(sol::state& lua)
 		world[LUADOC_M("MapHeight", "(position: fix.VECTOR) : int - returns height value at specified 3D point")]
 			= &MapHeight;
 
+		world[LUADOC_M("GetSurfaceIndex", "(position: fix.VECTOR) : int - returns surface (road) index value at specified 3D point")]
+			= &GetSurfaceIndex;
+
 		world[LUADOC_M("QueryCollision", "(queryPos: fix.VECTOR, queryDist: int, func: function(box: BUILDING_BOX, cellObj: CELL_OBJECT)) - performs cell object query")]
 			= [](const VECTOR_NOPAD& queryPos, int queryDist, sol::function& func) {
 			QueryCollision(queryPos, queryDist, [&func](const BUILDING_BOX& box, CELL_OBJECT* co) {
@@ -700,6 +703,11 @@ void CWorld::FindSurface(const VECTOR_NOPAD& position, VECTOR_NOPAD& outNormal,
 	}
 }
 
+int CWorld::GetSurfaceIndex(const VECTOR_NOPAD& position)
+{
+	return g_levMap->GetSurfaceIndex(position);
+}
+
 //-------------------------------------------------------------
 
 void CWorld::QueryCollision(const VECTOR_NOPAD& queryPos, int queryDist, const BoxCollisionFn& func)

Diff for: game/shared/world.h

@@ -59,6 +59,19 @@ struct MODEL_EFEFCTS
 	Array<EFFECT_DESC> effects;
 };
 
+struct ROAD_PROPERTIES
+{
+	int index;
+	// TODO: accessors to short ConnectIdx[4];
+	// TODO: accessors to int8 NumLanes;
+	// TODO: accessors to int8 LaneDirs;
+	// TODO: accessors to int8 AILanes;
+
+	// TODO: type
+
+	// TODO: accessor to curve, straight, junction
+};
+
 // TODO: replace std::function with custom impl with allocator support
 using CellObjectIterateFn = std::function<bool(int listType, CELL_OBJECT* co)>;
 using BoxCollisionFn = std::function<bool(const BUILDING_BOX& box, CELL_OBJECT* co)>;
@@ -105,8 +118,14 @@ class CWorld
 	static ModelRef_t*		GetModelByIndex(int modelIndex);
 	static ModelRef_t*		GetModelByName(const char* name);
 
+	//------------------------------------------
+	// road surfaces
+
 	static int				MapHeight(const VECTOR_NOPAD& position);
 	static void				FindSurface(const VECTOR_NOPAD& position, VECTOR_NOPAD& outNormal, VECTOR_NOPAD& outPoint, sdPlane& outPlane);
+	static int				GetSurfaceIndex(const VECTOR_NOPAD& position);
+
+	static ROAD_PROPERTIES	GetRoadProperties(int surfaceIndex);
 
 	//------------------------------------------
 	// objects and collision

Diff for: routines/regions.h

@@ -106,6 +106,7 @@ class CBaseLevelMap
 	virtual CBaseLevelRegion*	GetRegion(int regionIdx) const = 0;
 
 	virtual void				FindSurface(const VECTOR_NOPAD& position, VECTOR_NOPAD& outPoint, sdPlane& outPlane) const = 0;
+	virtual int					GetSurfaceIndex(const VECTOR_NOPAD& position) const = 0;
 
 	// converters
 	void						WorldPositionToCellXZ(XZPAIR& cell, const VECTOR_NOPAD& position, const XZPAIR& offset = {0}) const;

Diff for: routines/regions_d1.cpp

@@ -5,6 +5,7 @@
 #include "core/cmdlib.h"
 #include "core/IVirtualStream.h"
 #include "math/isin.h"
+#include <climits>
 
 extern sdPlane g_defaultPlane;
 extern sdPlane g_seaPlane;
@@ -596,6 +597,20 @@ void CDriver1LevelMap::FindSurface(const VECTOR_NOPAD& position, VECTOR_NOPAD& o
 	}
 }
 
+int	CDriver1LevelMap::GetSurfaceIndex(const VECTOR_NOPAD& position) const
+{
+	ROUTE_DATA routeData;
+	if (!GetRoadInfo(routeData, position))
+	{
+		return -32;
+	}
+
+	if (routeData.roadIndex >= SHRT_MAX)
+		return -32;
+
+	return routeData.roadIndex;
+}
+
 //-------------------------------------------------------------
 // returns first cell object of cell
 //-------------------------------------------------------------

Diff for: routines/regions_d1.h

@@ -69,6 +69,7 @@ class CDriver1LevelMap : public CBaseLevelMap
 	CBaseLevelRegion*		GetRegion(int regionIdx) const override;
 
 	void					FindSurface(const VECTOR_NOPAD& position, VECTOR_NOPAD& outPoint, sdPlane& outPlane) const override;
+	int						GetSurfaceIndex(const VECTOR_NOPAD& position) const override;
 
 	//----------------------------------------
 	// cell iterator

Diff for: routines/regions_d2.cpp

@@ -753,6 +753,30 @@ void CDriver2LevelMap::FindSurface(const VECTOR_NOPAD& position, VECTOR_NOPAD& o
 	}
 }
 
+int CDriver2LevelMap::GetSurfaceIndex(const VECTOR_NOPAD& position) const
+{
+	VECTOR_NOPAD cellPos;
+	XZPAIR cell;
+	int level = 0;
+
+	cellPos.vx = position.vx - 512;	// FIXME: is that a quarter of a cell?
+	cellPos.vy = position.vy;
+	cellPos.vz = position.vz - 512;
+
+	WorldPositionToCellXZ(cell, cellPos);
+	const CDriver2LevelRegion* region = (CDriver2LevelRegion*)GetRegion(cell);
+
+	if (!region)
+		return -32;
+
+	const sdPlane* plane = region->SdGetCell(cellPos, level, SdGetBSP);
+
+	if (!plane)
+		return -32;
+
+	return plane->surfaceType - 32;
+}
+
 int	CDriver2LevelMap::GetRoadIndex(VECTOR_NOPAD& position) const
 {
 	VECTOR_NOPAD cellPos;

Diff for: routines/regions_d2.h

@@ -134,6 +134,7 @@ class CDriver2LevelMap : public CBaseLevelMap
 	CBaseLevelRegion*		GetRegion(int regionIdx) const override;
 
 	void					FindSurface(const VECTOR_NOPAD& position, VECTOR_NOPAD& outPoint, sdPlane& outPlane) const override;
+	int						GetSurfaceIndex(const VECTOR_NOPAD& position) const override;
 
 	int						GetRoadIndex(VECTOR_NOPAD& position) const;