Raycasting::testPointToPoint - Revision history

Shr0x: /* See also */

2025-03-16T17:42:56Z

ChronosX88: fix example of return value

2020-06-07T19:46:40Z

fix example of return value

← Older revision		Revision as of 19:46, 7 June 2020
Line 34:		Line 34:
	"z": -0.34		"z": -0.34
	},		},
	"entity": ~~780817~~		"entity": <entity object>
	}		}
	</pre>		</pre>

Dynn: Improved example code to correctly use flags

2020-06-04T12:12:05Z

Improved example code to correctly use flags

← Older revision		Revision as of 12:12, 4 June 2020
Line 68:		Line 68:
	let farAway = new mp.Vector3((direction.x * distance) + (position.x), (direction.y * distance) + (position.y), (direction.z * distance) + (position.z)); // calculate a random point, drawn on a invisible line between camera position and direction (* distance)		let farAway = new mp.Vector3((direction.x * distance) + (position.x), (direction.y * distance) + (position.y), (direction.z * distance) + (position.z)); // calculate a random point, drawn on a invisible line between camera position and direction (* distance)

	let result = mp.raycasting.testPointToPoint(position, farAway, [1, ~~16]~~); // now test point to point		let result = mp.raycasting.testPointToPoint(position, farAway, null, 17); // now test point to point - intersects with map and objects [1 + 16]

	return result; // and return the result ( undefined, if no hit )		return result; // and return the result ( undefined, if no hit )

Dynn: Improved syntax summary and descriptions hereof

2020-06-04T12:10:31Z

Improved syntax summary and descriptions hereof

← Older revision		Revision as of 12:10, 4 June 2020
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<pre>		<pre>
	mp.raycasting.testPointToPoint(pos1, pos2, [ignoredEntity], [flags]);		mp.raycasting.testPointToPoint(pos1, pos2, [ignoredEntity], [flags])
	</pre>		</pre>

	=== Required ~~Arguments~~ ===		=== Required arguments ===
	*'''pos1:''' Vector3		*'''pos1:''' Vector3
	*'''pos2:''' Vector3		*'''pos2:''' Vector3
	*'''ignoreEntity:''' Entity handle or object
	*'''flags:''' Int

	===Return value===		=== Optional arguments ===
			*'''ignoredEntity:''' Entity handle or object - example: mp.players.local
			*'''flags:''' Int representing sum of flags - example: 17 (intersect with map [1] and objects [16])

			=== Return value ===
	*'''object'''		*'''object'''


			'''Example of return object'''
			<pre>
			{
			"position": {
			"x": 13.01,
			"y": 12.23,
			"z": 70.02
			},
			"surfaceNormal": {
			"x": 0.93,
			"y": -0.04,
			"z": -0.34
			},
			"entity": 780817
			}
			</pre>

	==Example==		==Example==

Unknown at 12:29, 21 December 2018

2018-12-21T12:29:23Z

← Older revision		Revision as of 12:29, 21 December 2018
Line 1:		Line 1:
			{{ClientsideJsFunction}}

			== Description ==
	This function casts a ray from Point1 to Point2 and returns the position and entity of what's in the way, or undefined if the way is cleared.<br><br>Flags are intersection bit flags. They tell the ray what to care about and what not to care about when casting. Passing -1 will intersect with everything, presumably.<br><br>Flags:<br>1: Intersect with map<br>2: Intersect with vehicles (used to be mission entities?) (includes train)<br>4: Intersect with peds? (same as 8)<br>8: Intersect with peds? (same as 4)<br>16: Intersect with objects<br>32: Unknown<br>64: Unknown<br>128: Unknown<br>256: Intersect with vegetation (plants, coral. trees not included)<br><br>NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.		This function casts a ray from Point1 to Point2 and returns the position and entity of what's in the way, or undefined if the way is cleared.<br><br>Flags are intersection bit flags. They tell the ray what to care about and what not to care about when casting. Passing -1 will intersect with everything, presumably.<br><br>Flags:<br>1: Intersect with map<br>2: Intersect with vehicles (used to be mission entities?) (includes train)<br>4: Intersect with peds? (same as 8)<br>8: Intersect with peds? (same as 4)<br>16: Intersect with objects<br>32: Unknown<br>64: Unknown<br>128: Unknown<br>256: Intersect with vegetation (plants, coral. trees not included)<br><br>NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.

Line 55:		Line 58:
	{{Worldprobe_s_function_c}}		{{Worldprobe_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	~~[[Category:TODO: Example]]~~

Splak: /* Example */

2018-12-19T14:57:06Z

Example

← Older revision		Revision as of 14:57, 19 December 2018
Line 31:		Line 31:
	</pre>		</pre>
	}}		}}


	This function returns undefined or a valid result, if you point with your camera on something.		This function returns undefined or a valid result, if you point with your camera on something.

Splak: /* Example */

2018-12-19T14:57:01Z

Example

← Older revision		Revision as of 14:57, 19 December 2018
Line 32:		Line 32:
	}}		}}

			This function returns undefined or a valid result, if you point with your camera on something.
	{{ClientsideCode\|		{{ClientsideCode\|
	<pre>		<pre>

Splak: /* Example */

2018-12-19T14:56:41Z

Example

@@ Line 29: / Line 29: @@
+	}
 });
 </pre>
 }}

Splak: /* Example */

2018-12-19T14:56:33Z

Example

@@ Line 29: / Line 29: @@
+	}
 });
 </pre>
 }}

Splak: /* Example */

2018-12-19T14:56:16Z

Example

@@ Line 29: / Line 29: @@
+	}
 });
 </pre>
 }}

← Older revision		Revision as of 17:42, 16 March 2025
Line 76:		Line 76:

	==See also==		==See also==
	{{~~Worldprobe_s_function_c~~}}		{{Raycast_functions_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]