ShowCursor

2025-05-21T18:55:35Z

Eznemgergo:

__NOTOC__
{{Server client function}}
This function is used to show or hide a [[player]]'s cursor.
{{Note|Regardless of the cursor state you set using this function, the cursor will always be visible while the menu, the chatbox input line or the console are active, or if another resource has called this function.}}
{{Note| Be aware of that if showCursor enbaled by a resource you can't disabled it from a different ressource showCursor(false) will not works, in order to make it works, disable it from the original resource that enabled it or use export }}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool showCursor ( player thePlayer, bool show, [ bool toggleControls = true ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] you want to show or hide the cursor of.
*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the cursor.

===Optional Arguments===
{{OptionalArg}}
*'''toggleControls:''' A boolean value determining whether to disable controls whilst the cursor is showing. ''true'' implies controls are disabled, ''false'' implies controls remain enabled.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool showCursor ( bool show, [ bool toggleControls = true ] )
</syntaxhighlight>

===Required Arguments===
*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the cursor.

===Optional Arguments===
{{OptionalArg}}
*'''toggleControls:''' A boolean value determining whether to disable controls whilst the cursor is showing. ''true'' implies controls are disabled, ''false'' implies controls remain enabled.
</section>

===Returns===
Returns ''true'' if the player's cursor was shown or hidden successfully, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example shows the cursor for a player named "Dave", then outputs a message if it was shown successfully.
<syntaxhighlight lang="lua">
local thePlayer = getPlayerFromName ( "Noffy" ) -- get the player named Dave
if thePlayer then -- if we got him
showCursor ( thePlayer, true ) -- make his cursor show
if isCursorShowing ( thePlayer ) then -- did it show?
outputChatBox ( "Cursor is now showing for Dave." ) -- print a message to the chat box
end
end
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example shows the cursor all the time
<syntaxhighlight lang="lua">
showCursor ( true ) -- Shows cursor
showCursor ( false ) -- Doesnt Show Cursor
</syntaxhighlight>
</section>

==See Also==
{{Cursor_functions}}

[[hu:showCursor]]

SetSoundEffectParameter

2025-03-08T14:25:49Z

Eznemgergo: Clarified using method

__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==
NOTE: This function will only work if it's executed within a timer.
<syntaxhighlight lang="lua">
--An example via a timer
local mySound = playSound("discoSound.mp3", 0, 0, 10)
setSoundEffectEnabled(mySound, "echo", true)

setTimer(function()
setSoundEffectParameter(mySound, "echo", "wetDryMix", 80)
end, 1, 1)
</syntaxhighlight>

<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>

==See Also==
{{Client_audio_functions}}

Multi Theft Auto: Wiki - User contributions [en]

ShowCursor

SetSoundEffectParameter