CreateSearchLight: Difference between revisions
Jump to navigation
Jump to search
(Documented the function introduced in r7675) |
m (Added Template:OptionalArg) |
||
Line 20: | Line 20: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | |||
*'''renderSpot''': if ''true'', the searchlight will lighten the surface where it ends. | *'''renderSpot''': if ''true'', the searchlight will lighten the surface where it ends. | ||
Revision as of 17:52, 8 December 2015
This function creates a searchlight. A searchlight a spotlight which looks like the one available in the Police Maverick.
Syntax
searchlight createSearchLight ( float startX, float startY, float startZ, float endX, float endY, float endZ, float startRadius, float endRadius [, bool renderSpot = true ] )
OOP Syntax Help! I don't understand this!
- Method: SearchLight.create(...)
Required Arguments
- startX: the X coordinate where the searchlight light cone will start.
- startY: the Y coordinate where the searchlight light cone will start.
- startZ: the Z coordinate where the searchlight light cone will start.
- endX: the X coordinate of the direction where the searchlight will point to.
- endY: the Y coordinate of the direction where the searchlight will point to.
- endZ: the Z coordinate of the direction where the searchlight will point to.
- startRadius: the radius of the searchlight's light cone in its beginning.
- endRadius: the radius of the searchlight's light cone in its end.
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.
- renderSpot: if true, the searchlight will lighten the surface where it ends.
Returns
If every argument is correct, this function returns a searchlight element. Otherwise, it returns false.
Example
-- TODO
See also
- areTrafficLightsLocked
- createSWATRope
- getAircraftMaxHeight
- getAircraftMaxVelocity
- getBirdsEnabled
- getCloudsEnabled
- getCoronaReflectionsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGarageBoundingBox
- getGaragePosition
- getGarageSize
- getGravity
- getGroundPosition
- getHeatHaze
- getInteriorFurnitureEnabled
- getInteriorSoundsEnabled
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getNearClipDistance
- getOcclusionsEnabled
- getPedsLODDistance
- getPlayerBlurLevel
- getRainLevel
- getRoofPosition
- getScreenFromWorldPosition
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getVehiclesLODDistance
- getWeather
- getWindVelocity
- getWorldFromScreenPosition
- getZoneName
- isAmbientSoundEnabled
- isGarageOpen
- isLineOfSightClear
- isWorldSoundEnabled
- isWorldSpecialPropertyEnabled
- processLineOfSight
- removeWorldModel
- resetAmbientSounds
- resetBlurLevel
- resetColorFilter
- resetCoronaReflectionsEnabled
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetNearClipDistance
- resetPedsLODDistance
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetVehiclesLODDistance
- resetWindVelocity
- resetWorldSounds
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxHeight
- setAircraftMaxVelocity
- setAmbientSoundEnabled
- setBirdsEnabled
- setCloudsEnabled
- setColorFilter
- setCoronaReflectionsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorFurnitureEnabled
- setInteriorSoundsEnabled
- setJetpackMaxHeight
- setMinuteDuration
- setMoonSize
- setNearClipDistance
- setOcclusionsEnabled
- setPedsLODDistance
- setPlayerBlurLevel
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightsLocked
- setTrafficLightState
- setVehiclesLODDistance
- setWeather
- setWeatherBlended
- setWindVelocity
- setWorldSoundEnabled
- setWorldSpecialPropertyEnabled
- testLineAgainstWater