Multi Theft Auto: Wiki - User contributions [en]

SetSoundPosition

2009-11-28T13:03:41Z

Cokacola: /* Example */

__NOTOC__
{{Client function}}
This function is used to change the seek position of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, int pos )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which seek position you want to modify.
*'''pos:''' An [[int]]eger value representing the new seek position of the sound in milliseconds.

===Returns===
Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.

==Example==
This example allows the player to set how many milliseconds into the song he wants it to play from
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function setSongPos(cmd, ms)
local ssp = setSoundPosition(theSound, ms)
if(ssp == true) then
local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
outputChatBox("Sound is now playing from: "..seconds.." Seconds!", getLocalPlayer())
else
outputChatBox("An error has occured. Please make shore there are atleast", getLocalPlayer())
local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
outputChatBox(seconds.." Seconds in this song!", getLocalPlayer())
end
end
addCommandHandler("skipsong", setSongPos)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

IsSoundPaused

2009-11-28T12:41:46Z

Cokacola: Added Example

__NOTOC__
{{Client function}}
This function is used to return the current pause state of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which pause state you want to return.

===Returns===
Returns ''true'' if the [[sound]] element is paused, ''false'' if unpaused or invalid arguments were passed.

==Example==
This example will check and see if the sound is paused or not, and tell the player.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function checkSongPause()
local pause = isSoundPaused(theSound)
if(pause == true) then
outputChatBox("The sound is paused!", getLocalPlayer())
else
outputChatBox("The sound is not paused!", getLocalPlayer())
end
end
addCommandHandler("checkpause", checkSongPause)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

SetSoundPaused

2009-11-28T12:37:08Z

Cokacola: Added Example

__NOTOC__
{{Client function}}
This function is used to either pause or unpause the playback of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundPaused ( element theSound, bool paused )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which you want to pause/unpause.
*'''paused:''' A [[boolean]] value representing whether the sound should be paused or not. To pause the sound, use ''true''.

===Returns===
Returns ''true'' if the [[sound]] element was successfully paused, ''false'' otherwise.

==Example==
This example will allow the user to toggle sounds from paused to playing, and from playing to paused
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3", true)
function togglePausedSound()
if(isSoundPaused(theSound)) then --sound is paused, un-pause it
setSoundPaused(theSound, false)
else --sound is not paused, pause it
setSoundPaused(theSound, true)
end
end
addCommandHandler("pausesound", togglePausedSound)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

OnTrailerAttach

2009-08-30T02:54:11Z

Cokacola: added example

__NOTOC__
{{Server event}}
This event is triggered when a trailer is attached to a truck.

==Parameters==
<syntaxhighlight lang="lua">
vehicle theTruck
</syntaxhighlight>

*'''theTruck''': The truck vehicle that got attached to this trailer

==Source==
The [[event system#Event source|source]] of this event is the trailer [[vehicle]] that the truck got attached to.


==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the trailer will detach from the truck again.

==Example==

This example removes a trailer from the truck it is attached to. Good if you do not want people attaching trailers to vehicles

<syntaxhighlight lang="lua">
function detachTrailer(theTruck)
detachTrailerFromVehicle(theTruck, source) --detach the newly attached trailer
end
addEventHandler("onTrailerDetach", getRootElement(), detachTrailer)
</syntaxhighlight>

{{See also/Server event|Vehicle events}}

[[Category:Needs Example]]