GetEasingValue - Revision history

Myonlake at 17:44, 25 August 2019

2019-08-25T17:44:02Z

← Older revision		Revision as of 17:44, 25 August 2019
Line 6:		Line 6:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">float getEasingValue( float fProgress, string strEasingType [, float fEasingPeriod, float fEasingAmplitude, float fEasingOvershoot] )</syntaxhighlight>		<syntaxhighlight lang="lua">float getEasingValue ( float fProgress, string strEasingType [, float fEasingPeriod, float fEasingAmplitude, float fEasingOvershoot ] )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Rain Gloom: fixed some grammar mistakes

2014-08-31T13:40:54Z

fixed some grammar mistakes

← Older revision		Revision as of 13:40, 31 August 2014
Line 21:		Line 21:

	== Example ==		== Example ==
	The ~~example~~ below is only clientside ~~examples~~ even though the ~~function~~ can be used on both sides. Indeed it makes more sense to use it with onClientRender/onClientPreRender but the freedom is given to use it in any other context.		The examples below are only clientside ones, even though the functions can be used on both sides. Indeed it makes more sense to use them with onClientRender/onClientPreRender but the freedom is given to use it in any other context.
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	This clientside example uses getEasingValue to make a custom camera fade.		This clientside example uses getEasingValue to make a custom camera fade.

Kernell: "Lua" is right, but not "LUA"! http://www.lua.org/about.html

2014-02-19T15:09:38Z

"Lua" is right, but not "LUA"! http://www.lua.org/about.html

← Older revision		Revision as of 15:09, 19 February 2014
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}

	Used for custom ~~LUA~~ based interpolation, returns the easing value (animation time to use in your custom interpolation) given a progress and an [[Easing\|easing function]].		Used for custom Lua based interpolation, returns the easing value (animation time to use in your custom interpolation) given a progress and an [[Easing\|easing function]].
	In most cases, either [[moveObject]] or [[interpolateBetween]] can do the job. getEasingValue is only provided in case you want to do your own custom interpolation based on easing.		In most cases, either [[moveObject]] or [[interpolateBetween]] can do the job. getEasingValue is only provided in case you want to do your own custom interpolation based on easing.

X86dev at 12:07, 17 December 2010

2010-12-17T12:07:47Z

← Older revision		Revision as of 12:07, 17 December 2010
Line 6:		Line 6:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">~~fAnimationTime =~~ getEasingValue( fProgress, strEasingType [, fEasingPeriod, fEasingAmplitude, fEasingOvershoot] )</syntaxhighlight>		<syntaxhighlight lang="lua">float getEasingValue( float fProgress, string strEasingType [, float fEasingPeriod, float fEasingAmplitude, float fEasingOvershoot] )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Kayl 712: /* Example */

2010-12-17T10:18:38Z

Example

← Older revision		Revision as of 10:18, 17 December 2010
Line 26:		Line 26:
	The command to test it is "/fade".		The command to test it is "/fade".
	The fading out is done with "InQuad" to have a slow fading which then accelerates and "OutQuad" is used for fading in to have a smooth end of the fading.		The fading out is done with "InQuad" to have a slow fading which then accelerates and "OutQuad" is used for fading in to have a smooth end of the fading.
	In this example [[interpolateBetween]] could have been used directly to interpolate the alpha between 0 and 255 and then 255 and 0 but is example is just to illustrate of the use of getEasingValue by itself.		In this example [[interpolateBetween]] could have been used directly to interpolate the alpha between 0 and 255 and then 255 and 0 but is example is just to illustrate the use of getEasingValue by itself.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local g_Fade = nil		local g_Fade = nil

Kayl 712: /* Example */

2010-12-17T10:17:04Z

Example

← Older revision		Revision as of 10:17, 17 December 2010
Line 21:		Line 21:

	== Example ==		== Example ==
	The example below ~~isonly~~ clientside examples even though the function can be used on both sides. Indeed it makes more sense to use it with onClientRender/onClientPreRender but the freedom is given to use it in any other context.		The example below is only clientside examples even though the function can be used on both sides. Indeed it makes more sense to use it with onClientRender/onClientPreRender but the freedom is given to use it in any other context.
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	This ~~clienstide~~ example uses getEasingValue to make a custom camera fade.		This clientside example uses getEasingValue to make a custom camera fade.
	The command to test it is "/fade".		The command to test it is "/fade".
	The fading out is done with "InQuad" to have a slow fading which then accelerates and "OutQuad" is used for fading in to have a smooth end of the fading.		The fading out is done with "InQuad" to have a slow fading which then accelerates and "OutQuad" is used for fading in to have a smooth end of the fading.

Kayl 712: Created page with "NOTOC {{Server client function}} Used for custom LUA based interpolation, returns the easing value (animation time to use in your custom interpolation) given a progress and ..."

