SetSoundPosition: Difference between revisions

Revision as of 20:49, 26 December 2008

This function is used to change the seek position of the specified sound element.

bool setSoundPosition ( element theSound, int pos )

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 true if the sound element's seek position was successfully changed, false otherwise.

TODO

Click to collapse [-]

Client

--TODO

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Sets custom sound seek position.
+This function is used to change the seek position of the specified [[sound]] element.
 ==Syntax==
-<syntaxhighlight lang="lua">bool setSoundPosition ( element sound, int pos )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, int pos )</syntaxhighlight>
 ===Required Arguments===
-*'''sound:''' the element of the sound you want to play.
+*'''theSound:''' The [[sound]] element which seek position you want to modify.
-*'''pos:''' An integet number representing the position you wish to seek to.
+*'''pos:''' An [[int]]eger value representing the new seek position of the sound in milliseconds.
 ===Returns===
-Returns ''true'' if the sound position was successfully moved, ''false'' otherwise.
+Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.
 ==Example==