setLightVolumeShape: Difference between revisions

From Bohemia Interactive Community
m (Some wiki formatting)
mNo edit summary
 
(8 intermediate revisions by 4 users not shown)
Line 10: Line 10:
|eff= local
|eff= local


|descr= Sets the lightpoint (directional light {{ic|#lightreflector}})'s volume shape.
|descr= Sets the {{hl|#lightreflector}}'s volume shape. An empty shape will switch the light off.


|s1= lightReflector [[setLightVolumeShape]] [shapePath, scale]
|s1= lightReflector [[setLightVolumeShape]] [shapePath, scale]


|p1= lightReflector : [[Object]] - Object of class {{ic|#lightreflector}})
|p1= lightReflector : [[Object]] - object of class {{hl|#lightreflector}})


|p2= shapePath: [[String]]
|p2= shapePath: [[String]] - "" to turn the light off


|p3= scale: [[Array]] - [sizeX, sizeY, sizeZ]
|p3= scale: [[Array]] with [sizeX, sizeY, sizeZ]
{{Columns|3|
* sizeX: [[Number]]
* sizeY: [[Number]]
* sizeZ: [[Number]]
}}


|r1= [[Nothing]]
|r1= [[Nothing]]

Latest revision as of 04:22, 4 May 2026

Hover & click on the images for description

Description

Description:
Sets the #lightreflector's volume shape. An empty shape will switch the light off.
Groups:
Lights

Syntax

Syntax:
lightReflector setLightVolumeShape [shapePath, scale]
Parameters:
lightReflector : Object - object of class #lightreflector)
shapePath: String - "" to turn the light off
scale: Array with [sizeX, sizeY, sizeZ]
Return Value:
Nothing

Examples

Example 1:
_light setLightVolumeShape ["a3\data_f\VolumeLightFlashlight.p3d", [1, 1, 1]];

Additional Information

See also:
setLightColor setLightAmbient setLightBrightness lightAttachObject lightDetachObject setLightIntensity setLightAttenuation setLightUseFlare setLightFlareSize setLightFlareMaxDistance setLightDayLight setLightIR

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note