Multi Theft Auto: Wiki - User contributions [en]

SetCameraGoggleEffect

2023-11-02T15:24:55Z

SaintsTalles: /* Required Arguments */

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

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraGoggleEffect ( string goggleEffect [, bool noiseEnabled = true ] )
</syntaxhighlight>
{{OOP||Camera.setGoggleEffect|goggleEffect|getCameraGoggleEffect}}
===Required Arguments===
*'''goggleEffect:''' the goggle effect you wish to set
{{Camera goggle modes}}
{{New feature/item|3.0156|1.5.5|13999|
*'''noiseEnabled:''' whether or not there should be a fuzzy noise effect
}}

===Returns===
* ''true'' if the effect was set correctly.
* ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function nightvision()
local effect = (getCameraGoggleEffect() == "normal") and "nightvision" or "normal"
setCameraGoggleEffect(effect)
end
addCommandHandler("nightvision", nightvision)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-9.13999|Added noiseEnabled argument}}

==See Also==
{{Client camera functions}}

[[hu:setCameraGoggleEffect]]
[[RO:setCameraGoggleEffect]]

SetCameraGoggleEffect

2023-11-02T15:24:36Z

SaintsTalles: /* Required Arguments */

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

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraGoggleEffect ( string goggleEffect [, bool noiseEnabled = true ] )
</syntaxhighlight>
{{OOP||Camera.setGoggleEffect|goggleEffect|getCameraGoggleEffect}}
===Required Arguments===
*'''goggleEffect''': the goggle effect you wish to set
{{Camera goggle modes}}
{{New feature/item|3.0156|1.5.5|13999|
*'''noiseEnabled:''' whether or not there should be a fuzzy noise effect
}}

===Returns===
* ''true'' if the effect was set correctly.
* ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function nightvision()
local effect = (getCameraGoggleEffect() == "normal") and "nightvision" or "normal"
setCameraGoggleEffect(effect)
end
addCommandHandler("nightvision", nightvision)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-9.13999|Added noiseEnabled argument}}

==See Also==
{{Client camera functions}}

[[hu:setCameraGoggleEffect]]
[[RO:setCameraGoggleEffect]]

SetSoundEffectParameter

2023-11-01T22:45:55Z

SaintsTalles: /* Required Arguments */

__NOTOC__
{{Client function}}
{{Added feature/item|1.5.9|1.5.8|20914|This function sets the parameter of a [[sound]] effect.}}
{{Note|Using this function on a player voice sound element is not supported at this time.}}

