IsLineOfSightClear
Jump to navigation
Jump to search
|
This article needs checking. |
Reason(s): Needs verifying default values for all optional args and explaining the meaning of some of them (checkDummies, seeThroughStuff, ignoreSomeObjectsForCamera). --jbeta 17:51, 12 August 2007 (CDT) |
This function checks if there are obstacles between two points of the game world, optionally ignoring certain kinds of elements.
Syntax
bool isLineOfSightClear ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings, bool checkVehicles, bool checkPeds, bool checkObjects, bool checkDummies, bool seeThroughStuff, bool ignoreSomeObjectsForCamera, element ignoredElement ] )
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 X coordinate.
- endZ: The second point's world X 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: A boolean denoting whether to check buildings or ignore them.
- checkVehicles: A boolean denoting whether to check vehicles or ignore them.
- checkPeds: A boolean denoting whether to check peds or ignore them.
- checkObjects: A boolean denoting whether to check objects or ignore them.
- checkDummies: A boolean denoting whether to check dummies or ignore them.
- seeThroughStuff: A boolean denoting whether to check see-through objects or ignore them.
- ignoreSomeObjectsForCamera: ?.
- ignoredElement: A physical element that is to be ignored during the test.
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
Example goes here
See Also
- createSWATRope
- getBirdsEnabled
- getCoronaReflectionsEnabled
- getGarageBoundingBox
- getGaragePosition
- getGarageSize
- getGroundPosition
- getInteriorFurnitureEnabled
- getNearClipDistance
- getPedsLODDistance
- getRoofPosition
- getScreenFromWorldPosition
- getVehiclesLODDistance
- getWorldFromScreenPosition
- isAmbientSoundEnabled
- isLineOfSightClear
- isWorldSoundEnabled
- processLineOfSight
- resetAmbientSounds
- resetBlurLevel
- resetColorFilter
- resetCoronaReflectionsEnabled
- resetNearClipDistance
- resetPedsLODDistance
- resetVehiclesLODDistance
- resetWorldSounds
- setAmbientSoundEnabled
- setBirdsEnabled
- setColorFilter
- setCoronaReflectionsEnabled
- setInteriorFurnitureEnabled
- setInteriorSoundsEnabled
- setNearClipDistance
- setPedsLODDistance
- setVehiclesLODDistance
- setWorldSoundEnabled
- testLineAgainstWater
- areTrafficLightsLocked
- getAircraftMaxHeight
- getAircraftMaxVelocity
- getCloudsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGravity
- getHeatHaze
- getInteriorSoundsEnabled
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getOcclusionsEnabled
- getRainLevel
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getWeather
- getWindVelocity
- getSkyGradient
- getPlayerBlurLevel
- getZoneName
- isGarageOpen
- removeWorldModel
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetWindVelocity
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxHeight
- setAircraftMaxVelocity
- setCloudsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorSoundsEnabled
- setMinuteDuration
- setMoonSize
- setOcclusionsEnabled
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightState
- setTrafficLightsLocked
- setWeather
- setWeatherBlended
- setWindVelocity
- setJetpackMaxHeight
- setPlayerBlurLevel