Streaming::requestAnimDict - Revision history

MrPancakers2 at 01:51, 25 April 2021

2021-04-25T01:51:50Z

← Older revision		Revision as of 01:51, 25 April 2021
Line 1:		Line 1:
	~~This function is required when using client-side animations, you should preload~~ the ~~anim~~ dictionary ~~before using it, otherwise the~~ animation ~~won't work~~.		__NOTOC__
			{{ClientsideJsFunction}}
			Requests and loads the animation dictionary required to play an animation.

			{{JSContainer\|
	==Syntax==		==Syntax==
	<~~syntaxhighlight lang="javascript"~~>mp.game.streaming.requestAnimDict(animDict);</~~syntaxhighlight~~>
			<pre>
			mp.game.streaming.requestAnimDict(animDict);
			</pre>

	=== Required Arguments ===		=== Required Arguments ===
	*'''animDict:''' String		*'''animDict:''' {{RageType\|String}}
	~~===Return value===~~
	*'''Undefined'''
	==Example==		==Example==
	~~The example below preloads an~~ animation ~~and applies it into~~ the ~~local player~~.		A function to load the animation dictionary used for the lucky wheel spin animations.
	<~~syntaxhighlight lang="javascript"~~>		{{ClientsideCode\|
	mp.game.~~streaming.requestAnimDict~~("~~random~~@~~shop_robbery~~");		<pre>
	mp.players.local.~~taskPlayAnim~~("~~random~~@~~shop_robbery~~", "~~robbery_action_f~~"~~, 8~~.0~~, 1~~.0~~, -1, 1, 1~~.~~0, false, false, false~~);		async function loadLuckyWheelAnimLib(){
	</~~syntaxhighlight~~>		if(mp.players.local.model === mp.game.joaat("mp_m_freemode_01")){
			animationLib = "anim_casino_a@amb@casino@games@lucky7wheel@male"
			} else if(mp.players.local.model === mp.game.joaat("mp_f_freemode_01")) {
			animationLib = "anim_casino_a@amb@casino@games@lucky7wheel@female"
			} else {
			return mp.gui.chat.push("You must be using a freemode character model");
			}

			mp.game.streaming.requestAnimDict(animationLib);

			for(let i = 0; mp.game.streaming.hasAnimDictLoaded(animationLib) === 0 && i < 15; i++){
			if(i === 14) return mp.game.graphics.notify('~r~Error loading Lucky Wheel spin animation.');
			mp.gui.chat.push("Loading wheel spin animation...");
			await mp.game.waitAsync(100);
			}

			mp.gui.chat.push("Anim loaded.")
			}
			</pre>
			}}
			}}

	==See also==		==See also==
	{{~~Streaming_s_function_c~~}}		{{Streaming_functions_c}}

	[[Category:Clientside API]]		[[Category:Clientside API]]
	[[Category:~~TODO: Example~~]]		[[Category:Client-side Function]]

TedJr: Adds example of preloading and playing animation.

2019-09-20T16:33:21Z

Adds example of preloading and playing animation.

← Older revision		Revision as of 16:33, 20 September 2019
Line 8:		Line 8:
	*'''Undefined'''		*'''Undefined'''
	==Example==		==Example==
			The example below preloads an animation and applies it into the local player.
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	~~// todo~~		mp.game.streaming.requestAnimDict("random@shop_robbery");
			mp.players.local.taskPlayAnim("random@shop_robbery", "robbery_action_f", 8.0, 1.0, -1, 1, 1.0, false, false, false);
	</syntaxhighlight>		</syntaxhighlight>

	==See also==		==See also==
	{{Streaming_s_function_c}}		{{Streaming_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	[[Category:TODO: Example]]		[[Category:TODO: Example]]

TedJr: Adds description about preloading animations

2019-09-20T15:15:06Z

Adds description about preloading animations

← Older revision		Revision as of 15:15, 20 September 2019
Line 1:		Line 1:
			This function is required when using client-side animations, you should preload the anim dictionary before using it, otherwise the animation won't work.

	==Syntax==		==Syntax==

Marty uploader: yay

2017-05-06T21:32:48Z

yay

← Older revision		Revision as of 21:32, 6 May 2017
Line 1:		Line 1:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">streaming.requestAnimDict(animDict);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.game.streaming.requestAnimDict(animDict);</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''animDict:''' String		*'''animDict:''' String
Line 8:		Line 8:
	==Example==		==Example==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	todo		// todo
	</syntaxhighlight>		</syntaxhighlight>
	==See also==		==See also==
	{{~~Streaming_function_c~~}}		{{Streaming_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	[[Category:TODO: Example]]		[[Category:TODO: Example]]

Marty uploader: yay

2017-05-06T20:52:08Z

yay

New page

==Syntax==
<syntaxhighlight lang="javascript">streaming.requestAnimDict(animDict);</syntaxhighlight>
=== Required Arguments ===
*'''animDict:''' String
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
todo
</syntaxhighlight>
==See also==
{{Streaming_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]