==Syntax==
<syntaxhighlight lang="lua">bool setSoundEffectParameter ( element sound, string effectName, string effectParam, var paramValue )</syntaxhighlight>
{{OOP||[[sound]]:setEffectParameter}}
===Required Arguments===
*'''sound:''' The [[sound]] element.
*'''effectName:''' The name of the effect whose parameter you want to change:
{{Sound_Effects}}
*'''effectParam:''' The parameter [[#Effects Parameters|name]].
*'''paramValue:''' The parameter [[#Effects Parameters|value]].

===Returns===
Returns ''true'' if effect have been set successfully, ''false'' otherwise.

===Effects Parameters===
{{Sound_Effects_Parameters}}

==Example==
<syntaxhighlight lang="lua">
local sound = playSound3D ("music.mp3", 0, 0, 10)

setSoundEffectEnabled (sound, "echo", true)
setSoundEffectParameter (sound, "echo", "wetDryMix", 80)
setSoundEffectParameter (sound, "echo", "feedback", 30)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-9.20914|}}

==See Also==
{{Client_audio_functions}}

ProcessLineAgainstMesh

2023-10-31T16:52:10Z

SaintsTalles: /* Syntax */

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22219|Does a raycast against an element's renderable mesh model directly}}
Does a raycast against an element's renderable mesh model [not the collision model!].
The same functionality is already present in [[processLineOfSight]], but the latter is a little buggy due to the fact that the collision model is always simplified, and not exactly the same as the mesh, which leads to situations where no hit is detected, even though the visible mesh is hittable [or vice versa].
Also, when one is interested in a specific element the overhead is a lot smaller [as we can skip all the collision detection done by the before-mentioned function].

==Syntax==

Single line for convenience.
<syntaxhighlight lang="lua">
bool, float, float, string, string, float, float, float processLineAgainstMesh(element toTest, float startX, float startY, float startZ, float endX, float endY, float endZ)
</syntaxhighlight>

Return values labelled for ease of reference.
<syntaxhighlight lang="lua">
bool -- hit
float float -- texU, texV
string -- textureName
string -- frameName
float float float -- worldX, worldY, worldZ
processLineAgainstMesh(element toTest,
float startX, float startY, float startZ,
float endX, float endY, float endZ)
</syntaxhighlight>

===Required Arguments===
*'''toProcess:''' The element to process the line against
*'''startX, startY, startZ:''' The start [origin] of the line
*'''endX, endY, endZ:''' The end of the line

===Returns===
*'''hit:''' ''true'' if there is a collision with the given element's mesh, ''false'' otherwise [in which case all other values are nil]
*'''texU, texV:''' the U, V coordinates on the hit geometry's texture
*'''textureName:''' name of the hit geometry's texture
*'''frameName:''' hit frame's name
*'''worldX, worldY, worldZ:''' collision position in world space

==Requirements==
{{Requirements|n/a|1.6.0-9.22173|}}

==See Also==
{{Client world functions}}

StopObject

2023-10-31T12:08:10Z

SaintsTalles: /* Required Arguments */

__NOTOC__
{{Server client function}}
This will allow you to stop an object that is currently moving.

==Syntax==
<syntaxhighlight lang="lua">
bool stopObject ( object theObject )
</syntaxhighlight>
{{OOP||[[object]]:stop||}}
===Required Arguments===
*'''theObject:''' the [[object]] whose movement you wish to stop

===Returns===
* ''true'' if successful.
* ''false'' otherwise.

==Example==
This will allow you to toggle the random movement of a staircase object model using a ''randomObjectMovement'' function and stop it immediately with the stopObject command. This is achieved by using a "toggleobjectmove" command with a "on" or "off" parameter.
<syntaxhighlight lang="lua">
function objectMoveControl ( thePlayer, commandName, state )
-- On "toggleobjectmove" in console, activate this command, which also asks the player to define the value for the varible 'state'.
if state == "on" then
outputChatBox ( "Moving object randomly" )
mytimer = setTimer ( randomObjectMovement, 2250, 0 )
-- if the player types "on" for the state variable, turn on the timer, which triggers a function
-- called randomObjectMovement that moves the object whenever it is called (not included for
-- this example). The timer runs every 2 1/4 seconds for 0 times, which means it runs infinitely.
elseif state == "off" then
outputChatBox ( "Stopping object movement" )
killTimer ( mytimer )
stopObject ( myobject )
-- if the player typed "off" for state, stop the object movement immediately and kill the
-- randomObjectMovement timer
else
outputChatBox ( "must define object state as 'on' or 'off'" )
-- if the player typed something besides "on" or "off" for state, do nothing
end
end
addCommandHandler ( "toggleobjectmove", objectMoveControl )
</syntaxhighlight>

==See Also==
{{Object_functions}}

StopObject

2023-10-31T12:06:48Z

SaintsTalles: /* Syntax */

__NOTOC__
{{Server client function}}
This will allow you to stop an object that is currently moving.

==Syntax==
<syntaxhighlight lang="lua">
bool stopObject ( object theObject )
</syntaxhighlight>
{{OOP||[[object]]:stop||}}
===Required Arguments===
*'''theobject:''' the [[object]] whose movement you wish to stop

===Returns===
* ''true'' if successful.
* ''false'' otherwise.

==Example==
This will allow you to toggle the random movement of a staircase object model using a ''randomObjectMovement'' function and stop it immediately with the stopObject command. This is achieved by using a "toggleobjectmove" command with a "on" or "off" parameter.
<syntaxhighlight lang="lua">
function objectMoveControl ( thePlayer, commandName, state )
-- On "toggleobjectmove" in console, activate this command, which also asks the player to define the value for the varible 'state'.
if state == "on" then
outputChatBox ( "Moving object randomly" )
mytimer = setTimer ( randomObjectMovement, 2250, 0 )
-- if the player types "on" for the state variable, turn on the timer, which triggers a function
-- called randomObjectMovement that moves the object whenever it is called (not included for
-- this example). The timer runs every 2 1/4 seconds for 0 times, which means it runs infinitely.
elseif state == "off" then
outputChatBox ( "Stopping object movement" )
killTimer ( mytimer )
stopObject ( myobject )
-- if the player typed "off" for state, stop the object movement immediately and kill the
-- randomObjectMovement timer
else
outputChatBox ( "must define object state as 'on' or 'off'" )
-- if the player typed something besides "on" or "off" for state, do nothing
end
end
addCommandHandler ( "toggleobjectmove", objectMoveControl )
</syntaxhighlight>

==See Also==
{{Object_functions}}