IsLineOfSightClear: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isLineOfSightClear ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings = true, bool checkVehicles = true, bool checkPeds = true, bool checkObjects = true, bool checkDummies = true, bool seeThroughStuff = false, bool ignoreSomeObjectsForCamera = false, element ignoredElement = nil ] )
bool isLineOfSightClear ( float startX,  
                            float startY,  
                            float startZ,  
                            float endX,  
                            float endY,  
                            float endZ,  
                            [ bool checkBuildings = true,  
                            bool checkVehicles = true,  
                            bool checkPeds = true,  
                            bool checkObjects = true,  
                            bool checkDummies = true,  
                            bool seeThroughStuff = false,  
                            bool ignoreSomeObjectsForCamera = false,  
                            element ignoredElement = nil ] )
</syntaxhighlight>
</syntaxhighlight>



Revision as of 01:37, 6 June 2010

This function checks if there are obstacles between two points of the game world, optionally ignoring certain kinds of elements. Use processLineOfSight if you want more information about what the ray hits.

Syntax

bool isLineOfSightClear ( float startX, 
                             float startY, 
                             float startZ, 
                             float endX, 
                             float endY, 
                             float endZ, 
                             [ bool checkBuildings = true, 
                             bool checkVehicles = true, 
                             bool checkPeds = true, 
                             bool checkObjects = true, 
                             bool checkDummies = true, 
                             bool seeThroughStuff = false, 
                             bool ignoreSomeObjectsForCamera = false, 
                             element ignoredElement = nil ] )

Required Arguments

  • startX: The first point's world X coordinate.
  • startY: The first point's world Y coordinate.
  • startZ: The first point's world Z coordinate.
  • endX: The second point's world X coordinate.
  • endY: The second point's world Y coordinate.
  • endZ: The second point's world Z coordinate.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • checkBuildings: Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
  • checkVehicles: Allow the line of sight to be blocked by vehicles.
  • checkPeds: Allow the line of sight to be blocked by peds, i.e. players.
  • checkObjects: Allow the line of sight to be blocked by 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.
  • seeThroughStuff: Allow the line of sight to be blocked by translucent game objects, e.g. glass.
  • ignoreSomeObjectsForCamera: Allow the line of sight to be blocked by certain objects.
  • ignoredElement: Allow the line of sight to pass through a certain specified element.

Returns

Returns true if the line between the specified points is clear, false if there's an obstacle or if invalid parameters are passed.

Example

This page does not have an example

--add an example here

See Also