getLightInfo: Difference between revisions
Killzone Kid (talk | contribs) (Created page with "{{RV|type=command |game1= arma3 |version1= 2.22 |gr1= Object Manipulation |descr= Returns various properties for the given lightpoint or lightreflector. ConePars and VolumeShapePars are exclusive properties of lightreflector only. |s1= getLightInfo light |p1= light: Object - lightpoint or lightreflector |r1= Array in format [Intensity, DiffuseColor, AmbientColor, DayLight, IR, UseFlare, FlareSize, FlareMaxDistance, AttenuationPars, AttachedToPars, ConeP...") |
Killzone Kid (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
|gr1= Object Manipulation | |gr1= Object Manipulation | ||
|descr= Returns various properties for the given lightpoint or lightreflector. ConePars and VolumeShapePars are exclusive properties of lightreflector only. | |descr= Returns various properties for the given {{hl|#lightpoint}} or {{hl|#lightreflector}}. ConePars and VolumeShapePars are exclusive properties of {{hl|#lightreflector}} only. | ||
|s1= [[getLightInfo]] light | |s1= [[getLightInfo]] light | ||
|p1= light: [[Object]] - lightpoint or lightreflector | |p1= light: [[Object]] - {{hl|#lightpoint}} or {{hl|#lightreflector}} | ||
|r1= [[Array]] in format [Intensity, DiffuseColor, AmbientColor, DayLight, IR, UseFlare, FlareSize, FlareMaxDistance, AttenuationPars, AttachedToPars, ConePars, VolumeShapePars], where: | |r1= [[Array]] in format [Intensity, DiffuseColor, AmbientColor, DayLight, IR, UseFlare, FlareSize, FlareMaxDistance, AttenuationPars, AttachedToPars, ConePars, VolumeShapePars], where: | ||
| Line 29: | Line 29: | ||
|s2= light [[getLightInfo]] index | |s2= light [[getLightInfo]] index | ||
|p21= light: [[Object]] - lightpoint or lightreflector | |p21= light: [[Object]] - {{hl|#lightpoint}} or {{hl|#lightreflector}} | ||
|p22= index: [[Number]] - property index (see main syntax, for example 0 for lightIntensity) | |p22= index: [[Number]] - property index (see main syntax, for example 0 for lightIntensity) | ||
Revision as of 23:54, 5 November 2025
Description
- Description:
- Returns various properties for the given #lightpoint or #lightreflector. ConePars and VolumeShapePars are exclusive properties of #lightreflector only.
- Groups:
- Object Manipulation
Syntax
- Syntax:
- getLightInfo light
- Parameters:
- light: Object - #lightpoint or #lightreflector
- Return Value:
- Array in format [Intensity, DiffuseColor, AmbientColor, DayLight, IR, UseFlare, FlareSize, FlareMaxDistance, AttenuationPars, AttachedToPars, ConePars, VolumeShapePars], where:
- 0 - Intensity: Number - getter for setLightIntensity (setLightBrightness also sets intensity in a weird way, but it is also obsolete)
- 1 - DiffuseColor: Color - getter for setLightColor
- 2 - AmbientColor: Color - getter for setLightAmbient
- 3 - DayLight: Boolean - getter for setLightDayLight
- 4 - IR: Boolean - getter for setLightIR
- 5 - UseFlare: Boolean - getter for setLightUseFlare
- 6 - FlareSize: Number - getter for setLightFlareSize
- 7 - FlareMaxDistance: Number - getter for setLightFlareMaxDistance
- 8 - AttenuationPars: Array - getter for setLightAttenuation
- 9 - AttachedToPars: Array - getter for lightAttachObject, lightDetachObject
- 10 - ConePars: Array - getter for setLightConePars
- 11 - VolumeShapePars: Array - getter for setLightConePars
Alternative Syntax
- Syntax:
- light getLightInfo index
- Parameters:
- light: Object - #lightpoint or #lightreflector
- index: Number - property index (see main syntax, for example 0 for lightIntensity)
- Return Value:
- Anything - depends on the requested property, or Nothing
Examples
- Example 1:
- Example 2:
Additional Information
- See also:
- setLightIntensity setLightColor setLightAmbient setLightDayLight setLightIR setLightUseFlare setLightFlareSize setLightFlareMaxDistance setLightAttenuation lightAttachObject lightDetachObject setLightConePars getUnitFreefallInfo setLightConePars getEntityInfo getModelInfo
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note