Rays and hotkeys

CHANGELOG.md

@@ -58,12 +58,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New hotkey system for `Actor` and `HeldDevice`.
 	Pressing a certain new hotkey will mark it as activated on `Actor` and `HeldDevice`, letting scripts make use of the new bindings easily.
-	`Enum` binding for `HeldDevice.HeldDeviceHotkeyType`: `PRIMARY = 0, AUXILIARY = 1, HELDDEVICEHOTKEYTYPECOUNT = 2`.  
-	`Enum` binding for `Actor.ActorHotkeyType`: `PRIMARY = 0, AUXILIARY = 1, ACTORHOTKEYTYPECOUNT = 2`. 
+	`Enum` binding for `HeldDevice.HeldDeviceHotkeyType`: `PRIMARYHOTKEY = 0, AUXILIARYHOTKEY = 1, HELDDEVICEHOTKEYTYPECOUNT = 2`.  
+	`Enum` binding for `Actor.ActorHotkeyType`: `PRIMARYHOTKEY = 0, AUXILIARYHOTKEY = 1, ACTORHOTKEYTYPECOUNT = 2`. 
 	Both `Actor` and `HeldDevice` have the following functions:
 	`HotkeyActionIsActivated(hotkeyType)` returns whether a certain hotkey action is being activated or not.
 	`ActivateHotkeyAction(hotkeyType)` activates a certain hotkey action.
 	`DeactivateHotkeyAction(hotkeyType)` deactivates a certain hotkey action.
+
+- New `Controller` state `WEAPON_RELOADHELD`, which is true every frame reload input is held (as opposed to `WEAPON_RELOAD` which is only true once when pressed).
 
 - New `GAScripted` Lua script method `IsCompatibleScene(scene)` to allow Activities to generically decide which Scenes are eligible by returning a boolean value.
 	New `GAScripted` INI enumerating property `AddRequiredArea`, replacing Lua file scanning, to allow Activities to explicitly state which areas are strictly required.
@@ -81,6 +83,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `ACraft` INI and Lua (R/W) property `CanEnterOrbit`, which determines whether a craft can enter orbit (and refund gold appropriately) or not. If false, default out-of-bounds deletion logic applies.
 
+- New `MovableMan` function `GetMOsAtPosition(posX, posY, ignoreTeam, getsHitByMOsOnly)` that will return an iterator with all the `MovableObject`s that intersect that exact position with their sprite.
+
+- New `SceneMan` function `CastAllMOsRay(startVector, rayVector, table ignoreMOIDs, ignoreTeam, ignoreMaterial, bool ignoreAllTerrain, int skip)` which returns an iterator with pointers to all the non-ignored MOs met along the ray.
+
 </details>
 
 <details><summary><b>Changed</b></summary>
@@ -127,6 +133,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - `MOSRotating` Lua function `AddWound` now additionally accepts the format `MOSRotating:AddWound(AEmitter* woundToAdd, const Vector& parentOffsetToSet, bool checkGibWoundLimit, bool isEntryWound, bool isExitWound)`, allowing modders to specify added wounds as entry- or exit wounds, for the purpose of not playing multiple burst sounds on the same frame. These new arguments are optional.
 
+- `SceneMan` function `CastFindMORay` now has an extra bool parameter `findChildMOIDs` that denotes whether it also triggers on child MOIDs or not, which defaults to true for the same default behavior as before.
+
+- `SceneMan` function `CastMORay` now can also accept a table of MOIDs instead of a single MOID, letting you ignore any arbitrary set of MOIDs.
+
 - Techion Laser Rifle now has a constant range rather than being dependent on game resolution.
 
 - Various performance improvements.

Data/Base.rte/GUIs/SettingsGUI.ini

@@ -1612,7 +1612,7 @@ Parent = CollectionBoxScrollingMappingClipBox
 X = 0
 Y = 0
 Width = 440
-Height = 369
+Height = 540
 Visible = True
 Enabled = True
 Name = CollectionBoxScrollingMappingBox
@@ -2465,7 +2465,7 @@ Text = [InputKey]
 [LabelInputName29]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
-X = 215
+X = 5
 Y = 355
 Width = 110
 Height = 20
@@ -2481,7 +2481,7 @@ VAlignment = middle
 [ButtonInputKey29]
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
-X = 330
+X = 120
 Y = 355
 Width = 95
 Height = 20
@@ -2496,7 +2496,7 @@ Text = [InputKey]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
 X = 215
-Y = 380
+Y = 355
 Width = 110
 Height = 20
 Visible = True
@@ -2512,7 +2512,7 @@ VAlignment = middle
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
 X = 330
-Y = 380
+Y = 355
 Width = 95
 Height = 20
 Visible = True
@@ -2525,7 +2525,7 @@ Text = [InputKey]
 [LabelInputName31]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
