Entity::getAnimCurrentTime: Difference between revisions

Latest revision as of 17:56, 1 May 2024

Returns a float value representing animation's current playtime with respect to its total playtime. This value increasing in a range from [0 to 1] and wrap back to 0 when it reach 1.

Example:
0.000000 - mark the starting of animation.
0.500000 - mark the midpoint of the animation.
1.000000 - mark the end of animation.

Syntax

entity.getAnimCurrentTime(animDict, animName);

Required Arguments

animDict: String
animName: String

Return value

float

Example

// Example of stopping animation at the end and prevent loop.

let player = mp.players.local;

setInterval(() => {
	if(player.getAnimCurrentTime(path, name) > 0.95){
		player.stopAnimTask(path, name, 3.0);
		clearInterval(this);
	}
}, 1);

@@ Line 9: / Line 9: @@
 ==Example==
 <syntaxhighlight lang="javascript">
-// todo
+// Example of stopping animation at the end and prevent loop.
+let player = mp.players.local;
+setInterval(() => {
+	if(player.getAnimCurrentTime(path, name) > 0.95){
+		player.stopAnimTask(path, name, 3.0);
+		clearInterval(this);
+	}
+}, 1);
 </syntaxhighlight>
 ==See also==
-{{Entity_function_c}}
+{{Entity_definition_c}}
 [[Category:Clientside API]]
 [[Category:TODO: Example]]