Jayceon: Fixed the return value order in the Returns section as modelID was incorrectly listed after worldModelRotationX,Y,Z; it has been moved to its correct position to match the actual function return order implemented in the source code.

2026-08-01T09:09:50Z

Fixed the return value order in the Returns section as modelID was incorrectly listed after worldModelRotationX,Y,Z; it has been moved to its correct position to match the actual function return order implemented in the source code.

← Older revision		Revision as of 09:09, 1 August 2026
Line 9:		Line 9:
	bool -- hit		bool -- hit
	element -- hitElement		element -- hitElement
			int -- worldModelID
	float float float -- worldModelPositionX,Y,Z		float float float -- worldModelPositionX,Y,Z
	float float float -- worldModelRotationX,Y,Z		float float float -- worldModelRotationX,Y,Z
	~~int -- worldModelID~~
	int -- worldLODModelID		int -- worldLODModelID
	string -- entity type (vehicle, ped, object etc.)		string -- entity type (vehicle, ped, object etc.)
Line 46:		Line 46:
	*'''hit:''' ''true'' if there is a collision, ''false'' otherwise.		*'''hit:''' ''true'' if there is a collision, ''false'' otherwise.
	*'''hitElement:''' the MTA element hit if any, ''nil'' otherwise.		*'''hitElement:''' the MTA element hit if any, ''nil'' otherwise.
			*'''modelID:''' The ID of the element.
	*'''worldModelPositionX,Y,Z:''' World position of the detected element.		*'''worldModelPositionX,Y,Z:''' World position of the detected element.
	*'''worldModelRotationX,Y,Z:''' World rotation of the detected element.		*'''worldModelRotationX,Y,Z:''' World rotation of the detected element.
	*'''modelID:''' The ID of the element.
	*'''lodID:''' The ID of the element's LOD (or 0).		*'''lodID:''' The ID of the element's LOD (or 0).
	*'''entityType:''' The type of the element (building, vehicle, ped, object, dummy).		*'''entityType:''' The type of the element (building, vehicle, ped, object, dummy).

FileEX: Created page with "{{Client function}} NOTOC {{New feature/item|3.161|1.6.0|22837| The function checks whether there is an object within the given radius and returns information about it. The function works similarly to processLineOfSight, but instead of a straight line, it operates based on the specified radius, forming a sphere.}} ==Syntax== Return values labelled for ease of reference. bool -- hit element -- hitElement floa..."

2024-12-22T01:52:09Z

Created page with "{{Client function}} __NOTOC__ {{New feature/item|3.161|1.6.0|22837| The function checks whether there is an object within the given radius and returns information about it. The function works similarly to processLineOfSight, but instead of a straight line, it operates based on the specified radius, forming a sphere.}} ==Syntax== Return values labelled for ease of reference. <syntaxhighlight lang="lua"> bool -- hit element -- hitElement floa..."

New page

{{Client function}}
__NOTOC__
{{New feature/item|3.161|1.6.0|22837|
The function checks whether there is an object within the given radius and returns information about it. The function works similarly to [[processLineOfSight]], but instead of a straight line, it operates based on the specified radius, forming a sphere.}}

==Syntax==
Return values labelled for ease of reference.
<syntaxhighlight lang="lua">
bool -- hit
element -- hitElement
float float float -- worldModelPositionX,Y,Z
float float float -- worldModelRotationX,Y,Z
int -- worldModelID
int -- worldLODModelID
string -- entity type (vehicle, ped, object etc.)
testSphereAgainstWorld ( float startX, float startY, float startZ,
float radius,
[ bool ignoredElement = nil,
bool checkBuildings = true,
bool checkVehicles = true,
bool checkPeds = true,
bool checkObjects = true,
bool checkDummies = true,
bool ignoreSomeObjectsForCamera = false ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The start ''x'' position
*'''startY:''' The start ''y'' position
*'''startZ:''' The start ''z'' position
*'''radius:''' The radius of the sphere.

===Optional Arguments===
{{OptionalArg}}
*'''ignoredElement:''' Specifies the element to be excluded from collision detection within the sphere.
*'''checkBuildings:''' Specifies whether [[Building|buildings]] should be detected, i.e., elements of the default GTA map or those created using [[createBuilding]].
*'''checkVehicles:''' Specifies whether [[Vehicle|vehicles]] should be detected.
*'''checkPeds:''' Specifies whether [[Ped|peds]] (including [[Player|players]]) should be detected.
*'''checkObjects:''' Specifies whether [[Object|objects]] should be detected.
*'''checkDummies:''' Specifies whether internal GTA dummies should be detected. These are not used in the current MTA version so this argument can be set to ''false''.
*'''ignoreSomeObjectsForCamera:''' Specifies whether certain elements should be ignored. These are objects that have the (K) property in the 'object.dat' file. (i.e. Most dynamic objects like boxes or barrels).

===Returns===
The '''modelID''', '''lodID''', '''worldModelPositionX,Y,Z''', '''worldModelRotationX,Y,Z''' and '''entityType''' parameters are returned even if '''hitElement''' is '''nil'''.

*'''hit:''' ''true'' if there is a collision, ''false'' otherwise.
*'''hitElement:''' the MTA element hit if any, ''nil'' otherwise.
*'''worldModelPositionX,Y,Z:''' World position of the detected element.
*'''worldModelRotationX,Y,Z:''' World rotation of the detected element.
*'''modelID:''' The ID of the element.
*'''lodID:''' The ID of the element's LOD (or 0).
*'''entityType:''' The type of the element (building, vehicle, ped, object, dummy).

==Examples==
{{Needs Example}}

==See Also==
{{Client world functions}}

TestSphereAgainstWorld - Revision history

Jayceon: Fixed the return value order in the Returns section as modelID was incorrectly listed after worldModelRotationX,Y,Z; it has been moved to its correct position to match the actual function return order implemented in the source code.