ProcessLineOfSight - Revision history

FileEX at 23:00, 8 June 2024

2024-06-08T23:00:07Z

← Older revision		Revision as of 23:00, 8 June 2024
Line 27:		Line 27:
	string -- textureName,		string -- textureName,
	string -- frameName,		string -- frameName,
	float float float -- ~~extraHitX~~, ~~extraHitY~~, ~~extraHitZ~~		float float float -- modelHitX, modelHitY, modelHitZ
	processLineOfSight ( float startX, float startY, float startZ,		processLineOfSight ( float startX, float startY, float startZ,
	float endX, float endY, float endZ,		float endX, float endY, float endZ,
Line 66:		Line 66:
	*'''bIncludeCarTyres :''' Includes car tyre hits.		*'''bIncludeCarTyres :''' Includes car tyre hits.
	{{New feature/item\|3.161\|1.6.0\|22173\|		{{New feature/item\|3.161\|1.6.0\|22173\|
	*'''bIncludeExtraMateriaInfo:''' Include the material info like UV coords, textureName, frameName and ~~precision clump~~ hit ~~position~~.		*'''bIncludeExtraMateriaInfo:''' Include the material info like UV coords, textureName, frameName and exact position hit on the model.
	}}		}}

Pirulax at 19:18, 8 June 2024

2024-06-08T19:18:48Z

← Older revision		Revision as of 19:18, 8 June 2024
Line 86:		Line 86:
	*'''worldModelRotationX,Y,Z:''' If worldModelID is set, this will contain the world model rotation.		*'''worldModelRotationX,Y,Z:''' If worldModelID is set, this will contain the world model rotation.
	*'''worldLODModelID:''' If worldModelID is set, this will contain the LOD model ID if applicable.		*'''worldLODModelID:''' If worldModelID is set, this will contain the LOD model ID if applicable.
	*'''uvX, uvY:''' If bIncludeExtraMateriaInfo is set, it contains the texture UV positions of the triangle of the hit entity.		*'''uvX, uvY:''' If bIncludeExtraMateriaInfo is set, it contains the texture UV positions of the hit triangle of the hit entity.
	*'''textureName:''' Same as above, but contains the texture name.		*'''textureName:''' Same as above, but contains the texture name.
	*'''frameName:''' Same as above, but contains the frame name. (This, for example in case of cars this is (but not limited to) a [[Vehicle Components]])		*'''frameName:''' Same as above, but contains the frame name. (This, for example in case of cars this is (but not limited to) a [[Vehicle Components]])

Pirulax: Fix last edit (Clarify function arguments)

2024-06-08T19:18:06Z

Fix last edit (Clarify function arguments)

← Older revision		Revision as of 19:18, 8 June 2024
Line 86:		Line 86:
	*'''worldModelRotationX,Y,Z:''' If worldModelID is set, this will contain the world model rotation.		*'''worldModelRotationX,Y,Z:''' If worldModelID is set, this will contain the world model rotation.
	*'''worldLODModelID:''' If worldModelID is set, this will contain the LOD model ID if applicable.		*'''worldLODModelID:''' If worldModelID is set, this will contain the LOD model ID if applicable.
	*'''uvX, uvY:''' If bIncludeExtraMateriaInfo is set, it contains the UV positions of the hit entity.		*'''uvX, uvY:''' If bIncludeExtraMateriaInfo is set, it contains the texture UV positions of the triangle of the hit entity.
	*'''textureName:''' ~~If bIncludeExtraMateriaInfo is set~~, it contains the texture name ~~of the hit entity position~~.		*'''textureName:''' Same as above, but contains the texture name.
	*'''frameName:''' ~~If bIncludeExtraMateriaInfo is set~~, it contains frame name of ~~the hit entity position.~~		*'''frameName:''' Same as above, but contains the frame name. (This, for example in case of cars this is (but not limited to) a [[Vehicle Components]])
	*'''~~extraHitX~~, ~~extraHitY~~, ~~extraHitZ~~:''' ~~If bIncludeExtraMateriaInfo is set~~, it contains more precise ~~"clump hit" position.~~		*'''modelHitX, modelHitY, modelHitZ:''' Same as above, but contains the exact position hit on the model itself (It is much more precise than the `hitX, hitY, hitZ` returned above, as those are only processed against the much more simpler collision mesh, while these are obtained from processing the visual mesh itself (the DFF))

	==Examples==		==Examples==

FileEX: textureHitInfo parameter

2024-06-08T15:44:30Z

textureHitInfo parameter

← Older revision		Revision as of 15:44, 8 June 2024
Line 24:		Line 24:
	float float float -- worldModelRotationX,Y,Z		float float float -- worldModelRotationX,Y,Z
	int -- worldLODModelID		int -- worldLODModelID
			float float -- uvX, uvY
			string -- textureName,
			string -- frameName,
			float float float -- extraHitX, extraHitY, extraHitZ
	processLineOfSight ( float startX, float startY, float startZ,		processLineOfSight ( float startX, float startY, float startZ,
	float endX, float endY, float endZ,		float endX, float endY, float endZ,
Line 36:		Line 40:
	element ignoredElement = nil,		element ignoredElement = nil,
	bool includeWorldModelInformation = false,		bool includeWorldModelInformation = false,
	bool bIncludeCarTyres ] )		bool bIncludeCarTyres = false,
			bool bIncludeExtraMateriaInfo = false ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 60:		Line 65:
	*'''includeWorldModelInformation :''' Include the results of hitting a world model.		*'''includeWorldModelInformation :''' Include the results of hitting a world model.
	*'''bIncludeCarTyres :''' Includes car tyre hits.		*'''bIncludeCarTyres :''' Includes car tyre hits.
			{{New feature/item\|3.161\|1.6.0\|22173\|
			*'''bIncludeExtraMateriaInfo:''' Include the material info like UV coords, textureName, frameName and precision clump hit position.
			}}

	===Returns===		===Returns===
Line 78:		Line 86:
	*'''worldModelRotationX,Y,Z:''' If worldModelID is set, this will contain the world model rotation.		*'''worldModelRotationX,Y,Z:''' If worldModelID is set, this will contain the world model rotation.
	*'''worldLODModelID:''' If worldModelID is set, this will contain the LOD model ID if applicable.		*'''worldLODModelID:''' If worldModelID is set, this will contain the LOD model ID if applicable.
			*'''uvX, uvY:''' If bIncludeExtraMateriaInfo is set, it contains the UV positions of the hit entity.
			*'''textureName:''' If bIncludeExtraMateriaInfo is set, it contains the texture name of the hit entity position.
			*'''frameName:''' If bIncludeExtraMateriaInfo is set, it contains frame name of the hit entity position.
			*'''extraHitX, extraHitY, extraHitZ:''' If bIncludeExtraMateriaInfo is set, it contains more precise "clump hit" position.

	==Examples==		==Examples==
Line 113:		Line 125:
	{{ChangelogItem\|1.3.0-9.04273\|''worldModelID'' return value fixed}}		{{ChangelogItem\|1.3.0-9.04273\|''worldModelID'' return value fixed}}
	{{ChangelogItem\|1.3.0-9.04405\|''lighting'' return value fixed}}		{{ChangelogItem\|1.3.0-9.04405\|''lighting'' return value fixed}}
			{{ChangelogItem\|1.6.0-9.22173\|''bIncludeExtraMateriaInfo '' argument added}}

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

Einheit-101: Updated wiki information regarding inverted seeThroughStuff and shootThroughStuff arguments and some other problems.

2020-06-27T14:44:26Z

Updated wiki information regarding inverted seeThroughStuff and shootThroughStuff arguments and some other problems.

Einheit-101 at 23:19, 9 June 2020

2020-06-09T23:19:21Z

← Older revision		Revision as of 23:19, 9 June 2020
Line 6:		Line 6:

	This function is useful for checking for collisions and for editor-style scripts. If you wish to find what element is positioned at a particular point on the screen, use this function combined with [[getWorldFromScreenPosition]]. If you wish to just know if something is hit, and don't care about what or where was hit, use [[isLineOfSightClear]].		This function is useful for checking for collisions and for editor-style scripts. If you wish to find what element is positioned at a particular point on the screen, use this function combined with [[getWorldFromScreenPosition]]. If you wish to just know if something is hit, and don't care about what or where was hit, use [[isLineOfSightClear]].

			{{Note\|Due to a bug, shootThroughStuff argument has no effect and this function will always behave as if shootThroughStuff is set to TRUE (It will always hit).}}
			{{Note\|Due to a bug, seeThroughStuff argument has no effect and this function will always behave as if seeThroughStuff is set to FALSE (It will never hit).}}

	==Syntax==		==Syntax==
Line 53:		Line 56:
	*'''seeThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences that you can shoot throug but still walk on them).		*'''seeThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences that you can shoot throug but still walk on them).
	*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)		*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)
	*'''shootThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects)~~. This argument has currently no effect due to a bug, that means this argument is always TRUE~~.		*'''shootThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects).
	*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.		*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.
	*'''includeWorldModelInformation :''' Include the results of hitting a world model.		*'''includeWorldModelInformation :''' Include the results of hitting a world model.