-X = 215
+X = 5
 Y = 380
 Width = 110
 Height = 20
@@ -2541,7 +2541,7 @@ VAlignment = middle
 [ButtonInputKey31]
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
-X = 330
+X = 120
 Y = 380
 Width = 95
 Height = 20
@@ -2585,8 +2585,8 @@ Text = [InputKey]
 [LabelInputName33]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
-X = 215
-Y = 380
+X = 5
+Y = 405
 Width = 110
 Height = 20
 Visible = True
@@ -2601,8 +2601,8 @@ VAlignment = middle
 [ButtonInputKey33]
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
-X = 330
-Y = 380
+X = 120
+Y = 405
 Width = 95
 Height = 20
 Visible = True
@@ -2616,7 +2616,7 @@ Text = [InputKey]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
 X = 215
-Y = 380
+Y = 405
 Width = 110
 Height = 20
 Visible = True
@@ -2632,7 +2632,7 @@ VAlignment = middle
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
 X = 330
-Y = 380
+Y = 405
 Width = 95
 Height = 20
 Visible = True

Data/Base.rte/GUIs/SettingsPauseGUI.ini

@@ -1613,7 +1613,7 @@ Parent = CollectionBoxScrollingMappingClipBox
 X = 0
 Y = 0
 Width = 440
-Height = 369
+Height = 540
 Visible = True
 Enabled = True
 Name = CollectionBoxScrollingMappingBox
@@ -2466,7 +2466,7 @@ Text = [InputKey]
 [LabelInputName29]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
-X = 215
+X = 5
 Y = 355
 Width = 110
 Height = 20
@@ -2482,7 +2482,7 @@ VAlignment = middle
 [ButtonInputKey29]
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
-X = 330
+X = 120
 Y = 355
 Width = 95
 Height = 20
@@ -2497,7 +2497,7 @@ Text = [InputKey]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
 X = 215
-Y = 380
+Y = 355
 Width = 110
 Height = 20
 Visible = True
@@ -2513,7 +2513,7 @@ VAlignment = middle
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
 X = 330
-Y = 380
+Y = 355
 Width = 95
 Height = 20
 Visible = True
@@ -2526,7 +2526,7 @@ Text = [InputKey]
 [LabelInputName31]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
-X = 215
+X = 5
 Y = 380
 Width = 110
 Height = 20
@@ -2542,7 +2542,7 @@ VAlignment = middle
 [ButtonInputKey31]
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
-X = 330
+X = 120
 Y = 380
 Width = 95
 Height = 20
@@ -2586,8 +2586,8 @@ Text = [InputKey]
 [LabelInputName33]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
-X = 215
-Y = 380
+X = 5
+Y = 405
 Width = 110
 Height = 20
 Visible = True
@@ -2602,8 +2602,8 @@ VAlignment = middle
 [ButtonInputKey33]
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
-X = 330
-Y = 380
+X = 120
+Y = 405
 Width = 95
 Height = 20
 Visible = True
@@ -2617,7 +2617,7 @@ Text = [InputKey]
 ControlType = LABEL
 Parent = CollectionBoxScrollingMappingBox
 X = 215
-Y = 380
+Y = 405
 Width = 110
 Height = 20
 Visible = True
@@ -2633,7 +2633,7 @@ VAlignment = middle
 ControlType = BUTTON
 Parent = CollectionBoxScrollingMappingBox
 X = 330
-Y = 380
+Y = 405
 Width = 95
 Height = 20
 Visible = True

Source/Entities/MOPixel.cpp

@@ -140,8 +140,8 @@ void MOPixel::SetTrailLength(int trailLength) {
 	m_Atom->SetTrailLength(trailLength);
 }
 
