SetSoundPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 15: Line 15:
Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.
Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.


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


==Changelog==
==Changelog==

Revision as of 23:23, 1 June 2013

This function is used to change the seek position of the specified sound element. Use a player element to control a players voice with this function.

Syntax

bool setSoundPosition ( element theSound, int pos )

Required Arguments

  • theSound: The sound element which seek position you want to modify.
  • pos: An integer 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.

MOJRM-511 removed your code (:

Changelog

Version Description
1.3.2 Added player element for voice control

See Also