2010-12-17T10:15:13Z

Created page with "__NOTOC__ {{Server client function}} Used for custom LUA based interpolation, returns the easing value (animation time to use in your custom interpolation) given a progress and ..."

New page

__NOTOC__
{{Server client function}}

Used for custom LUA based interpolation, returns the easing value (animation time to use in your custom interpolation) given a progress and an [[Easing|easing function]].
In most cases, either [[moveObject]] or [[interpolateBetween]] can do the job. getEasingValue is only provided in case you want to do your own custom interpolation based on easing.

==Syntax==
<syntaxhighlight lang="lua">fAnimationTime = getEasingValue( fProgress, strEasingType [, fEasingPeriod, fEasingAmplitude, fEasingOvershoot] )</syntaxhighlight>

===Required Arguments===
*'''fProgress:''' float between 0 and 1 indicating the interpolation progress (0 at the beginning of the interpolation, 1 at the end).
*'''strEasingType:''' the [[Easing|easing function]] to use for the interpolation

===Optional Arguments===
*'''fEasingPeriod:''' the period of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingAmplitude:''' the amplitude of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingOvershoot:''' the overshoot of the [[Easing|easing function]] (only some easing functions use this parameter)

===Returns===
Returns ''fAnimationTime '' the animation time given by the easing function (can be < 0 or > 1 since some [[Easing|easing functions]] have overshoot or bounce/spring effects, ''false'' otherwise (error in parameters).

== Example ==
The example below isonly clientside examples even though the function can be used on both sides. Indeed it makes more sense to use it with onClientRender/onClientPreRender but the freedom is given to use it in any other context.
<section name="Client" class="client" show="true">
This clienstide example uses getEasingValue to make a custom camera fade.
The command to test it is "/fade".
The fading out is done with "InQuad" to have a slow fading which then accelerates and "OutQuad" is used for fading in to have a smooth end of the fading.
In this example [[interpolateBetween]] could have been used directly to interpolate the alpha between 0 and 255 and then 255 and 0 but is example is just to illustrate of the use of getEasingValue by itself.
<syntaxhighlight lang="lua">
local g_Fade = nil
addCommandHandler("fade",
function ()
if g_Fade then return end
g_Fade = {}
g_Fade.startTime = getTickCount()
g_Fade.endTime = g_Fade.startTime + 2000
g_Fade.easingFunction = "InQuad" --Slow at first and accelerating
addEventHandler("onClientRender", getRootElement(), fadeCameraOut)
end)

function fadeCameraOut()
local now = getTickCount()
local elapsedTime = now - g_Fade.startTime
local duration = g_Fade.endTime - g_Fade.startTime
local progress = elapsedTime / duration

local fAnimationTime = getEasingValue(progress, g_Fade.easingFunction)

local alpha = fAnimationTime*255
local width, height = guiGetScreenSize()
dxDrawRectangle(0, 0, width, height, tocolor(0, 0, 0, alpha), true)

if now > g_Fade.endTime then
removeEventHandler("onClientRender", getRootElement(), fadeCameraOut)
g_Fade.startTime = getTickCount()
g_Fade.endTime = g_Fade.startTime + 2000
g_Fade.easingFunction = "OutQuad" --Fast at first then decelerating
addEventHandler("onClientRender", getRootElement(), fadeCameraIn)
end
end

function fadeCameraIn()
local now = getTickCount()
local elapsedTime = now - g_Fade.startTime
local duration = g_Fade.endTime - g_Fade.startTime
local progress = elapsedTime / duration

local fAnimationTime = getEasingValue(progress, g_Fade.easingFunction)

local alpha = (1-fAnimationTime)*255
local width, height = guiGetScreenSize()
dxDrawRectangle(0, 0, width, height, tocolor(0, 0, 0, alpha), true)

if now > g_Fade.endTime then
removeEventHandler("onClientRender", getRootElement(), fadeCameraIn)
g_Fade = nil
end
end
</syntaxhighlight>
</section>

==See Also==
{{Utility functions}}

GetEasingValue - Revision history

Myonlake at 17:44, 25 August 2019

Rain Gloom: fixed some grammar mistakes

Kernell: "Lua" is right, but not "LUA"! http://www.lua.org/about.html

X86dev at 12:07, 17 December 2010

Kayl 712: /* Example */

Kayl 712: /* Example */

Kayl 712: Created page with "__NOTOC__ {{Server client function}} Used for custom LUA based interpolation, returns the easing value (animation time to use in your custom interpolation) given a progress and ..."

Kayl 712: Created page with "NOTOC {{Server client function}} Used for custom LUA based interpolation, returns the easing value (animation time to use in your custom interpolation) given a progress and ..."