SetCameraGoggleEffect: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add noiseEnabled)
 
(7 intermediate revisions by 6 users not shown)
Line 9: Line 9:
{{OOP||Camera.setGoggleEffect|goggleEffect|getCameraGoggleEffect}}
{{OOP||Camera.setGoggleEffect|goggleEffect|getCameraGoggleEffect}}
===Required Arguments===
===Required Arguments===
*'''goggleEffect''': the goggle effect you wish to set
*'''goggleEffect:''' the goggle effect you wish to set
{{Camera goggle modes}}
{{Camera goggle modes}}
{{New feature/item|3.0155|1.5.5|14000|
{{New feature/item|3.0156|1.5.5|13999|
*'''noiseEffect''': whether or not there should be a fuzzy noise effect
*'''noiseEnabled:''' whether or not there should be a fuzzy noise effect
}}
}}
===Returns===
===Returns===
* ''true'' if the effect was set correctly.
* ''true'' if the effect was set correctly.
Line 21: Line 22:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function nightvision()
function nightvision()
   local effect = (getCameraGoggleEffect() == "normal" and "nightvision") or "normal"
   local effect = (getCameraGoggleEffect() == "normal") and "nightvision" or "normal"
   setCameraGoggleEffect(effect)
   setCameraGoggleEffect(effect)
end
end
addCommandHandler("nightvision", nightvision)
addCommandHandler("nightvision", nightvision)
</syntaxhighlight>
</syntaxhighlight>
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-9.13999|Added noiseEnabled argument}}


==See Also==
==See Also==
{{Client camera functions}}
{{Client camera functions}}
[[hu:setCameraGoggleEffect]]
[[RO:setCameraGoggleEffect]]

Latest revision as of 15:24, 2 November 2023

This function allows you to set the camera's current goggle effect. This means you can activate nightvision or infrared effects by script

Syntax

bool setCameraGoggleEffect ( string goggleEffect [, bool noiseEnabled = true ] )

OOP Syntax Help! I don't understand this!

Method: Camera.setGoggleEffect(...)
Variable: .goggleEffect
Counterpart: getCameraGoggleEffect


Required Arguments

  • goggleEffect: the goggle effect you wish to set
  • normal: No camera goggle effect
  • nightvision: Nightvision camera
  • thermalvision: Infrared camera
  • noiseEnabled: whether or not there should be a fuzzy noise effect

Returns

  • true if the effect was set correctly.
  • false otherwise.

Example

function nightvision()
   local effect = (getCameraGoggleEffect() == "normal") and "nightvision" or "normal"
   setCameraGoggleEffect(effect)
end
addCommandHandler("nightvision", nightvision)

Changelog

Version Description
1.5.5-9.13999 Added noiseEnabled argument

See Also