Einheit-101: Added information that shootThroughStuff argument has no effect and processLineOfSight will always collide with these collision materials, no matter what you specify.

2020-06-09T22:59:01Z

Added information that shootThroughStuff argument has no effect and processLineOfSight will always collide with these collision materials, no matter what you specify.

← Older revision		Revision as of 22:59, 9 June 2020
Line 53:		Line 53:
	*'''seeThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences that you can shoot throug but still walk on them).		*'''seeThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences that you can shoot throug but still walk on them).
	*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)		*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)
	*'''shootThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects).		*'''shootThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects). This argument has currently no effect due to a bug, that means this argument is always TRUE.
	*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.		*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.
	*'''includeWorldModelInformation :''' Include the results of hitting a world model.		*'''includeWorldModelInformation :''' Include the results of hitting a world model.

Einheit-101: shootThroughStuff has nothing to do with "shooting through", that flag is used by some riverbed / beach objects that cant be shot through. It is actually seeThroughStuff that controls what you can shoot and what not, it is used by some fences.

2020-06-09T22:10:05Z

shootThroughStuff has nothing to do with "shooting through", that flag is used by some riverbed / beach objects that cant be shot through. It is actually seeThroughStuff that controls what you can shoot and what not, it is used by some fences.