-bool MOPixel::HitTestAtPixel(int pixelX, int pixelY) const {
-	if (!GetsHitByMOs() || GetRootParent()->GetTraveling()) {
+bool MOPixel::HitTestAtPixel(int pixelX, int pixelY, bool validOnly) const {
+	if (validOnly && (!GetsHitByMOs() || GetRootParent()->GetTraveling())) {
 		return false;
 	}
 

Source/Entities/MOPixel.h

@@ -125,8 +125,9 @@ namespace RTE {
 		/// Whether a set of X, Y coordinates overlap us (in world space).
 		/// @param pixelX The given X coordinate, in world space.
 		/// @param pixelY The given Y coordinate, in world space.
+		/// @param validOnly Whether to return false if this MO isn't validly owned by MovableMan or not.
 		/// @return Whether the given coordinate overlap us.
-		bool HitTestAtPixel(int pixelX, int pixelY) const override;
+		bool HitTestAtPixel(int pixelX, int pixelY, bool validOnly = true) const override;
 #pragma endregion
 
 #pragma region Virtual Override Methods

Source/Entities/MOSprite.cpp

@@ -240,8 +240,8 @@ void MOSprite::Destroy(bool notInherited) {
 	Clear();
 }
 
-bool MOSprite::HitTestAtPixel(int pixelX, int pixelY) const {
-	if (!GetsHitByMOs() || GetRootParent()->GetTraveling()) {
+bool MOSprite::HitTestAtPixel(int pixelX, int pixelY, bool validOnly) const {
+	if (validOnly && (!GetsHitByMOs() || GetRootParent()->GetTraveling())) {
 		return false;
 	}
 

Source/Entities/MOSprite.h

@@ -127,8 +127,9 @@ namespace RTE {
 		/// Whether a set of X, Y coordinates overlap us (in world space).
 		/// @param pixelX The given X coordinate, in world space.
 		/// @param pixelY The given Y coordinate, in world space.
+		/// @param validOnly Whether to return false if this MO isn't validly owned by MovableMan or not.
 		/// @return Whether the given coordinate overlap us.
-		bool HitTestAtPixel(int pixelX, int pixelY) const override;
+		bool HitTestAtPixel(int pixelX, int pixelY, bool validOnly = true) const override;
 
 		/// Gets the current angular velocity of this MovableObject. Positive is
 		/// a counter-clockwise rotation.

Source/Entities/MovableObject.h

@@ -588,8 +588,9 @@ namespace RTE {
 		/// Whether a set of X, Y coordinates overlap us (in world space).
 		/// @param pixelX The given X coordinate, in world space.
 		/// @param pixelY The given Y coordinate, in world space.
+		/// @param validOnly Whether to return false if this MO isn't validly owned by MovableMan or not.
 		/// @return Whether the given coordinate overlap us.
-		virtual bool HitTestAtPixel(int pixelX, int pixelY) const { return false; }
+		virtual bool HitTestAtPixel(int pixelX, int pixelY, bool validOnly = true) const { return false; }
 
 		/// Shows whether this is or carries a specifically named object in its
 		/// inventory. Also looks through the inventories of potential passengers,

Source/Lua/LuaAdapterDefinitions.h

@@ -512,6 +512,90 @@ namespace RTE {
 
 #pragma region SceneMan Lua Adapters
 	struct LuaAdaptersSceneMan {
+		/// Traces along a vector and returns MOID of the first non-ignored
+		/// non-NoMOID MO encountered. If a non-air terrain pixel is encountered
+		/// first, g_NoMOID will be returned.
+		/// @param start The starting position.
+		/// @param ray The vector to trace along.
+		/// @param ignoreMOIDs A vector of MOIDs to ignore. Any child MO's of this MOID will also be ignored. (default: g_NoMOID)
+		/// @param ignoreTeam To enable ignoring of all MOIDs associated with an object of a specific (default: Activity::NoTeam)
+		/// team which also has team ignoring enabled itself.
+		/// @param ignoreMaterial A specific material ID to ignore hits with. (default: 0)
+		/// @param ignoreAllTerrain Whether to ignore all terrain hits or not. (default: false)
+		/// @param skip For every pixel checked along the line, how many to skip between them (default: 0)
+		/// for optimization reasons. 0 = every pixel is checked.
+		/// @return The MOID of the hit non-ignored MO, or g_NoMOID if terrain or no MO was hit.
+		static MOID CastMORay1(SceneMan& sceneMan, const Vector& start, const Vector& ray, const luabind::object& ignoreMOIDs, int ignoreTeam = Activity::NoTeam, unsigned char ignoreMaterial = 0, bool ignoreAllTerrain = false, int skip = 0);
+
+		/// Traces along a vector and returns MOID of the first non-ignored
+		/// non-NoMOID MO encountered. If a non-air terrain pixel is encountered
+		/// first, g_NoMOID will be returned.
+		/// @param start The starting position.
+		/// @param ray The vector to trace along.
+		/// @param ignoreMOID An MOID to ignore. Any child MO's of this MOID will also be ignored. (default: g_NoMOID)
+		/// @param ignoreTeam To enable ignoring of all MOIDs associated with an object of a specific (default: Activity::NoTeam)
+		/// team which also has team ignoring enabled itself.
+		/// @param ignoreMaterial A specific material ID to ignore hits with. (default: 0)
+		/// @param ignoreAllTerrain Whether to ignore all terrain hits or not. (default: false)
+		/// @param skip For every pixel checked along the line, how many to skip between them (default: 0)
+		/// for optimization reasons. 0 = every pixel is checked.
+		/// @return The MOID of the hit non-ignored MO, or g_NoMOID if terrain or no MO was hit.
+		static MOID CastMORay2(SceneMan& sceneMan, const Vector& start, const Vector& ray, MOID ignoreMOID = g_NoMOID, int ignoreTeam = Activity::NoTeam, unsigned char ignoreMaterial = 0, bool ignoreAllTerrain = false, int skip = 0);
+
+		/// Traces along a vector and returns a vector of all MOs encountered.
+		/// @param start The starting position.
+		/// @param ray The vector to trace along.
+		/// @param ignoreMOIDs A vector of MOIDs to ignore. Any child MOs of an MOID will also be ignored. (default: g_NoMOID)
+		/// @param ignoreTeam To enable ignoring of all MOIDs associated with an object of a specific team (default: Activity::NoTeam)
+		/// @param ignoreMaterial A specific material ID to ignore hits with. (default: 0)
+		/// @param ignoreAllTerrain Whether to ignore all terrain hits or not. (default: false)
+		/// @param skip For every pixel checked along the line, how many to skip between them (default: 0)
+		/// for optimization reasons. 0 = every pixel is checked.
+		/// @return A vector of pointers to all MovableObjects met along the ray, who aren't ignored.
+		static const std::vector<MovableObject*>* CastAllMOsRay(SceneMan& sceneMan, const Vector& start, const Vector& ray, const luabind::object& ignoreMOIDs, int ignoreTeam = Activity::NoTeam, unsigned char ignoreMaterial = 0, bool ignoreAllTerrain = false, int skip = 0);
+
+		/// Traces along a vector and returns the length of how far the trace went
+		/// without hitting any non-ignored terrain material or MOID at all.
+		/// @param start The starting position.
+		/// @param ray The vector to trace along.
+		/// @param obstaclePos A reference to the vector screen will be filled out with the absolute
+		/// location of the first obstacle, or the end of the ray if none was hit.
+		/// @param freePos A reference to the vector screen will be filled out with the absolute
+		/// location of the last free position before hitting an obstacle, or the
+		/// end of the ray if none was hit. This is only altered if thre are any
+		/// free pixels encountered.
+		/// @param ignoreMOIDs A vector of MOIDs to ignore. Any child MO's of an MOID will also be ignored. (default: g_NoMOID)
+		/// @param ignoreTeam To enable ignoring of all MOIDs associated with an object of a specific (default: Activity::NoTeam)
+		/// team which also has team ignoring enabled itself.
+		/// @param ignoreMaterial A specific material ID to ignore hits with. (default: 0)
+		/// @param skip For every pixel checked along the line, how many to skip between them (default: 0)
+		/// for optimization reasons. 0 = every pixel is checked.
+		/// @return How far along, in pixel units, the ray the pixel of any obstacle was
+		/// encountered. If no pixel of the right material was found, < 0 is returned.
+		/// If an obstacle on the starting position was encountered, 0 is returned.
+		static float CastObstacleRay1(SceneMan& sceneMan, const Vector& start, const Vector& ray, Vector& obstaclePos, Vector& freePos, const luabind::object& ignoreMOIDs, int ignoreTeam = Activity::NoTeam, unsigned char ignoreMaterial = 0, int skip = 0);
+
+		/// Traces along a vector and returns the length of how far the trace went
+		/// without hitting any non-ignored terrain material or MOID at all.
+		/// @param start The starting position.
+		/// @param ray The vector to trace along.
+		/// @param obstaclePos A reference to the vector screen will be filled out with the absolute
+		/// location of the first obstacle, or the end of the ray if none was hit.
+		/// @param freePos A reference to the vector screen will be filled out with the absolute
+		/// location of the last free position before hitting an obstacle, or the
+		/// end of the ray if none was hit. This is only altered if thre are any
+		/// free pixels encountered.
+		/// @param ignoreMOID An MOID to ignore. Any child MOs of this MOID will also be ignored. (default: g_NoMOID)
+		/// @param ignoreTeam To enable ignoring of all MOIDs associated with an object of a specific (default: Activity::NoTeam)
+		/// team which also has team ignoring enabled itself.
+		/// @param ignoreMaterial A specific material ID to ignore hits with. (default: 0)
+		/// @param skip For every pixel checked along the line, how many to skip between them (default: 0)
+		/// for optimization reasons. 0 = every pixel is checked.
+		/// @return How far along, in pixel units, the ray the pixel of any obstacle was
+		/// encountered. If no pixel of the right material was found, < 0 is returned.
+		/// If an obstacle on the starting position was encountered, 0 is returned.
+		static float CastObstacleRay2(SceneMan& sceneMan, const Vector& start, const Vector& ray, Vector& obstaclePos, Vector& freePos, MOID ignoreMOID = g_NoMOID, int ignoreTeam = Activity::NoTeam, unsigned char ignoreMaterial = 0, int skip = 0);
+
 		/// Takes a Box and returns a list of Boxes that describe the Box, wrapped appropriately for the current Scene.
 		/// @param boxToWrap The Box to wrap.
 		/// @return A list of Boxes that make up the Box to wrap, wrapped appropriately for the current Scene.