← Older revision		Revision as of 22:10, 9 June 2020
Line 51:		Line 51:
	*'''checkObjects:''' Allow the line of sight to be blocked by [[Object\|objects]].		*'''checkObjects:''' Allow the line of sight to be blocked by [[Object\|objects]].
	*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.		*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
	*'''seeThroughStuff:''' Allow the line of sight to be blocked by ~~objects~~ that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences).		*'''seeThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences that you can shoot throug but still walk on them).
	*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)		*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)
	*'''shootThroughStuff:''' Allow the line of sight to be blocked by ~~objects~~ that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects).		*'''shootThroughStuff:''' Allow the line of sight to be blocked by collision materials that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects).
	*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.		*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.
	*'''includeWorldModelInformation :''' Include the results of hitting a world model.		*'''includeWorldModelInformation :''' Include the results of hitting a world model.

Einheit-101 at 22:03, 9 June 2020

2020-06-09T22:03:41Z

← Older revision		Revision as of 22:03, 9 June 2020
Line 51:		Line 51:
	*'''checkObjects:''' Allow the line of sight to be blocked by [[Object\|objects]].		*'''checkObjects:''' Allow the line of sight to be blocked by [[Object\|objects]].
	*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.		*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
	*'''seeThroughStuff:''' Allow the line of sight to be blocked by ~~translucent game~~ objects, ~~e.g. glass~~.		*'''seeThroughStuff:''' Allow the line of sight to be blocked by objects that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences).
	*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)		*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)
	*'''shootThroughStuff:''' Allow the line of sight to be blocked by ~~things~~ that ~~can be shot through~~		*'''shootThroughStuff:''' Allow the line of sight to be blocked by objects that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects).
	*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.		*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.
	*'''includeWorldModelInformation :''' Include the results of hitting a world model.		*'''includeWorldModelInformation :''' Include the results of hitting a world model.

AlexTMjugador: Undo revision 42888 by LuXorioN (talk) - The syntax was separated for easier reference, because this function returns a lot of variables

2014-11-18T17:51:27Z

Undo revision 42888 by LuXorioN (talk) - The syntax was separated for easier reference, because this function returns a lot of variables

@@ Line 10: / Line 10: @@
 Return values labelled for ease of reference.
 <syntaxhighlight lang="lua">
-bool float float float element float float float int float int int float float float float float float int processLineOfSight ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings = true, bool checkVehicles = true, bool checkPlayers = true, bool checkObjects = true, bool checkDummies = true, bool seeThroughStuff = false, bool ignoreSomeObjectsForCamera = false, bool shootThroughStuff = false, element ignoredElement = nil, bool includeWorldModelInformation = false, bool bIncludeCarTyres ] )
+bool               -- hit
 </syntaxhighlight>

← Older revision		Revision as of 14:44, 27 June 2020
Line 7:		Line 7:
	This function is useful for checking for collisions and for editor-style scripts. If you wish to find what element is positioned at a particular point on the screen, use this function combined with [[getWorldFromScreenPosition]]. If you wish to just know if something is hit, and don't care about what or where was hit, use [[isLineOfSightClear]].		This function is useful for checking for collisions and for editor-style scripts. If you wish to find what element is positioned at a particular point on the screen, use this function combined with [[getWorldFromScreenPosition]]. If you wish to just know if something is hit, and don't care about what or where was hit, use [[isLineOfSightClear]].

	{{Note\|Due to a bug, shootThroughStuff argument ~~has no effect and this function will always behave as if shootThroughStuff is set to TRUE (It will always hit).~~}}		{{Note\|Due to a bug, shootThroughStuff argument does currently check for seeThroughStuff!}}
	{{Note\|Due to a bug, seeThroughStuff argument has no effect and ~~this function~~ will always behave as if ~~seeThroughStuff~~ is set to FALSE (It will never hit).}}		{{Note\|Due to a bug, seeThroughStuff argument has no effect. It mistakenly checks for "shootThrough" surfaces and will always behave as if the argument is set to FALSE (It will never hit).}}

	==Syntax==		==Syntax==
Line 54:		Line 54:
	*'''checkObjects:''' Allow the line of sight to be blocked by [[Object\|objects]].		*'''checkObjects:''' Allow the line of sight to be blocked by [[Object\|objects]].
	*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.		*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
	*'''seeThroughStuff:''' Allow the line of sight ~~to be blocked by~~ collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences that you can shoot throug but still walk on them).		*'''seeThroughStuff:''' Allow the line of sight '''pass through''' collision materials that have this flag enabled (By default material IDs 52, 55 and 66 which are some fences that you can shoot throug but still walk on them).
	*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to pass through objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)		*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to '''pass through''' objects that have (K) property enabled in "object.dat" data file. (i.e. Most dynamic objects like boxes or barrels)
	*'''shootThroughStuff:''' Allow the line of sight to ~~be blocked by~~ collision materials that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects).		*'''shootThroughStuff:''' Allow the line of sight to '''pass through''' collision materials that have this flag enabled (By default material IDs 28, 29, 31, 32, 33, 74, 75, 76, 77, 78, 79, 96, 97, 98, 99, 100 which are exclusively sand / beach or underwater objects).
	*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.		*'''ignoredElement:''' Allow the line of sight to '''pass through''' a certain specified element. This is usually set to the object you are tracing from so it does not interfere with the results.
	*'''includeWorldModelInformation :''' Include the results of hitting a world model.		*'''includeWorldModelInformation :''' Include the results of hitting a world model.
	*'''bIncludeCarTyres :''' Includes car tyre hits.		*'''bIncludeCarTyres :''' Includes car tyre hits.