12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>DOTween</name>
- </assembly>
- <members>
- <member name="T:DG.Tweening.AutoPlay">
- <summary>
- Types of autoPlay behaviours
- </summary>
- </member>
- <member name="F:DG.Tweening.AutoPlay.None">
- <summary>No tween is automatically played</summary>
- </member>
- <member name="F:DG.Tweening.AutoPlay.AutoPlaySequences">
- <summary>Only Sequences are automatically played</summary>
- </member>
- <member name="F:DG.Tweening.AutoPlay.AutoPlayTweeners">
- <summary>Only Tweeners are automatically played</summary>
- </member>
- <member name="F:DG.Tweening.AutoPlay.All">
- <summary>All tweens are automatically played</summary>
- </member>
- <member name="T:DG.Tweening.AxisConstraint">
- <summary>
- What axis to constrain in case of Vector tweens
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.ABSSequentiable.onStart">
- <summary>Called the first time the tween is set in a playing state, after any eventual delay</summary>
- </member>
- <member name="T:DG.Tweening.Core.DOGetter`1">
- <summary>
- Used in place of <c>System.Func</c>, which is not available in mscorlib.
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.DOSetter`1">
- <summary>
- Used in place of <c>System.Action</c>.
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.Debugger">
- <summary>
- Public so it can be used by lose scripts related to DOTween (like DOTweenAnimation)
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.DOTweenComponent">
- <summary>
- Used to separate DOTween class from the MonoBehaviour instance (in order to use static constructors on DOTween).
- Contains all instance-based methods
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.DOTweenComponent.inspectorUpdater">
- <summary>Used internally inside Unity Editor, as a trick to update DOTween's inspector at every frame</summary>
- </member>
- <member name="M:DG.Tweening.Core.DOTweenComponent.SetCapacity(System.Int32,System.Int32)">
- <summary>
- Directly sets the current max capacity of Tweeners and Sequences
- (meaning how many Tweeners and Sequences can be running at the same time),
- so that DOTween doesn't need to automatically increase them in case the max is reached
- (which might lead to hiccups when that happens).
- Sequences capacity must be less or equal to Tweeners capacity
- (if you pass a low Tweener capacity it will be automatically increased to match the Sequence's).
- Beware: use this method only when there are no tweens running.
- </summary>
- <param name="tweenersCapacity">Max Tweeners capacity.
- Default: 200</param>
- <param name="sequencesCapacity">Max Sequences capacity.
- Default: 50</param>
- </member>
- <member name="T:DG.Tweening.Core.Easing.Bounce">
- <summary>
- This class contains a C# port of the easing equations created by Robert Penner (http://robertpenner.com/easing).
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.Easing.Bounce.EaseIn(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Easing equation function for a bounce (exponentially decaying parabolic bounce) easing in: accelerating from zero velocity.
- </summary>
- <param name="time">
- Current time (in frames or seconds).
- </param>
- <param name="duration">
- Expected easing duration (in frames or seconds).
- </param>
- <param name="unusedOvershootOrAmplitude">Unused: here to keep same delegate for all ease types.</param>
- <param name="unusedPeriod">Unused: here to keep same delegate for all ease types.</param>
- <returns>
- The eased value.
- </returns>
- </member>
- <member name="M:DG.Tweening.Core.Easing.Bounce.EaseOut(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Easing equation function for a bounce (exponentially decaying parabolic bounce) easing out: decelerating from zero velocity.
- </summary>
- <param name="time">
- Current time (in frames or seconds).
- </param>
- <param name="duration">
- Expected easing duration (in frames or seconds).
- </param>
- <param name="unusedOvershootOrAmplitude">Unused: here to keep same delegate for all ease types.</param>
- <param name="unusedPeriod">Unused: here to keep same delegate for all ease types.</param>
- <returns>
- The eased value.
- </returns>
- </member>
- <member name="M:DG.Tweening.Core.Easing.Bounce.EaseInOut(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Easing equation function for a bounce (exponentially decaying parabolic bounce) easing in/out: acceleration until halfway, then deceleration.
- </summary>
- <param name="time">
- Current time (in frames or seconds).
- </param>
- <param name="duration">
- Expected easing duration (in frames or seconds).
- </param>
- <param name="unusedOvershootOrAmplitude">Unused: here to keep same delegate for all ease types.</param>
- <param name="unusedPeriod">Unused: here to keep same delegate for all ease types.</param>
- <returns>
- The eased value.
- </returns>
- </member>
- <member name="M:DG.Tweening.Core.Easing.EaseManager.Evaluate(DG.Tweening.Tween,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Returns a value between 0 and 1 (inclusive) based on the elapsed time and ease selected
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.Easing.EaseManager.Evaluate(DG.Tweening.Ease,DG.Tweening.EaseFunction,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Returns a value between 0 and 1 (inclusive) based on the elapsed time and ease selected
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.Easing.EaseCurve">
- <summary>
- Used to interpret AnimationCurves as eases.
- Public so it can be used by external ease factories
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.Enums.NestedTweenFailureBehaviour">
- <summary>
- Behaviour in case a tween nested inside a Sequence fails and is captured by safe mode
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.NestedTweenFailureBehaviour.TryToPreserveSequence">
- <summary>If the Sequence contains other elements, kill the failed tween but preserve the rest</summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.NestedTweenFailureBehaviour.KillWholeSequence">
- <summary>Kill the whole Sequence</summary>
- </member>
- <member name="T:DG.Tweening.Core.Enums.SafeModeLogBehaviour">
- <summary>
- Log types thrown by errors captured and prevented by safe mode
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.SafeModeLogBehaviour.None">
- <summary>No logs. NOT RECOMMENDED</summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.SafeModeLogBehaviour.Normal">
- <summary>Throw a normal log</summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.SafeModeLogBehaviour.Warning">
- <summary>Throw a warning log (default)</summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.SafeModeLogBehaviour.Error">
- <summary>Throw an error log</summary>
- </member>
- <member name="T:DG.Tweening.Core.Enums.UpdateNotice">
- <summary>
- Additional notices passed to plugins when updating.
- Public so it can be used by custom plugins. Internally, only PathPlugin uses it
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.UpdateNotice.None">
- <summary>
- None
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.UpdateNotice.RewindStep">
- <summary>
- Lets the plugin know that we restarted or rewinded
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.Enums.RewindCallbackMode">
- <summary>
- OnRewind callback behaviour (can only be set via DOTween's Utility Panel)
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.RewindCallbackMode.FireIfPositionChanged">
- <summary>
- When calling Rewind or PlayBackwards/SmoothRewind, OnRewind callbacks will be fired only if the tween isn't already rewinded
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.RewindCallbackMode.FireAlwaysWithRewind">
- <summary>
- When calling Rewind, OnRewind callbacks will always be fired, even if the tween is already rewinded.
- When calling PlayBackwards/SmoothRewind instead, OnRewind callbacks will be fired only if the tween isn't already rewinded
- </summary>
- </member>
- <member name="F:DG.Tweening.Core.Enums.RewindCallbackMode.FireAlways">
- <summary>
- When calling Rewind or PlayBackwards/SmoothRewind, OnRewind callbacks will always be fired, even if the tween is already rewinded
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.Extensions">
- <summary>
- Public only so custom shortcuts can access some of these methods
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.Extensions.SetSpecialStartupMode``1(``0,DG.Tweening.Core.Enums.SpecialStartupMode)">
- <summary>
- INTERNAL: used by DO shortcuts and Modules to set special startup mode
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.Extensions.Blendable``3(DG.Tweening.Core.TweenerCore{``0,``1,``2})">
- <summary>
- INTERNAL: used by DO shortcuts and Modules to set the tween as blendable
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.Extensions.NoFrom``3(DG.Tweening.Core.TweenerCore{``0,``1,``2})">
- <summary>
- INTERNAL: used by DO shortcuts and Modules to prevent a tween from using a From setup even if passed
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.DOTweenExternalCommand">
- <summary>
- Used to dispatch commands that need to be captured externally, usually by Modules
- </summary>
- </member>
- <member name="T:DG.Tweening.Core.DOTweenUtils">
- <summary>
- Various utils
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.DOTweenUtils.Vector3FromAngle(System.Single,System.Single)">
- <summary>
- Returns a Vector3 with z = 0
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.DOTweenUtils.Angle2D(UnityEngine.Vector3,UnityEngine.Vector3)">
- <summary>
- Returns the 2D angle between two vectors
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.DOTweenUtils.GetPointOnCircle(UnityEngine.Vector2,System.Single,System.Single)">
- <summary>
- Returns a point on a circle with the given center and radius,
- using Unity's circle coordinates (0° points up and increases clockwise)
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.DOTweenUtils.Vector3AreApproximatelyEqual(UnityEngine.Vector3,UnityEngine.Vector3)">
- <summary>
- Uses approximate equality on each axis instead of Unity's Vector3 equality,
- because the latter fails (in some cases) when assigning a Vector3 to a transform.position and then checking it.
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.DOTweenUtils.GetLooseScriptType(System.String)">
- <summary>
- Looks for the type within all possible project assembly names
- </summary>
- </member>
- <member name="M:DG.Tweening.Core.TweenerCore`3.ChangeStartValue(`1,System.Single)">
- <summary>NO-GC METHOD: changes the start value of a tween and rewinds it (without pausing it).
- Has no effect with tweens that are inside Sequences</summary>
- <param name="newStartValue">The new start value</param>
- <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
- </member>
- <member name="M:DG.Tweening.Core.TweenerCore`3.ChangeEndValue(`1,System.Boolean)">
- <summary>NO-GC METHOD: changes the end value of a tween and rewinds it (without pausing it).
- Has no effect with tweens that are inside Sequences</summary>
- <param name="newEndValue">The new end value</param>
- <param name="snapStartValue">If TRUE the start value will become the current target's value, otherwise it will stay the same</param>
- </member>
- <member name="M:DG.Tweening.Core.TweenerCore`3.ChangeEndValue(`1,System.Single,System.Boolean)">
- <summary>NO-GC METHOD: changes the end value of a tween and rewinds it (without pausing it).
- Has no effect with tweens that are inside Sequences</summary>
- <param name="newEndValue">The new end value</param>
- <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
- <param name="snapStartValue">If TRUE the start value will become the current target's value, otherwise it will stay the same</param>
- </member>
- <member name="M:DG.Tweening.Core.TweenerCore`3.ChangeValues(`1,`1,System.Single)">
- <summary>NO-GC METHOD: changes the start and end value of a tween and rewinds it (without pausing it).
- Has no effect with tweens that are inside Sequences</summary>
- <param name="newStartValue">The new start value</param>
- <param name="newEndValue">The new end value</param>
- <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
- </member>
- <member name="T:DG.Tweening.Color2">
- <summary>
- Struct that stores two colors (used for LineRenderer tweens)
- </summary>
- </member>
- <member name="T:DG.Tweening.TweenCallback">
- <summary>
- Used for tween callbacks
- </summary>
- </member>
- <member name="T:DG.Tweening.TweenCallback`1">
- <summary>
- Used for tween callbacks
- </summary>
- </member>
- <member name="T:DG.Tweening.EaseFunction">
- <summary>
- Used for custom and animationCurve-based ease functions. Must return a value between 0 and 1.
- </summary>
- </member>
- <member name="T:DG.Tweening.CustomPlugins.PureQuaternionPlugin">
- <summary>
- Straight Quaternion plugin. Instead of using Vector3 values accepts Quaternion values directly.
- <para>Beware: doesn't work with LoopType.Incremental (neither directly nor if inside a LoopType.Incremental Sequence).</para>
- <para>To use it, call DOTween.To with the plugin parameter overload, passing it <c>PureQuaternionPlugin.Plug()</c> as first parameter
- (do not use any of the other public PureQuaternionPlugin methods):</para>
- <code>DOTween.To(PureQuaternionPlugin.Plug(), ()=> myQuaternionProperty, x=> myQuaternionProperty = x, myQuaternionEndValue, duration);</code>
- </summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.Plug">
- <summary>
- Plug this plugin inside a DOTween.To call.
- <para>Example:</para>
- <code>DOTween.To(PureQuaternionPlugin.Plug(), ()=> myQuaternionProperty, x=> myQuaternionProperty = x, myQuaternionEndValue, duration);</code>
- </summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.Reset(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions})">
- <summary>INTERNAL: do not use</summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.SetFrom(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions},System.Boolean)">
- <summary>INTERNAL: do not use</summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.SetFrom(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions},UnityEngine.Quaternion,System.Boolean,System.Boolean)">
- <summary>INTERNAL: do not use</summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.ConvertToStartValue(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions},UnityEngine.Quaternion)">
- <summary>INTERNAL: do not use</summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.SetRelativeEndValue(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions})">
- <summary>INTERNAL: do not use</summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.SetChangeValue(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions})">
- <summary>INTERNAL: do not use</summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.GetSpeedBasedDuration(DG.Tweening.Plugins.Options.NoOptions,System.Single,UnityEngine.Quaternion)">
- <summary>INTERNAL: do not use</summary>
- </member>
- <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.EvaluateAndApply(DG.Tweening.Plugins.Options.NoOptions,DG.Tweening.Tween,System.Boolean,DG.Tweening.Core.DOGetter{UnityEngine.Quaternion},DG.Tweening.Core.DOSetter{UnityEngine.Quaternion},System.Single,UnityEngine.Quaternion,UnityEngine.Quaternion,System.Single,System.Boolean,System.Int32,DG.Tweening.Core.Enums.UpdateNotice)">
- <summary>INTERNAL: do not use</summary>
- </member>
- <member name="T:DG.Tweening.DOCurve">
- <summary>
- Extra non-tweening-related curve methods
- </summary>
- </member>
- <member name="T:DG.Tweening.DOCurve.CubicBezier">
- <summary>
- Cubic bezier curve methods
- </summary>
- </member>
- <member name="M:DG.Tweening.DOCurve.CubicBezier.GetPointOnSegment(UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.Vector3,System.Single)">
- <summary>
- Calculates a point along the given Cubic Bezier segment-curve.<para/>
- </summary>
- <param name="startPoint">Segment start point</param>
- <param name="startControlPoint">Start point's control point/handle</param>
- <param name="endPoint">Segment end point</param>
- <param name="endControlPoint">End point's control point/handle</param>
- <param name="factor">0-1 percentage along which to retrieve point</param>
- </member>
- <member name="M:DG.Tweening.DOCurve.CubicBezier.GetSegmentPointCloud(UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.Vector3,System.Int32)">
- <summary>
- Returns an array containing a series of points along the given Cubic Bezier segment-curve.<para/>
- </summary>
- <param name="startPoint">Start point</param>
- <param name="startControlPoint">Start point's control point/handle</param>
- <param name="endPoint">End point</param>
- <param name="endControlPoint">End point's control point/handle</param>
- <param name="resolution">Cloud resolution (min: 2)</param>
- </member>
- <member name="M:DG.Tweening.DOCurve.CubicBezier.GetSegmentPointCloud(System.Collections.Generic.List{UnityEngine.Vector3},UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.Vector3,System.Int32)">
- <summary>
- Calculates a series of points along the given Cubic Bezier segment-curve and adds them to the given list.<para/>
- </summary>
- <param name="startPoint">Start point</param>
- <param name="startControlPoint">Start point's control point/handle</param>
- <param name="endPoint">End point</param>
- <param name="endControlPoint">End point's control point/handle</param>
- <param name="resolution">Cloud resolution (min: 2)</param>
- </member>
- <member name="T:DG.Tweening.DOTween">
- <summary>
- Main DOTween class. Contains static methods to create and control tweens in a generic way
- </summary>
- </member>
- <member name="F:DG.Tweening.DOTween.Version">
- <summary>DOTween's version</summary>
- </member>
- <member name="F:DG.Tweening.DOTween.useSafeMode">
- <summary>If TRUE (default) makes tweens slightly slower but safer, automatically taking care of a series of things
- (like targets becoming null while a tween is playing).
- <para>Default: TRUE</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.safeModeLogBehaviour">
- <summary>Log type when safe mode reports capturing an error and preventing it</summary>
- </member>
- <member name="F:DG.Tweening.DOTween.nestedTweenFailureBehaviour">
- <summary>Behaviour in case a tween nested inside a Sequence fails (and is caught by safe mode).
- <para>Default: NestedTweenFailureBehaviour.TryToPreserveSequence</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.showUnityEditorReport">
- <summary>If TRUE you will get a DOTween report when exiting play mode (only in the Editor).
- Useful to know how many max Tweeners and Sequences you reached and optimize your final project accordingly.
- Beware, this will slightly slow down your tweens while inside Unity Editor.
- <para>Default: FALSE</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.timeScale">
- <summary>Global DOTween global timeScale (default: 1).<para/>
- The final timeScale of a non-timeScaleIndependent tween is:<para/>
- <code>Unity's Time.timeScale * DOTween.timeScale * tween.timeScale</code><para/>
- while the final timeScale of a timeScaleIndependent tween is:<para/>
- <code>DOTween.unscaledTimeScale * DOTween.timeScale * tween.timeScale</code></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.unscaledTimeScale">
- <summary>DOTween timeScale applied only to timeScaleIndependent tweens (default: 1).<para/>
- The final timeScale of a timeScaleIndependent tween is:<para/>
- <code>DOTween.unscaledTimeScale * DOTween.timeScale * tween.timeScale</code></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.useSmoothDeltaTime">
- <summary>If TRUE, DOTween will use Time.smoothDeltaTime instead of Time.deltaTime for UpdateType.Normal and UpdateType.Late tweens
- (unless they're set as timeScaleIndependent, in which case a value between the last timestep
- and <see cref="F:DG.Tweening.DOTween.maxSmoothUnscaledTime"/> will be used instead).
- Setting this to TRUE will lead to smoother animations.
- <para>Default: FALSE</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.maxSmoothUnscaledTime">
- <summary>If <see cref="F:DG.Tweening.DOTween.useSmoothDeltaTime"/> is TRUE, this indicates the max timeStep that an independent update call can last.
- Setting this to TRUE will lead to smoother animations.
- <para>Default: FALSE</para></summary>
- </member>
- <member name="P:DG.Tweening.DOTween.logBehaviour">
- <summary>DOTween's log behaviour.
- <para>Default: LogBehaviour.ErrorsOnly</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.onWillLog">
- <summary>Used to intercept DOTween's logs. If this method isn't NULL, DOTween will call it before writing a log via Unity's own Debug log methods.<para/>
- Return TRUE if you want DOTween to proceed with the log, FALSE otherwise.<para/>
- This method must return a <code>bool</code> and accept two parameters:<para/>
- - <code>LogType</code>: the type of Unity log that DOTween is trying to log<para/>
- - <code>object</code>: the log message that DOTween wants to log</summary>
- </member>
- <member name="F:DG.Tweening.DOTween.drawGizmos">
- <summary>If TRUE draws path gizmos in Unity Editor (if the gizmos button is active).
- Deactivate this if you want to avoid gizmos overhead while in Unity Editor</summary>
- </member>
- <member name="F:DG.Tweening.DOTween.debugMode">
- <summary>If TRUE activates various debug options</summary>
- </member>
- <member name="P:DG.Tweening.DOTween.debugStoreTargetId">
- <summary>Stores the target id so it can be used to give more info in case of safeMode error capturing.
- Only active if both <code>debugMode</code> and <code>useSafeMode</code> are TRUE</summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultUpdateType">
- <summary>Default updateType for new tweens.
- <para>Default: UpdateType.Normal</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultTimeScaleIndependent">
- <summary>Sets whether Unity's timeScale should be taken into account by default or not.
- <para>Default: false</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultAutoPlay">
- <summary>Default autoPlay behaviour for new tweens.
- <para>Default: AutoPlay.All</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultAutoKill">
- <summary>Default autoKillOnComplete behaviour for new tweens.
- <para>Default: TRUE</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultLoopType">
- <summary>Default loopType applied to all new tweens.
- <para>Default: LoopType.Restart</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultRecyclable">
- <summary>If TRUE all newly created tweens are set as recyclable, otherwise not.
- <para>Default: FALSE</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultEaseType">
- <summary>Default ease applied to all new Tweeners (not to Sequences which always have Ease.Linear as default).
- <para>Default: Ease.InOutQuad</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultEaseOvershootOrAmplitude">
- <summary>Default overshoot/amplitude used for eases
- <para>Default: 1.70158f</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.defaultEasePeriod">
- <summary>Default period used for eases
- <para>Default: 0</para></summary>
- </member>
- <member name="F:DG.Tweening.DOTween.instance">
- <summary>Used internally. Assigned/removed by DOTweenComponent.Create/DestroyInstance</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Init(System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{DG.Tweening.LogBehaviour})">
- <summary>
- Must be called once, before the first ever DOTween call/reference,
- otherwise it will be called automatically and will use default options.
- Calling it a second time won't have any effect.
- <para>You can chain <code>SetCapacity</code> to this method, to directly set the max starting size of Tweeners and Sequences:</para>
- <code>DOTween.Init(false, false, LogBehaviour.Default).SetCapacity(100, 20);</code>
- </summary>
- <param name="recycleAllByDefault">If TRUE all new tweens will be set for recycling, meaning that when killed,
- instead of being destroyed, they will be put in a pool and reused instead of creating new tweens. This option allows you to avoid
- GC allocations by reusing tweens, but you will have to take care of tween references, since they might result active
- even if they were killed (since they might have been respawned and are now being used for other tweens).
- <para>If you want to automatically set your tween references to NULL when a tween is killed
- you can use the OnKill callback like this:</para>
- <code>.OnKill(()=> myTweenReference = null)</code>
- <para>You can change this setting at any time by changing the static <see cref="F:DG.Tweening.DOTween.defaultRecyclable"/> property,
- or you can set the recycling behaviour for each tween separately, using:</para>
- <para><code>SetRecyclable(bool recyclable)</code></para>
- <para>Default: FALSE</para></param>
- <param name="useSafeMode">If TRUE makes tweens slightly slower but safer, automatically taking care of a series of things
- (like targets becoming null while a tween is playing).
- You can change this setting at any time by changing the static <see cref="F:DG.Tweening.DOTween.useSafeMode"/> property.
- <para>Default: FALSE</para></param>
- <param name="logBehaviour">Type of logging to use.
- You can change this setting at any time by changing the static <see cref="P:DG.Tweening.DOTween.logBehaviour"/> property.
- <para>Default: ErrorsOnly</para></param>
- </member>
- <member name="M:DG.Tweening.DOTween.SetTweensCapacity(System.Int32,System.Int32)">
- <summary>
- Directly sets the current max capacity of Tweeners and Sequences
- (meaning how many Tweeners and Sequences can be running at the same time),
- so that DOTween doesn't need to automatically increase them in case the max is reached
- (which might lead to hiccups when that happens).
- Sequences capacity must be less or equal to Tweeners capacity
- (if you pass a low Tweener capacity it will be automatically increased to match the Sequence's).
- Beware: use this method only when there are no tweens running.
- </summary>
- <param name="tweenersCapacity">Max Tweeners capacity.
- Default: 200</param>
- <param name="sequencesCapacity">Max Sequences capacity.
- Default: 50</param>
- </member>
- <member name="M:DG.Tweening.DOTween.Clear(System.Boolean)">
- <summary>
- Kills all tweens, clears all cached tween pools and plugins and resets the max Tweeners/Sequences capacities to the default values.
- </summary>
- <param name="destroy">If TRUE also destroys DOTween's gameObject and resets its initializiation, default settings and everything else
- (so that next time you use it it will need to be re-initialized)</param>
- </member>
- <member name="M:DG.Tweening.DOTween.ClearCachedTweens">
- <summary>
- Clears all cached tween pools.
- </summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Validate">
- <summary>
- Checks all active tweens to find and remove eventually invalid ones (usually because their targets became NULL)
- and returns the total number of invalid tweens found and removed.
- IMPORTANT: this will cause an error on UWP platform, so don't use it there
- BEWARE: this is a slightly expensive operation so use it with care
- </summary>
- </member>
- <member name="M:DG.Tweening.DOTween.ManualUpdate(System.Single,System.Single)">
- <summary>
- Updates all tweens that are set to <see cref="F:DG.Tweening.UpdateType.Manual"/>.
- </summary>
- <param name="deltaTime">Manual deltaTime</param>
- <param name="unscaledDeltaTime">Unscaled delta time (used with tweens set as timeScaleIndependent)</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.Single},DG.Tweening.Core.DOSetter{System.Single},System.Single,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.Double},DG.Tweening.Core.DOSetter{System.Double},System.Double,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.Int32},DG.Tweening.Core.DOSetter{System.Int32},System.Int32,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.UInt32},DG.Tweening.Core.DOSetter{System.UInt32},System.UInt32,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.Int64},DG.Tweening.Core.DOSetter{System.Int64},System.Int64,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.UInt64},DG.Tweening.Core.DOSetter{System.UInt64},System.UInt64,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.String},DG.Tweening.Core.DOSetter{System.String},System.String,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Vector2},DG.Tweening.Core.DOSetter{UnityEngine.Vector2},UnityEngine.Vector2,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},UnityEngine.Vector3,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Vector4},DG.Tweening.Core.DOSetter{UnityEngine.Vector4},UnityEngine.Vector4,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Quaternion},DG.Tweening.Core.DOSetter{UnityEngine.Quaternion},UnityEngine.Vector3,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Color},DG.Tweening.Core.DOSetter{UnityEngine.Color},UnityEngine.Color,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Rect},DG.Tweening.Core.DOSetter{UnityEngine.Rect},UnityEngine.Rect,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.RectOffset},DG.Tweening.Core.DOSetter{UnityEngine.RectOffset},UnityEngine.RectOffset,System.Single)">
- <summary>Tweens a property or field to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To``3(DG.Tweening.Plugins.Core.ABSTweenPlugin{``0,``1,``2},DG.Tweening.Core.DOGetter{``0},DG.Tweening.Core.DOSetter{``0},``1,System.Single)">
- <summary>Tweens a property or field to the given value using a custom plugin</summary>
- <param name="plugin">The plugin to use. Each custom plugin implements a static <code>Get()</code> method
- you'll need to call to assign the correct plugin in the correct way, like this:
- <para><code>CustomPlugin.Get()</code></para></param>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.ToAxis(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},System.Single,System.Single,DG.Tweening.AxisConstraint)">
- <summary>Tweens only one axis of a Vector3 to the given value using default plugins.</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- <param name="axisConstraint">The axis to tween</param>
- </member>
- <member name="M:DG.Tweening.DOTween.ToAlpha(DG.Tweening.Core.DOGetter{UnityEngine.Color},DG.Tweening.Core.DOSetter{UnityEngine.Color},System.Single,System.Single)">
- <summary>Tweens only the alpha of a Color to the given value using default plugins</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
- </member>
- <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOSetter{System.Single},System.Single,System.Single,System.Single)">
- <summary>Tweens a virtual property from the given start to the given end value
- and implements a setter that allows to use that value with an external method or a lambda
- <para>Example:</para>
- <code>To(MyMethod, 0, 12, 0.5f);</code>
- <para>Where MyMethod is a function that accepts a float parameter (which will be the result of the virtual tween)</para></summary>
- <param name="setter">The action to perform with the tweened value</param>
- <param name="startValue">The value to start from</param>
- <param name="endValue">The end value to reach</param>
- <param name="duration">The duration of the virtual tween
- </param>
- </member>
- <member name="M:DG.Tweening.DOTween.Punch(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},UnityEngine.Vector3,System.Single,System.Int32,System.Single)">
- <summary>Punches a Vector3 towards the given direction and then back to the starting one
- as if it was connected to the starting position via an elastic.
- <para>This tween type generates some GC allocations at startup</para></summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="direction">The direction and strength of the punch</param>
- <param name="duration">The duration of the tween</param>
- <param name="vibrato">Indicates how much will the punch vibrate</param>
- <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting position when bouncing backwards.
- 1 creates a full oscillation between the direction and the opposite decaying direction,
- while 0 oscillates only between the starting position and the decaying direction</param>
- </member>
- <member name="M:DG.Tweening.DOTween.Shake(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},System.Single,System.Single,System.Int32,System.Single,System.Boolean,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Vector3 with the given values.</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction and behave like a random punch.</param>
- <param name="ignoreZAxis">If TRUE only shakes on the X Y axis (looks better with things like cameras).</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.DOTween.Shake(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Vector3 with the given values.</summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength on each axis</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction and behave like a random punch.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.DOTween.ToArray(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},UnityEngine.Vector3[],System.Single[])">
- <summary>Tweens a property or field to the given values using default plugins.
- Ease is applied between each segment and not as a whole.
- <para>This tween type generates some GC allocations at startup</para></summary>
- <param name="getter">A getter for the field or property to tween.
- <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
- <param name="setter">A setter for the field or property to tween
- <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
- <param name="endValues">The end values to reach for each segment. This array must have the same length as <code>durations</code></param>
- <param name="durations">The duration of each segment. This array must have the same length as <code>endValues</code></param>
- </member>
- <member name="M:DG.Tweening.DOTween.Sequence">
- <summary>
- Returns a new <see cref="T:DG.Tweening.Sequence"/> to be used for tween groups.<para/>
- Mind that Sequences don't have a target applied automatically like Tweener creation shortcuts,
- so if you want to be able to kill this Sequence when calling DOTween.Kill(target) you'll have to add
- the target manually; you can do that directly by using the <see cref="M:DG.Tweening.DOTween.Sequence(System.Object)"/> overload instead of this one
- </summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Sequence(System.Object)">
- <summary>
- Returns a new <see cref="T:DG.Tweening.Sequence"/> to be used for tween groups, and allows to set a target
- (because Sequences don't have their target set automatically like Tweener creation shortcuts).
- That way killing/controlling tweens by target will apply to this Sequence too.
- </summary>
- <param name="target">The target of the Sequence. Relevant only for static target-based methods like DOTween.Kill(target),
- useless otherwise</param>
- </member>
- <member name="M:DG.Tweening.DOTween.CompleteAll(System.Boolean)">
- <summary>Completes all tweens and returns the number of actual tweens completed
- (meaning tweens that don't have infinite loops and were not already complete)</summary>
- <param name="withCallbacks">For Sequences only: if TRUE also internal Sequence callbacks will be fired,
- otherwise they will be ignored</param>
- </member>
- <member name="M:DG.Tweening.DOTween.Complete(System.Object,System.Boolean)">
- <summary>Completes all tweens with the given ID or target and returns the number of actual tweens completed
- (meaning the tweens that don't have infinite loops and were not already complete)</summary>
- <param name="withCallbacks">For Sequences only: if TRUE internal Sequence callbacks will be fired,
- otherwise they will be ignored</param>
- </member>
- <member name="M:DG.Tweening.DOTween.FlipAll">
- <summary>Flips all tweens (changing their direction to forward if it was backwards and viceversa),
- then returns the number of actual tweens flipped</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Flip(System.Object)">
- <summary>Flips the tweens with the given ID or target (changing their direction to forward if it was backwards and viceversa),
- then returns the number of actual tweens flipped</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.GotoAll(System.Single,System.Boolean)">
- <summary>Sends all tweens to the given position (calculating also eventual loop cycles) and returns the actual tweens involved</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Goto(System.Object,System.Single,System.Boolean)">
- <summary>Sends all tweens with the given ID or target to the given position (calculating also eventual loop cycles)
- and returns the actual tweens involved</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.KillAll(System.Boolean)">
- <summary>Kills all tweens and returns the number of actual tweens killed</summary>
- <param name="complete">If TRUE completes the tweens before killing them</param>
- </member>
- <member name="M:DG.Tweening.DOTween.KillAll(System.Boolean,System.Object[])">
- <summary>Kills all tweens and returns the number of actual tweens killed</summary>
- <param name="complete">If TRUE completes the tweens before killing them</param>
- <param name="idsOrTargetsToExclude">Eventual IDs or targets to exclude from the killing</param>
- </member>
- <member name="M:DG.Tweening.DOTween.Kill(System.Object,System.Boolean)">
- <summary>Kills all tweens with the given ID or target and returns the number of actual tweens killed</summary>
- <param name="complete">If TRUE completes the tweens before killing them</param>
- </member>
- <member name="M:DG.Tweening.DOTween.Kill(System.Object,System.Object,System.Boolean)">
- <summary>Kills all tweens with the given target and the given ID, and returns the number of actual tweens killed</summary>
- <param name="complete">If TRUE completes the tweens before killing them</param>
- </member>
- <member name="M:DG.Tweening.DOTween.PauseAll">
- <summary>Pauses all tweens and returns the number of actual tweens paused</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Pause(System.Object)">
- <summary>Pauses all tweens with the given ID or target and returns the number of actual tweens paused
- (meaning the tweens that were actually playing and have been paused)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.PlayAll">
- <summary>Plays all tweens and returns the number of actual tweens played
- (meaning tweens that were not already playing or complete)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Play(System.Object)">
- <summary>Plays all tweens with the given ID or target and returns the number of actual tweens played
- (meaning the tweens that were not already playing or complete)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Play(System.Object,System.Object)">
- <summary>Plays all tweens with the given target and the given ID, and returns the number of actual tweens played
- (meaning the tweens that were not already playing or complete)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.PlayBackwardsAll">
- <summary>Plays backwards all tweens and returns the number of actual tweens played
- (meaning tweens that were not already started, playing backwards or rewinded)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.PlayBackwards(System.Object)">
- <summary>Plays backwards all tweens with the given ID or target and returns the number of actual tweens played
- (meaning the tweens that were not already started, playing backwards or rewinded)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.PlayBackwards(System.Object,System.Object)">
- <summary>Plays backwards all tweens with the given target and ID and returns the number of actual tweens played
- (meaning the tweens that were not already started, playing backwards or rewinded)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.PlayForwardAll">
- <summary>Plays forward all tweens and returns the number of actual tweens played
- (meaning tweens that were not already playing forward or complete)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.PlayForward(System.Object)">
- <summary>Plays forward all tweens with the given ID or target and returns the number of actual tweens played
- (meaning the tweens that were not already playing forward or complete)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.PlayForward(System.Object,System.Object)">
- <summary>Plays forward all tweens with the given target and ID and returns the number of actual tweens played
- (meaning the tweens that were not already started, playing backwards or rewinded)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.RestartAll(System.Boolean)">
- <summary>Restarts all tweens, then returns the number of actual tweens restarted</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Restart(System.Object,System.Boolean,System.Single)">
- <summary>Restarts all tweens with the given ID or target, then returns the number of actual tweens restarted</summary>
- <param name="includeDelay">If TRUE includes the eventual tweens delays, otherwise skips them</param>
- <param name="changeDelayTo">If >= 0 changes the startup delay of all involved tweens to this value, otherwise doesn't touch it</param>
- </member>
- <member name="M:DG.Tweening.DOTween.Restart(System.Object,System.Object,System.Boolean,System.Single)">
- <summary>Restarts all tweens with the given target and the given ID, and returns the number of actual tweens played
- (meaning the tweens that were not already playing or complete)</summary>
- <param name="includeDelay">If TRUE includes the eventual tweens delays, otherwise skips them</param>
- <param name="changeDelayTo">If >= 0 changes the startup delay of all involved tweens to this value, otherwise doesn't touch it</param>
- </member>
- <member name="M:DG.Tweening.DOTween.RewindAll(System.Boolean)">
- <summary>Rewinds and pauses all tweens, then returns the number of actual tweens rewinded
- (meaning tweens that were not already rewinded)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.Rewind(System.Object,System.Boolean)">
- <summary>Rewinds and pauses all tweens with the given ID or target, then returns the number of actual tweens rewinded
- (meaning the tweens that were not already rewinded)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.SmoothRewindAll">
- <summary>Smoothly rewinds all tweens (delays excluded), then returns the number of actual tweens rewinding/rewinded
- (meaning tweens that were not already rewinded).
- A "smooth rewind" animates the tween to its start position,
- skipping all elapsed loops (except in case of LoopType.Incremental) while keeping the animation fluent.
- <para>Note that a tween that was smoothly rewinded will have its play direction flipped</para></summary>
- </member>
- <member name="M:DG.Tweening.DOTween.SmoothRewind(System.Object)">
- <summary>Smoothly rewinds all tweens (delays excluded) with the given ID or target, then returns the number of actual tweens rewinding/rewinded
- (meaning the tweens that were not already rewinded).
- A "smooth rewind" animates the tween to its start position,
- skipping all elapsed loops (except in case of LoopType.Incremental) while keeping the animation fluent.
- <para>Note that a tween that was smoothly rewinded will have its play direction flipped</para></summary>
- </member>
- <member name="M:DG.Tweening.DOTween.TogglePauseAll">
- <summary>Toggles the play state of all tweens and returns the number of actual tweens toggled
- (meaning tweens that could be played or paused, depending on the toggle state)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.TogglePause(System.Object)">
- <summary>Toggles the play state of all tweens with the given ID or target and returns the number of actual tweens toggled
- (meaning the tweens that could be played or paused, depending on the toggle state)</summary>
- </member>
- <member name="M:DG.Tweening.DOTween.IsTweening(System.Object,System.Boolean)">
- <summary>
- Returns TRUE if a tween with the given ID or target is active.
- <para>You can also use this to know if a shortcut tween is active for a given target.</para>
- <para>Example:</para>
- <para><code>transform.DOMoveX(45, 1); // transform is automatically added as the tween target</code></para>
- <para><code>DOTween.IsTweening(transform); // Returns true</code></para>
- </summary>
- <param name="targetOrId">The target or ID to look for</param>
- <param name="alsoCheckIfIsPlaying">If FALSE (default) returns TRUE as long as a tween for the given target/ID is active,
- otherwise also requires it to be playing</param>
- </member>
- <member name="M:DG.Tweening.DOTween.TotalActiveTweens">
- <summary>
- Returns the total number of active tweens (so both Tweeners and Sequences).
- A tween is considered active if it wasn't killed, regardless if it's playing or paused
- </summary>
- </member>
- <member name="M:DG.Tweening.DOTween.TotalActiveTweeners">
- <summary>
- Returns the total number of active Tweeners.
- A Tweener is considered active if it wasn't killed, regardless if it's playing or paused
- </summary>
- </member>
- <member name="M:DG.Tweening.DOTween.TotalActiveSequences">
- <summary>
- Returns the total number of active Sequences.
- A Sequence is considered active if it wasn't killed, regardless if it's playing or paused
- </summary>
- </member>
- <member name="M:DG.Tweening.DOTween.TotalPlayingTweens">
- <summary>
- Returns the total number of active and playing tweens.
- A tween is considered as playing even if its delay is actually playing
- </summary>
- </member>
- <member name="M:DG.Tweening.DOTween.TotalTweensById(System.Object,System.Boolean)">
- <summary>
- Returns a the total number of active tweens with the given id.
- </summary>
- <param name="playingOnly">If TRUE returns only the tweens with the given ID that are currently playing</param>
- </member>
- <member name="M:DG.Tweening.DOTween.PlayingTweens(System.Collections.Generic.List{DG.Tweening.Tween})">
- <summary>
- Returns a list of all active tweens in a playing state.
- Returns NULL if there are no active playing tweens.
- <para>Beware: each time you call this method a new list is generated, so use it for debug only</para>
- </summary>
- <param name="fillableList">If NULL creates a new list, otherwise clears and fills this one (and thus saves allocations)</param>
- </member>
- <member name="M:DG.Tweening.DOTween.PausedTweens(System.Collections.Generic.List{DG.Tweening.Tween})">
- <summary>
- Returns a list of all active tweens in a paused state.
- Returns NULL if there are no active paused tweens.
- <para>Beware: each time you call this method a new list is generated, so use it for debug only</para>
- </summary>
- <param name="fillableList">If NULL creates a new list, otherwise clears and fills this one (and thus saves allocations)</param>
- </member>
- <member name="M:DG.Tweening.DOTween.TweensById(System.Object,System.Boolean,System.Collections.Generic.List{DG.Tweening.Tween})">
- <summary>
- Returns a list of all active tweens with the given id.
- Returns NULL if there are no active tweens with the given id.
- <para>Beware: each time you call this method a new list is generated</para>
- </summary>
- <param name="playingOnly">If TRUE returns only the tweens with the given ID that are currently playing</param>
- <param name="fillableList">If NULL creates a new list, otherwise clears and fills this one (and thus saves allocations)</param>
- </member>
- <member name="M:DG.Tweening.DOTween.TweensByTarget(System.Object,System.Boolean,System.Collections.Generic.List{DG.Tweening.Tween})">
- <summary>
- Returns a list of all active tweens with the given target.
- Returns NULL if there are no active tweens with the given target.
- <para>Beware: each time you call this method a new list is generated</para>
- <param name="playingOnly">If TRUE returns only the tweens with the given target that are currently playing</param>
- <param name="fillableList">If NULL creates a new list, otherwise clears and fills this one (and thus saves allocations)</param>
- </summary>
- </member>
- <member name="T:DG.Tweening.DOVirtual">
- <summary>
- Creates virtual tweens that can be used to change other elements via their OnUpdate calls
- </summary>
- </member>
- <member name="M:DG.Tweening.DOVirtual.Float(System.Single,System.Single,System.Single,DG.Tweening.TweenCallback{System.Single})">
- <summary>
- Tweens a virtual float.
- You can add regular settings to the generated tween,
- but do not use <code>OnUpdate</code> or you will overwrite the onVirtualUpdate parameter
- </summary>
- <param name="from">The value to start from</param>
- <param name="to">The value to tween to</param>
- <param name="duration">The duration of the tween</param>
- <param name="onVirtualUpdate">A callback which must accept a parameter of type float, called at each update</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.Int(System.Int32,System.Int32,System.Single,DG.Tweening.TweenCallback{System.Int32})">
- <summary>
- Tweens a virtual int.
- You can add regular settings to the generated tween,
- but do not use <code>OnUpdate</code> or you will overwrite the onVirtualUpdate parameter
- </summary>
- <param name="from">The value to start from</param>
- <param name="to">The value to tween to</param>
- <param name="duration">The duration of the tween</param>
- <param name="onVirtualUpdate">A callback which must accept a parameter of type int, called at each update</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.Vector2(UnityEngine.Vector2,UnityEngine.Vector2,System.Single,DG.Tweening.TweenCallback{UnityEngine.Vector2})">
- <summary>
- Tweens a virtual Vector2.
- You can add regular settings to the generated tween,
- but do not use <code>OnUpdate</code> or you will overwrite the onVirtualUpdate parameter
- </summary>
- <param name="from">The value to start from</param>
- <param name="to">The value to tween to</param>
- <param name="duration">The duration of the tween</param>
- <param name="onVirtualUpdate">A callback which must accept a parameter of type Vector3, called at each update</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.Vector3(UnityEngine.Vector3,UnityEngine.Vector3,System.Single,DG.Tweening.TweenCallback{UnityEngine.Vector3})">
- <summary>
- Tweens a virtual Vector3.
- You can add regular settings to the generated tween,
- but do not use <code>OnUpdate</code> or you will overwrite the onVirtualUpdate parameter
- </summary>
- <param name="from">The value to start from</param>
- <param name="to">The value to tween to</param>
- <param name="duration">The duration of the tween</param>
- <param name="onVirtualUpdate">A callback which must accept a parameter of type Vector3, called at each update</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.Color(UnityEngine.Color,UnityEngine.Color,System.Single,DG.Tweening.TweenCallback{UnityEngine.Color})">
- <summary>
- Tweens a virtual Color.
- You can add regular settings to the generated tween,
- but do not use <code>OnUpdate</code> or you will overwrite the onVirtualUpdate parameter
- </summary>
- <param name="from">The value to start from</param>
- <param name="to">The value to tween to</param>
- <param name="duration">The duration of the tween</param>
- <param name="onVirtualUpdate">A callback which must accept a parameter of type Color, called at each update</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.EasedValue(System.Single,System.Single,System.Single,DG.Tweening.Ease)">
- <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
- <param name="from">The value to start from when lifetimePercentage is 0</param>
- <param name="to">The value to reach when lifetimePercentage is 1</param>
- <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
- <param name="easeType">The type of ease</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.EasedValue(System.Single,System.Single,System.Single,DG.Tweening.Ease,System.Single)">
- <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
- <param name="from">The value to start from when lifetimePercentage is 0</param>
- <param name="to">The value to reach when lifetimePercentage is 1</param>
- <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
- <param name="easeType">The type of ease</param>
- <param name="overshoot">Eventual overshoot to use with Back ease</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.EasedValue(System.Single,System.Single,System.Single,DG.Tweening.Ease,System.Single,System.Single)">
- <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
- <param name="from">The value to start from when lifetimePercentage is 0</param>
- <param name="to">The value to reach when lifetimePercentage is 1</param>
- <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
- <param name="easeType">The type of ease</param>
- <param name="amplitude">Eventual amplitude to use with Elastic easeType</param>
- <param name="period">Eventual period to use with Elastic easeType</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.EasedValue(System.Single,System.Single,System.Single,UnityEngine.AnimationCurve)">
- <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
- <param name="from">The value to start from when lifetimePercentage is 0</param>
- <param name="to">The value to reach when lifetimePercentage is 1</param>
- <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
- <param name="easeCurve">The AnimationCurve to use for ease</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.EasedValue(UnityEngine.Vector3,UnityEngine.Vector3,System.Single,DG.Tweening.Ease)">
- <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
- <param name="from">The value to start from when lifetimePercentage is 0</param>
- <param name="to">The value to reach when lifetimePercentage is 1</param>
- <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
- <param name="easeType">The type of ease</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.EasedValue(UnityEngine.Vector3,UnityEngine.Vector3,System.Single,DG.Tweening.Ease,System.Single)">
- <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
- <param name="from">The value to start from when lifetimePercentage is 0</param>
- <param name="to">The value to reach when lifetimePercentage is 1</param>
- <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
- <param name="easeType">The type of ease</param>
- <param name="overshoot">Eventual overshoot to use with Back ease</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.EasedValue(UnityEngine.Vector3,UnityEngine.Vector3,System.Single,DG.Tweening.Ease,System.Single,System.Single)">
- <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
- <param name="from">The value to start from when lifetimePercentage is 0</param>
- <param name="to">The value to reach when lifetimePercentage is 1</param>
- <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
- <param name="easeType">The type of ease</param>
- <param name="amplitude">Eventual amplitude to use with Elastic easeType</param>
- <param name="period">Eventual period to use with Elastic easeType</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.EasedValue(UnityEngine.Vector3,UnityEngine.Vector3,System.Single,UnityEngine.AnimationCurve)">
- <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
- <param name="from">The value to start from when lifetimePercentage is 0</param>
- <param name="to">The value to reach when lifetimePercentage is 1</param>
- <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
- <param name="easeCurve">The AnimationCurve to use for ease</param>
- </member>
- <member name="M:DG.Tweening.DOVirtual.DelayedCall(System.Single,DG.Tweening.TweenCallback,System.Boolean)">
- <summary>Fires the given callback after the given time.</summary>
- <param name="delay">Callback delay</param>
- <param name="callback">Callback to fire when the delay has expired</param>
- <param name="ignoreTimeScale">If TRUE (default) ignores Unity's timeScale</param>
- </member>
- <member name="F:DG.Tweening.Ease.INTERNAL_Zero">
- <summary>
- Don't assign this! It's assigned automatically when creating 0 duration tweens
- </summary>
- </member>
- <member name="F:DG.Tweening.Ease.INTERNAL_Custom">
- <summary>
- Don't assign this! It's assigned automatically when setting the ease to an AnimationCurve or to a custom ease function
- </summary>
- </member>
- <member name="T:DG.Tweening.EaseFactory">
- <summary>
- Allows to wrap ease method in special ways, adding extra features
- </summary>
- </member>
- <member name="M:DG.Tweening.EaseFactory.StopMotion(System.Int32,System.Nullable{DG.Tweening.Ease})">
- <summary>
- Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS
- </summary>
- <param name="motionFps">FPS at which the tween should be played</param>
- <param name="ease">Ease type</param>
- </member>
- <member name="M:DG.Tweening.EaseFactory.StopMotion(System.Int32,UnityEngine.AnimationCurve)">
- <summary>
- Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS
- </summary>
- <param name="motionFps">FPS at which the tween should be played</param>
- <param name="animCurve">AnimationCurve to use for the ease</param>
- </member>
- <member name="M:DG.Tweening.EaseFactory.StopMotion(System.Int32,DG.Tweening.EaseFunction)">
- <summary>
- Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS
- </summary>
- <param name="motionFps">FPS at which the tween should be played</param>
- <param name="customEase">Custom ease function to use</param>
- </member>
- <member name="T:DG.Tweening.IDOTweenInit">
- <summary>
- Used to allow method chaining with DOTween.Init
- </summary>
- </member>
- <member name="M:DG.Tweening.IDOTweenInit.SetCapacity(System.Int32,System.Int32)">
- <summary>
- Directly sets the current max capacity of Tweeners and Sequences
- (meaning how many Tweeners and Sequences can be running at the same time),
- so that DOTween doesn't need to automatically increase them in case the max is reached
- (which might lead to hiccups when that happens).
- Sequences capacity must be less or equal to Tweeners capacity
- (if you pass a low Tweener capacity it will be automatically increased to match the Sequence's).
- Beware: use this method only when there are no tweens running.
- </summary>
- <param name="tweenersCapacity">Max Tweeners capacity.
- Default: 200</param>
- <param name="sequencesCapacity">Max Sequences capacity.
- Default: 50</param>
- </member>
- <member name="T:DG.Tweening.LinkBehaviour">
- <summary>
- Behaviour that can be assigned when chaining a SetLink to a tween
- </summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.PauseOnDisable">
- <summary>Pauses the tween when the link target is disabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.PauseOnDisablePlayOnEnable">
- <summary>Pauses the tween when the link target is disabled, plays it when it's enabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.PauseOnDisableRestartOnEnable">
- <summary>Pauses the tween when the link target is disabled, restarts it when it's enabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.PlayOnEnable">
- <summary>Plays the tween when the link target is enabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.RestartOnEnable">
- <summary>Restarts the tween when the link target is enabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.KillOnDisable">
- <summary>Kills the tween when the link target is disabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.KillOnDestroy">
- <summary>Kills the tween when the link target is destroyed (becomes NULL). This is always active even if another behaviour is chosen</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.CompleteOnDisable">
- <summary>Completes the tween when the link target is disabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.CompleteAndKillOnDisable">
- <summary>Completes and kills the tween when the link target is disabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.RewindOnDisable">
- <summary>Rewinds the tween (delay excluded) when the link target is disabled</summary>
- </member>
- <member name="F:DG.Tweening.LinkBehaviour.RewindAndKillOnDisable">
- <summary>Rewinds and kills the tween when the link target is disabled</summary>
- </member>
- <member name="T:DG.Tweening.PathMode">
- <summary>
- Path mode (used to determine correct LookAt orientation)
- </summary>
- </member>
- <member name="F:DG.Tweening.PathMode.Ignore">
- <summary>Ignores the path mode (and thus LookAt behaviour)</summary>
- </member>
- <member name="F:DG.Tweening.PathMode.Full3D">
- <summary>Regular 3D path</summary>
- </member>
- <member name="F:DG.Tweening.PathMode.TopDown2D">
- <summary>2D top-down path</summary>
- </member>
- <member name="F:DG.Tweening.PathMode.Sidescroller2D">
- <summary>2D side-scroller path</summary>
- </member>
- <member name="T:DG.Tweening.PathType">
- <summary>
- Type of path to use with DOPath tweens
- </summary>
- </member>
- <member name="F:DG.Tweening.PathType.Linear">
- <summary>Linear, composed of straight segments between each waypoint</summary>
- </member>
- <member name="F:DG.Tweening.PathType.CatmullRom">
- <summary>Curved path (which uses Catmull-Rom curves)</summary>
- </member>
- <member name="F:DG.Tweening.PathType.CubicBezier">
- <summary><code>EXPERIMENTAL: </code>Curved path (which uses Cubic Bezier curves, where each point requires two extra control points)</summary>
- </member>
- <member name="T:DG.Tweening.Plugins.CirclePlugin">
- <summary>
- Tweens a Vector2 along a circle.
- EndValue represents the center of the circle, start and end value degrees are inside options
- ChangeValue x is changeValue°, y is unused
- </summary>
- </member>
- <member name="T:DG.Tweening.Plugins.Core.PathCore.ControlPoint">
- <summary>
- Path control point
- </summary>
- </member>
- <member name="F:DG.Tweening.Plugins.Core.PathCore.Path.wps">
- <summary>
- Path waypoints (modified by PathPlugin when setting relative end/change value or by CubicBezierDecoder) and by DOTweenPathInspector
- </summary>
- </member>
- <member name="P:DG.Tweening.Plugins.Core.PathCore.Path.minInputWaypoints">
- <summary>
- Minimum input points necessary to create the path (doesn't correspond to actual waypoints required)
- </summary>
- </member>
- <member name="M:DG.Tweening.Plugins.Core.PathCore.Path.GetPoint(System.Single,System.Boolean)">
- <summary>
- Gets the point on the path at the given percentage (0 to 1)
- </summary>
- <param name="perc">The percentage (0 to 1) at which to get the point</param>
- <param name="convertToConstantPerc">If TRUE constant speed is taken into account, otherwise not</param>
- </member>
- <member name="T:DG.Tweening.Plugins.Options.IPlugOptions">
- <summary>
- Base interface for all tween plugins options
- </summary>
- </member>
- <member name="M:DG.Tweening.Plugins.Options.IPlugOptions.Reset">
- <summary>Resets the plugin</summary>
- </member>
- <member name="T:DG.Tweening.Plugins.Vector3ArrayPlugin">
- <summary>
- This plugin generates some GC allocations at startup
- </summary>
- </member>
- <member name="T:DG.Tweening.Plugins.PathPlugin">
- <summary>
- Path plugin works exclusively with Transforms
- </summary>
- </member>
- <member name="T:DG.Tweening.RotateMode">
- <summary>
- Rotation mode used with DORotate methods
- </summary>
- </member>
- <member name="F:DG.Tweening.RotateMode.Fast">
- <summary>
- Fastest way that never rotates beyond 360°
- </summary>
- </member>
- <member name="F:DG.Tweening.RotateMode.FastBeyond360">
- <summary>
- Fastest way that rotates beyond 360°
- </summary>
- </member>
- <member name="F:DG.Tweening.RotateMode.WorldAxisAdd">
- <summary>
- Adds the given rotation to the transform using world axis and an advanced precision mode
- (like when using transform.Rotate(Space.World)).
- <para>In this mode the end value is is always considered relative</para>
- </summary>
- </member>
- <member name="F:DG.Tweening.RotateMode.LocalAxisAdd">
- <summary>
- Adds the given rotation to the transform's local axis
- (like when rotating an object with the "local" switch enabled in Unity's editor or using transform.Rotate(Space.Self)).
- <para>In this mode the end value is is always considered relative</para>
- </summary>
- </member>
- <member name="T:DG.Tweening.ScrambleMode">
- <summary>
- Type of scramble to apply to string tweens
- </summary>
- </member>
- <member name="F:DG.Tweening.ScrambleMode.None">
- <summary>
- No scrambling of characters
- </summary>
- </member>
- <member name="F:DG.Tweening.ScrambleMode.All">
- <summary>
- A-Z + a-z + 0-9 characters
- </summary>
- </member>
- <member name="F:DG.Tweening.ScrambleMode.Uppercase">
- <summary>
- A-Z characters
- </summary>
- </member>
- <member name="F:DG.Tweening.ScrambleMode.Lowercase">
- <summary>
- a-z characters
- </summary>
- </member>
- <member name="F:DG.Tweening.ScrambleMode.Numerals">
- <summary>
- 0-9 characters
- </summary>
- </member>
- <member name="F:DG.Tweening.ScrambleMode.Custom">
- <summary>
- Custom characters
- </summary>
- </member>
- <member name="T:DG.Tweening.ShakeRandomnessMode">
- <summary>
- Type of randomness to apply to a shake tween
- </summary>
- </member>
- <member name="F:DG.Tweening.ShakeRandomnessMode.Full">
- <summary>Default, full randomness</summary>
- </member>
- <member name="F:DG.Tweening.ShakeRandomnessMode.Harmonic">
- <summary>Creates a more balanced randomness that looks more harmonic</summary>
- </member>
- <member name="T:DG.Tweening.TweenExtensions">
- <summary>
- Methods that extend Tween objects and allow to control or get data from them
- </summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Complete(DG.Tweening.Tween)">
- <summary>Completes the tween</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Complete(DG.Tweening.Tween,System.Boolean)">
- <summary>Completes the tween</summary>
- <param name="withCallbacks">For Sequences only: if TRUE also internal Sequence callbacks will be fired,
- otherwise they will be ignored</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Done``1(``0)">
- <summary>Optional: indicates that the tween creation has ended, to be used (optionally) as the last element of tween chaining creation.<br/>
- This method won't do anything except in case of 0-duration tweens,
- where it will complete them immediately instead of waiting for the next internal update routine
- (unless they're nested in a Sequence, in which case the Sequence will still be the one in control and this method will be ignored)</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Flip(DG.Tweening.Tween)">
- <summary>Flips the direction of this tween (backwards if it was going forward or viceversa)</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.ForceInit(DG.Tweening.Tween)">
- <summary>Forces the tween to initialize its settings immediately</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Goto(DG.Tweening.Tween,System.Single,System.Boolean)">
- <summary>Send the tween to the given position in time</summary>
- <param name="to">Time position to reach
- (if higher than the whole tween duration the tween will simply reach its end)</param>
- <param name="andPlay">If TRUE will play the tween after reaching the given position, otherwise it will pause it</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.GotoWithCallbacks(DG.Tweening.Tween,System.Single,System.Boolean)">
- <summary>Send the tween to the given position in time while also executing any callback between the previous time position and the new one</summary>
- <param name="to">Time position to reach
- (if higher than the whole tween duration the tween will simply reach its end)</param>
- <param name="andPlay">If TRUE will play the tween after reaching the given position, otherwise it will pause it</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Kill(DG.Tweening.Tween,System.Boolean)">
- <summary>Kills the tween</summary>
- <param name="complete">If TRUE completes the tween before killing it</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.ManualUpdate(DG.Tweening.Tween,System.Single,System.Single)">
- <summary>
- Forces this tween to update manually, regardless of the <see cref="T:DG.Tweening.UpdateType"/> set via SetUpdate.
- Note that the tween will still be subject to normal tween rules, so if for example it's paused this method will do nothing.<para/>
- Also note that if you only want to update this tween instance manually you'll have to set it to <see cref="F:DG.Tweening.UpdateType.Manual"/> anyway,
- so that it's not updated automatically.
- </summary>
- <param name="deltaTime">Manual deltaTime</param>
- <param name="unscaledDeltaTime">Unscaled delta time (used with tweens set as timeScaleIndependent)</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Pause``1(``0)">
- <summary>Pauses the tween</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Play``1(``0)">
- <summary>Plays the tween</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.PlayBackwards(DG.Tweening.Tween)">
- <summary>Sets the tween in a backwards direction and plays it</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.PlayForward(DG.Tweening.Tween)">
- <summary>Sets the tween in a forward direction and plays it</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Restart(DG.Tweening.Tween,System.Boolean,System.Single)">
- <summary>Restarts the tween from the beginning</summary>
- <param name="includeDelay">Ignored in case of Sequences. If TRUE includes the eventual tween delay, otherwise skips it</param>
- <param name="changeDelayTo">Ignored in case of Sequences. If >= 0 changes the startup delay to this value, otherwise doesn't touch it</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Rewind(DG.Tweening.Tween,System.Boolean)">
- <summary>Rewinds and pauses the tween</summary>
- <param name="includeDelay">Ignored in case of Sequences. If TRUE includes the eventual tween delay, otherwise skips it</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.SmoothRewind(DG.Tweening.Tween)">
- <summary>Smoothly rewinds the tween (delays excluded).
- A "smooth rewind" animates the tween to its start position,
- skipping all elapsed loops (except in case of LoopType.Incremental) while keeping the animation fluent.
- If called on a tween who is still waiting for its delay to happen, it will simply set the delay to 0 and pause the tween.
- <para>Note that a tween that was smoothly rewinded will have its play direction flipped</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.TogglePause(DG.Tweening.Tween)">
- <summary>Plays the tween if it was paused, pauses it if it was playing</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.GotoWaypoint(DG.Tweening.Tween,System.Int32,System.Boolean)">
- <summary>Send a path tween to the given waypoint.
- Has no effect if this is not a path tween.
- <para>BEWARE, this is a special utility method:
- it works only with Linear eases. Also, the lookAt direction might be wrong after calling this and might need to be set manually
- (because it relies on a smooth path movement and doesn't work well with jumps that encompass dramatic direction changes)</para></summary>
- <param name="waypointIndex">Waypoint index to reach
- (if higher than the max waypoint index the tween will simply go to the last one)</param>
- <param name="andPlay">If TRUE will play the tween after reaching the given waypoint, otherwise it will pause it</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.WaitForCompletion(DG.Tweening.Tween)">
- <summary>
- Creates a yield instruction that waits until the tween is killed or complete.
- It can be used inside a coroutine as a yield.
- <para>Example usage:</para><code>yield return myTween.WaitForCompletion();</code>
- </summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.WaitForRewind(DG.Tweening.Tween)">
- <summary>
- Creates a yield instruction that waits until the tween is killed or rewinded.
- It can be used inside a coroutine as a yield.
- <para>Example usage:</para><code>yield return myTween.WaitForRewind();</code>
- </summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.WaitForKill(DG.Tweening.Tween)">
- <summary>
- Creates a yield instruction that waits until the tween is killed.
- It can be used inside a coroutine as a yield.
- <para>Example usage:</para><code>yield return myTween.WaitForKill();</code>
- </summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.WaitForElapsedLoops(DG.Tweening.Tween,System.Int32)">
- <summary>
- Creates a yield instruction that waits until the tween is killed or has gone through the given amount of loops.
- It can be used inside a coroutine as a yield.
- <para>Example usage:</para><code>yield return myTween.WaitForElapsedLoops(2);</code>
- </summary>
- <param name="elapsedLoops">Elapsed loops to wait for</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.WaitForPosition(DG.Tweening.Tween,System.Single)">
- <summary>
- Creates a yield instruction that waits until the tween is killed or has reached the given position (loops included, delays excluded).
- It can be used inside a coroutine as a yield.
- <para>Example usage:</para><code>yield return myTween.WaitForPosition(2.5f);</code>
- </summary>
- <param name="position">Position (loops included, delays excluded) to wait for</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.WaitForStart(DG.Tweening.Tween)">
- <summary>
- Creates a yield instruction that waits until the tween is killed or started
- (meaning when the tween is set in a playing state the first time, after any eventual delay).
- It can be used inside a coroutine as a yield.
- <para>Example usage:</para><code>yield return myTween.WaitForStart();</code>
- </summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.CompletedLoops(DG.Tweening.Tween)">
- <summary>Returns the total number of loops completed by this tween</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Delay(DG.Tweening.Tween)">
- <summary>Returns the eventual delay set for this tween</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.ElapsedDelay(DG.Tweening.Tween)">
- <summary>Returns the eventual elapsed delay set for this tween</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Duration(DG.Tweening.Tween,System.Boolean)">
- <summary>Returns the duration of this tween (delays excluded).
- <para>NOTE: when using settings like SpeedBased, the duration will be recalculated when the tween starts</para></summary>
- <param name="includeLoops">If TRUE returns the full duration loops included,
- otherwise the duration of a single loop cycle</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Elapsed(DG.Tweening.Tween,System.Boolean)">
- <summary>Returns the elapsed time for this tween (delays exluded)</summary>
- <param name="includeLoops">If TRUE returns the elapsed time since startup loops included,
- otherwise the elapsed time within the current loop cycle</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.ElapsedPercentage(DG.Tweening.Tween,System.Boolean)">
- <summary>Returns the elapsed percentage (0 to 1) of this tween (delays exluded)</summary>
- <param name="includeLoops">If TRUE returns the elapsed percentage since startup loops included,
- otherwise the elapsed percentage within the current loop cycle</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.ElapsedDirectionalPercentage(DG.Tweening.Tween)">
- <summary>Returns the elapsed percentage (0 to 1) of this tween (delays exluded),
- based on a single loop, and calculating eventual backwards Yoyo loops as 1 to 0 instead of 0 to 1</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.IsActive(DG.Tweening.Tween)">
- <summary>Returns FALSE if this tween has been killed or is NULL, TRUE otherwise.
- <para>BEWARE: if this tween is recyclable it might have been spawned again for another use and thus return TRUE anyway.</para>
- When working with recyclable tweens you should take care to know when a tween has been killed and manually set your references to NULL.
- If you want to be sure your references are set to NULL when a tween is killed you can use the <code>OnKill</code> callback like this:
- <para><code>.OnKill(()=> myTweenReference = null)</code></para></summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.IsBackwards(DG.Tweening.Tween)">
- <summary>Returns TRUE if this tween was reversed and is set to go backwards</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.IsLoopingOrExecutingBackwards(DG.Tweening.Tween)">
- <summary>NOTE: To check if a tween was simply set to go backwards see <see cref="M:DG.Tweening.TweenExtensions.IsBackwards(DG.Tweening.Tween)"/>.<para/>
- Returns TRUE if this tween is going backwards for any of these reasons:<para/>
- - The tween was reversed and is going backwards on a straight loop<para/>
- - The tween was reversed and is going backwards on an odd Yoyo loop<para/>
- - The tween is going forward but on an even Yoyo loop<para/>
- IMPORTANT: if used inside a tween's callback, this will return a result concerning the exact frame when it's asked,
- so for example in a callback at the end of a Yoyo loop step this method will never return FALSE
- because the frame will never end exactly there and the tween will already be going backwards when the callback is fired</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.IsComplete(DG.Tweening.Tween)">
- <summary>Returns TRUE if the tween is complete
- (silently fails and returns FALSE if the tween has been killed)</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.IsInitialized(DG.Tweening.Tween)">
- <summary>Returns TRUE if this tween has been initialized</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.IsPlaying(DG.Tweening.Tween)">
- <summary>Returns TRUE if this tween is playing</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.Loops(DG.Tweening.Tween)">
- <summary>Returns the total number of loops set for this tween
- (returns -1 if the loops are infinite)</summary>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.PathGetPoint(DG.Tweening.Tween,System.Single)">
- <summary>
- Returns a point on a path based on the given path percentage.
- Returns <code>Vector3.zero</code> if this is not a path tween, if the tween is invalid, or if the path is not yet initialized.
- A path is initialized after its tween starts, or immediately if the tween was created with the Path Editor (DOTween Pro feature).
- You can force a path to be initialized by calling <code>myTween.ForceInit()</code>.
- </summary>
- <param name="pathPercentage">Percentage of the path (0 to 1) on which to get the point</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.PathGetDrawPoints(DG.Tweening.Tween,System.Int32)">
- <summary>
- Returns an array of points that can be used to draw the path.
- Note that this method generates allocations, because it creates a new array.
- Returns <code>NULL</code> if this is not a path tween, if the tween is invalid, or if the path is not yet initialized.
- A path is initialized after its tween starts, or immediately if the tween was created with the Path Editor (DOTween Pro feature).
- You can force a path to be initialized by calling <code>myTween.ForceInit()</code>.
- </summary>
- <param name="subdivisionsXSegment">How many points to create for each path segment (waypoint to waypoint).
- Only used in case of non-Linear paths</param>
- </member>
- <member name="M:DG.Tweening.TweenExtensions.PathLength(DG.Tweening.Tween)">
- <summary>
- Returns the length of a path.
- Returns -1 if this is not a path tween, if the tween is invalid, or if the path is not yet initialized.
- A path is initialized after its tween starts, or immediately if the tween was created with the Path Editor (DOTween Pro feature).
- You can force a path to be initialized by calling <code>myTween.ForceInit()</code>.
- </summary>
- </member>
- <member name="T:DG.Tweening.LoopType">
- <summary>
- Types of loop
- </summary>
- </member>
- <member name="F:DG.Tweening.LoopType.Restart">
- <summary>Each loop cycle restarts from the beginning</summary>
- </member>
- <member name="F:DG.Tweening.LoopType.Yoyo">
- <summary>The tween moves forward and backwards at alternate cycles</summary>
- </member>
- <member name="F:DG.Tweening.LoopType.Incremental">
- <summary>Continuously increments the tween at the end of each loop cycle (A to B, B to B+(A-B), and so on), thus always moving "onward".
- <para>In case of String tweens works only if the tween is set as relative</para></summary>
- </member>
- <member name="T:DG.Tweening.Sequence">
- <summary>
- Controls other tweens as a group
- </summary>
- </member>
- <member name="T:DG.Tweening.ShortcutExtensions">
- <summary>
- Methods that extend known Unity objects and allow to directly create and control tweens from their instances
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOAspect(UnityEngine.Camera,System.Single,System.Single)">
- <summary>Tweens a Camera's <code>aspect</code> to the given value.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Camera,UnityEngine.Color,System.Single)">
- <summary>Tweens a Camera's backgroundColor to the given value.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFarClipPlane(UnityEngine.Camera,System.Single,System.Single)">
- <summary>Tweens a Camera's <code>farClipPlane</code> to the given value.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFieldOfView(UnityEngine.Camera,System.Single,System.Single)">
- <summary>Tweens a Camera's <code>fieldOfView</code> to the given value.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DONearClipPlane(UnityEngine.Camera,System.Single,System.Single)">
- <summary>Tweens a Camera's <code>nearClipPlane</code> to the given value.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOOrthoSize(UnityEngine.Camera,System.Single,System.Single)">
- <summary>Tweens a Camera's <code>orthographicSize</code> to the given value.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPixelRect(UnityEngine.Camera,UnityEngine.Rect,System.Single)">
- <summary>Tweens a Camera's <code>pixelRect</code> to the given value.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DORect(UnityEngine.Camera,UnityEngine.Rect,System.Single)">
- <summary>Tweens a Camera's <code>rect</code> to the given value.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakePosition(UnityEngine.Camera,System.Single,System.Single,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Camera's localPosition along its relative X Y axes with the given values.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakePosition(UnityEngine.Camera,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Camera's localPosition along its relative X Y axes with the given values.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength on each axis</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakeRotation(UnityEngine.Camera,System.Single,System.Single,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Camera's localRotation.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakeRotation(UnityEngine.Camera,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Camera's localRotation.
- Also stores the camera as the tween's target so it can be used for filtered operations</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength on each axis</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Light,UnityEngine.Color,System.Single)">
- <summary>Tweens a Light's color to the given value.
- Also stores the light as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOIntensity(UnityEngine.Light,System.Single,System.Single)">
- <summary>Tweens a Light's intensity to the given value.
- Also stores the light as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShadowStrength(UnityEngine.Light,System.Single,System.Single)">
- <summary>Tweens a Light's shadowStrength to the given value.
- Also stores the light as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.LineRenderer,DG.Tweening.Color2,DG.Tweening.Color2,System.Single)">
- <summary>Tweens a LineRenderer's color to the given value.
- Also stores the LineRenderer as the tween's target so it can be used for filtered operations.
- <para>Note that this method requires to also insert the start colors for the tween,
- since LineRenderers have no way to get them.</para></summary>
- <param name="startValue">The start value to tween from</param>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Material,UnityEngine.Color,System.Single)">
- <summary>Tweens a Material's color to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Material,UnityEngine.Color,System.String,System.Single)">
- <summary>Tweens a Material's named color property to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="property">The name of the material property to tween (like _Tint or _SpecColor)</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Material,UnityEngine.Color,System.Int32,System.Single)">
- <summary>Tweens a Material's named color property with the given ID to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="propertyID">The ID of the material property to tween (also called nameID in Unity's manual)</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFade(UnityEngine.Material,System.Single,System.Single)">
- <summary>Tweens a Material's alpha color to the given value
- (will have no effect unless your material supports transparency).
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFade(UnityEngine.Material,System.Single,System.String,System.Single)">
- <summary>Tweens a Material's alpha color to the given value
- (will have no effect unless your material supports transparency).
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="property">The name of the material property to tween (like _Tint or _SpecColor)</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFade(UnityEngine.Material,System.Single,System.Int32,System.Single)">
- <summary>Tweens a Material's alpha color with the given ID to the given value
- (will have no effect unless your material supports transparency).
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="propertyID">The ID of the material property to tween (also called nameID in Unity's manual)</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFloat(UnityEngine.Material,System.Single,System.String,System.Single)">
- <summary>Tweens a Material's named float property to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="property">The name of the material property to tween</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFloat(UnityEngine.Material,System.Single,System.Int32,System.Single)">
- <summary>Tweens a Material's named float property with the given ID to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="propertyID">The ID of the material property to tween (also called nameID in Unity's manual)</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOOffset(UnityEngine.Material,UnityEngine.Vector2,System.Single)">
- <summary>Tweens a Material's texture offset to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOOffset(UnityEngine.Material,UnityEngine.Vector2,System.String,System.Single)">
- <summary>Tweens a Material's named texture offset property to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="property">The name of the material property to tween</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOTiling(UnityEngine.Material,UnityEngine.Vector2,System.Single)">
- <summary>Tweens a Material's texture scale to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOTiling(UnityEngine.Material,UnityEngine.Vector2,System.String,System.Single)">
- <summary>Tweens a Material's named texture scale property to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="property">The name of the material property to tween</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOVector(UnityEngine.Material,UnityEngine.Vector4,System.String,System.Single)">
- <summary>Tweens a Material's named Vector property to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="property">The name of the material property to tween</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOVector(UnityEngine.Material,UnityEngine.Vector4,System.Int32,System.Single)">
- <summary>Tweens a Material's named Vector property with the given ID to the given value.
- Also stores the material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="propertyID">The ID of the material property to tween (also called nameID in Unity's manual)</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOResize(UnityEngine.TrailRenderer,System.Single,System.Single,System.Single)">
- <summary>Tweens a TrailRenderer's startWidth/endWidth to the given value.
- Also stores the TrailRenderer as the tween's target so it can be used for filtered operations</summary>
- <param name="toStartWidth">The end startWidth to reach</param><param name="toEndWidth">The end endWidth to reach</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOTime(UnityEngine.TrailRenderer,System.Single,System.Single)">
- <summary>Tweens a TrailRenderer's time to the given value.
- Also stores the TrailRenderer as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOMove(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Boolean)">
- <summary>Tweens a Transform's position to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOMoveX(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
- <summary>Tweens a Transform's X position to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOMoveY(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
- <summary>Tweens a Transform's Y position to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOMoveZ(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
- <summary>Tweens a Transform's Z position to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalMove(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Boolean)">
- <summary>Tweens a Transform's localPosition to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalMoveX(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
- <summary>Tweens a Transform's X localPosition to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalMoveY(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
- <summary>Tweens a Transform's Y localPosition to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalMoveZ(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
- <summary>Tweens a Transform's Z localPosition to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DORotate(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
- <summary>Tweens a Transform's rotation to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="mode">Rotation mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DORotateQuaternion(UnityEngine.Transform,UnityEngine.Quaternion,System.Single)">
- <summary>Tweens a Transform's rotation to the given value using pure quaternion values.
- Also stores the transform as the tween's target so it can be used for filtered operations.
- <para>PLEASE NOTE: DORotate, which takes Vector3 values, is the preferred rotation method.
- This method was implemented for very special cases, and doesn't support LoopType.Incremental loops
- (neither for itself nor if placed inside a LoopType.Incremental Sequence)</para>
- </summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalRotate(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
- <summary>Tweens a Transform's localRotation to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- <param name="mode">Rotation mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalRotateQuaternion(UnityEngine.Transform,UnityEngine.Quaternion,System.Single)">
- <summary>Tweens a Transform's rotation to the given value using pure quaternion values.
- Also stores the transform as the tween's target so it can be used for filtered operations.
- <para>PLEASE NOTE: DOLocalRotate, which takes Vector3 values, is the preferred rotation method.
- This method was implemented for very special cases, and doesn't support LoopType.Incremental loops
- (neither for itself nor if placed inside a LoopType.Incremental Sequence)</para>
- </summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOScale(UnityEngine.Transform,UnityEngine.Vector3,System.Single)">
- <summary>Tweens a Transform's localScale to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOScale(UnityEngine.Transform,System.Single,System.Single)">
- <summary>Tweens a Transform's localScale uniformly to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOScaleX(UnityEngine.Transform,System.Single,System.Single)">
- <summary>Tweens a Transform's X localScale to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOScaleY(UnityEngine.Transform,System.Single,System.Single)">
- <summary>Tweens a Transform's Y localScale to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOScaleZ(UnityEngine.Transform,System.Single,System.Single)">
- <summary>Tweens a Transform's Z localScale to the given value.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLookAt(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.AxisConstraint,System.Nullable{UnityEngine.Vector3})">
- <summary>Tweens a Transform's rotation so that it will look towards the given world position.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="towards">The position to look at</param><param name="duration">The duration of the tween</param>
- <param name="axisConstraint">Eventual axis constraint for the rotation</param>
- <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DODynamicLookAt(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.AxisConstraint,System.Nullable{UnityEngine.Vector3})">
- <summary><code>EXPERIMENTAL</code> Tweens a Transform's rotation so that it will look towards the given world position,
- while also updating the lookAt position every frame
- (contrary to <see cref="M:DG.Tweening.ShortcutExtensions.DOLookAt(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.AxisConstraint,System.Nullable{UnityEngine.Vector3})"/> which calculates the lookAt rotation only once, when the tween starts).
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="towards">The position to look at</param><param name="duration">The duration of the tween</param>
- <param name="axisConstraint">Eventual axis constraint for the rotation</param>
- <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPunchPosition(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single,System.Boolean)">
- <summary>Punches a Transform's localPosition towards the given direction and then back to the starting one
- as if it was connected to the starting position via an elastic.</summary>
- <param name="punch">The direction and strength of the punch (added to the Transform's current position)</param>
- <param name="duration">The duration of the tween</param>
- <param name="vibrato">Indicates how much will the punch vibrate</param>
- <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting position when bouncing backwards.
- 1 creates a full oscillation between the punch direction and the opposite direction,
- while 0 oscillates only between the punch and the start position</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPunchScale(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single)">
- <summary>Punches a Transform's localScale towards the given size and then back to the starting one
- as if it was connected to the starting scale via an elastic.</summary>
- <param name="punch">The punch strength (added to the Transform's current scale)</param>
- <param name="duration">The duration of the tween</param>
- <param name="vibrato">Indicates how much will the punch vibrate</param>
- <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting size when bouncing backwards.
- 1 creates a full oscillation between the punch scale and the opposite scale,
- while 0 oscillates only between the punch scale and the start scale</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPunchRotation(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single)">
- <summary>Punches a Transform's localRotation towards the given size and then back to the starting one
- as if it was connected to the starting rotation via an elastic.</summary>
- <param name="punch">The punch strength (added to the Transform's current rotation)</param>
- <param name="duration">The duration of the tween</param>
- <param name="vibrato">Indicates how much will the punch vibrate</param>
- <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting rotation when bouncing backwards.
- 1 creates a full oscillation between the punch rotation and the opposite rotation,
- while 0 oscillates only between the punch and the start rotation</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakePosition(UnityEngine.Transform,System.Single,System.Single,System.Int32,System.Single,System.Boolean,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Transform's localPosition with the given values.</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakePosition(UnityEngine.Transform,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Transform's localPosition with the given values.</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength on each axis</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakeRotation(UnityEngine.Transform,System.Single,System.Single,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Transform's localRotation.</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakeRotation(UnityEngine.Transform,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Transform's localRotation.</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength on each axis</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakeScale(UnityEngine.Transform,System.Single,System.Single,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Transform's localScale.</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOShakeScale(UnityEngine.Transform,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean,DG.Tweening.ShakeRandomnessMode)">
- <summary>Shakes a Transform's localScale.</summary>
- <param name="duration">The duration of the tween</param>
- <param name="strength">The shake strength on each axis</param>
- <param name="vibrato">Indicates how much will the shake vibrate</param>
- <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
- Setting it to 0 will shake along a single direction.</param>
- <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
- <param name="randomnessMode">Randomness mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOJump(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single,System.Boolean)">
- <summary>Tweens a Transform's position to the given value, while also applying a jump effect along the Y axis.
- Returns a Sequence instead of a Tweener.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="jumpPower">Power of the jump (the max height of the jump is represented by this plus the final Y offset)</param>
- <param name="numJumps">Total number of jumps</param>
- <param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalJump(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single,System.Boolean)">
- <summary>Tweens a Transform's localPosition to the given value, while also applying a jump effect along the Y axis.
- Returns a Sequence instead of a Tweener.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param>
- <param name="jumpPower">Power of the jump (the max height of the jump is represented by this plus the final Y offset)</param>
- <param name="numJumps">Total number of jumps</param>
- <param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPath(UnityEngine.Transform,UnityEngine.Vector3[],System.Single,DG.Tweening.PathType,DG.Tweening.PathMode,System.Int32,System.Nullable{UnityEngine.Color})">
- <summary>Tweens a Transform's position through the given path waypoints, using the chosen path algorithm.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="path">The waypoints to go through</param>
- <param name="duration">The duration of the tween</param>
- <param name="pathType">The type of path: Linear (straight path), CatmullRom (curved CatmullRom path) or CubicBezier (curved with control points)</param>
- <param name="pathMode">The path mode: 3D, side-scroller 2D, top-down 2D</param>
- <param name="resolution">The resolution of the path (useless in case of Linear paths): higher resolutions make for more detailed curved paths but are more expensive.
- Defaults to 10, but a value of 5 is usually enough if you don't have dramatic long curves between waypoints</param>
- <param name="gizmoColor">The color of the path (shown when gizmos are active in the Play panel and the tween is running)</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalPath(UnityEngine.Transform,UnityEngine.Vector3[],System.Single,DG.Tweening.PathType,DG.Tweening.PathMode,System.Int32,System.Nullable{UnityEngine.Color})">
- <summary>Tweens a Transform's localPosition through the given path waypoints, using the chosen path algorithm.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="path">The waypoint to go through</param>
- <param name="duration">The duration of the tween</param>
- <param name="pathType">The type of path: Linear (straight path), CatmullRom (curved CatmullRom path) or CubicBezier (curved with control points)</param>
- <param name="pathMode">The path mode: 3D, side-scroller 2D, top-down 2D</param>
- <param name="resolution">The resolution of the path: higher resolutions make for more detailed curved paths but are more expensive.
- Defaults to 10, but a value of 5 is usually enough if you don't have dramatic long curves between waypoints</param>
- <param name="gizmoColor">The color of the path (shown when gizmos are active in the Play panel and the tween is running)</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPath(UnityEngine.Transform,DG.Tweening.Plugins.Core.PathCore.Path,System.Single,DG.Tweening.PathMode)">
- <summary>IMPORTANT: Unless you really know what you're doing, you should use the overload that accepts a Vector3 array instead.<para/>
- Tweens a Transform's position via the given path.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="path">The path to use</param>
- <param name="duration">The duration of the tween</param>
- <param name="pathMode">The path mode: 3D, side-scroller 2D, top-down 2D</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOLocalPath(UnityEngine.Transform,DG.Tweening.Plugins.Core.PathCore.Path,System.Single,DG.Tweening.PathMode)">
- <summary>IMPORTANT: Unless you really know what you're doing, you should use the overload that accepts a Vector3 array instead.<para/>
- Tweens a Transform's localPosition via the given path.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="path">The path to use</param>
- <param name="duration">The duration of the tween</param>
- <param name="pathMode">The path mode: 3D, side-scroller 2D, top-down 2D</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOTimeScale(DG.Tweening.Tween,System.Single,System.Single)">
- <summary>Tweens a Tween's timeScale to the given value.
- Also stores the Tween as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableColor(UnityEngine.Light,UnityEngine.Color,System.Single)">
- <summary>Tweens a Light's color to the given value,
- in a way that allows other DOBlendableColor tweens to work together on the same target,
- instead than fight each other as multiple DOColor would do.
- Also stores the Light as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The value to tween to</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableColor(UnityEngine.Material,UnityEngine.Color,System.Single)">
- <summary>Tweens a Material's color to the given value,
- in a way that allows other DOBlendableColor tweens to work together on the same target,
- instead than fight each other as multiple DOColor would do.
- Also stores the Material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The value to tween to</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableColor(UnityEngine.Material,UnityEngine.Color,System.String,System.Single)">
- <summary>Tweens a Material's named color property to the given value,
- in a way that allows other DOBlendableColor tweens to work together on the same target,
- instead than fight each other as multiple DOColor would do.
- Also stores the Material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The value to tween to</param>
- <param name="property">The name of the material property to tween (like _Tint or _SpecColor)</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableColor(UnityEngine.Material,UnityEngine.Color,System.Int32,System.Single)">
- <summary>Tweens a Material's named color property with the given ID to the given value,
- in a way that allows other DOBlendableColor tweens to work together on the same target,
- instead than fight each other as multiple DOColor would do.
- Also stores the Material as the tween's target so it can be used for filtered operations</summary>
- <param name="endValue">The value to tween to</param>
- <param name="propertyID">The ID of the material property to tween (also called nameID in Unity's manual)</param>
- <param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableMoveBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Boolean)">
- <summary>Tweens a Transform's position BY the given value (as if you chained a <code>SetRelative</code>),
- in a way that allows other DOBlendableMove tweens to work together on the same target,
- instead than fight each other as multiple DOMove would do.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableLocalMoveBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Boolean)">
- <summary>Tweens a Transform's localPosition BY the given value (as if you chained a <code>SetRelative</code>),
- in a way that allows other DOBlendableMove tweens to work together on the same target,
- instead than fight each other as multiple DOMove would do.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableRotateBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
- <summary>EXPERIMENTAL METHOD - Tweens a Transform's rotation BY the given value (as if you chained a <code>SetRelative</code>),
- in a way that allows other DOBlendableRotate tweens to work together on the same target,
- instead than fight each other as multiple DORotate would do.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
- <param name="mode">Rotation mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableLocalRotateBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
- <summary>EXPERIMENTAL METHOD - Tweens a Transform's lcoalRotation BY the given value (as if you chained a <code>SetRelative</code>),
- in a way that allows other DOBlendableRotate tweens to work together on the same target,
- instead than fight each other as multiple DORotate would do.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
- <param name="mode">Rotation mode</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendablePunchRotation(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single)">
- <summary>Punches a Transform's localRotation BY the given value and then back to the starting one
- as if it was connected to the starting rotation via an elastic. Does it in a way that allows other
- DOBlendableRotate tweens to work together on the same target</summary>
- <param name="punch">The punch strength (added to the Transform's current rotation)</param>
- <param name="duration">The duration of the tween</param>
- <param name="vibrato">Indicates how much will the punch vibrate</param>
- <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting rotation when bouncing backwards.
- 1 creates a full oscillation between the punch rotation and the opposite rotation,
- while 0 oscillates only between the punch and the start rotation</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableScaleBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single)">
- <summary>Tweens a Transform's localScale BY the given value (as if you chained a <code>SetRelative</code>),
- in a way that allows other DOBlendableScale tweens to work together on the same target,
- instead than fight each other as multiple DOScale would do.
- Also stores the transform as the tween's target so it can be used for filtered operations</summary>
- <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOComplete(UnityEngine.Component,System.Boolean)">
- <summary>
- Completes all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens completed
- (meaning the tweens that don't have infinite loops and were not already complete)
- </summary>
- <param name="withCallbacks">For Sequences only: if TRUE also internal Sequence callbacks will be fired,
- otherwise they will be ignored</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOComplete(UnityEngine.Material,System.Boolean)">
- <summary>
- Completes all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens completed
- (meaning the tweens that don't have infinite loops and were not already complete)
- </summary>
- <param name="withCallbacks">For Sequences only: if TRUE also internal Sequence callbacks will be fired,
- otherwise they will be ignored</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOKill(UnityEngine.Component,System.Boolean)">
- <summary>
- Kills all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens killed.
- </summary>
- <param name="complete">If TRUE completes the tween before killing it</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOKill(UnityEngine.Material,System.Boolean)">
- <summary>
- Kills all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens killed.
- </summary>
- <param name="complete">If TRUE completes the tween before killing it</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFlip(UnityEngine.Component)">
- <summary>
- Flips the direction (backwards if it was going forward or viceversa) of all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens flipped.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOFlip(UnityEngine.Material)">
- <summary>
- Flips the direction (backwards if it was going forward or viceversa) of all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens flipped.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOGoto(UnityEngine.Component,System.Single,System.Boolean)">
- <summary>
- Sends to the given position all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens involved.
- </summary>
- <param name="to">Time position to reach
- (if higher than the whole tween duration the tween will simply reach its end)</param>
- <param name="andPlay">If TRUE will play the tween after reaching the given position, otherwise it will pause it</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOGoto(UnityEngine.Material,System.Single,System.Boolean)">
- <summary>
- Sends to the given position all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens involved.
- </summary>
- <param name="to">Time position to reach
- (if higher than the whole tween duration the tween will simply reach its end)</param>
- <param name="andPlay">If TRUE will play the tween after reaching the given position, otherwise it will pause it</param>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPause(UnityEngine.Component)">
- <summary>
- Pauses all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens paused.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPause(UnityEngine.Material)">
- <summary>
- Pauses all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens paused.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPlay(UnityEngine.Component)">
- <summary>
- Plays all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens played.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPlay(UnityEngine.Material)">
- <summary>
- Plays all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens played.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPlayBackwards(UnityEngine.Component)">
- <summary>
- Plays backwards all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens played.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPlayBackwards(UnityEngine.Material)">
- <summary>
- Plays backwards all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens played.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPlayForward(UnityEngine.Component)">
- <summary>
- Plays forward all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens played.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOPlayForward(UnityEngine.Material)">
- <summary>
- Plays forward all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens played.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DORestart(UnityEngine.Component,System.Boolean)">
- <summary>
- Restarts all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens restarted.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DORestart(UnityEngine.Material,System.Boolean)">
- <summary>
- Restarts all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens restarted.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DORewind(UnityEngine.Component,System.Boolean)">
- <summary>
- Rewinds all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens rewinded.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DORewind(UnityEngine.Material,System.Boolean)">
- <summary>
- Rewinds all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens rewinded.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOSmoothRewind(UnityEngine.Component)">
- <summary>
- Smoothly rewinds all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens rewinded.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOSmoothRewind(UnityEngine.Material)">
- <summary>
- Smoothly rewinds all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens rewinded.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOTogglePause(UnityEngine.Component)">
- <summary>
- Toggles the paused state (plays if it was paused, pauses if it was playing) of all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens involved.
- </summary>
- </member>
- <member name="M:DG.Tweening.ShortcutExtensions.DOTogglePause(UnityEngine.Material)">
- <summary>
- Toggles the paused state (plays if it was paused, pauses if it was playing) of all tweens that have this target as a reference
- (meaning tweens that were started from this target, or that had this target added as an Id)
- and returns the total number of tweens involved.
- </summary>
- </member>
- <member name="T:DG.Tweening.TweenParams">
- <summary>
- This class serves only as a utility class to store tween settings to apply on multiple tweens.
- It is in no way needed otherwise, since you can directly apply tween settings to a tween via chaining
- </summary>
- </member>
- <member name="F:DG.Tweening.TweenParams.Params">
- <summary>A variable you can eventually Clear and reuse when needed,
- to avoid instantiating TweenParams objects</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.#ctor">
- <summary>Creates a new TweenParams object, which you can use to store tween settings
- to pass to multiple tweens via <code>myTween.SetAs(myTweenParms)</code></summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.Clear">
- <summary>Clears and resets this TweenParams instance using default values,
- so it can be reused without instantiating another one</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetAutoKill(System.Boolean)">
- <summary>Sets the autoKill behaviour of the tween.
- Has no effect if the tween has already started</summary>
- <param name="autoKillOnCompletion">If TRUE the tween will be automatically killed when complete</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetId(System.Object)">
- <summary>Sets an ID for the tween, which can then be used as a filter with DOTween's static methods.</summary>
- <param name="objectId">The ID to assign to this tween. Can be an int, a string, an object or anything else.</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetId(System.String)">
- <summary>Sets an ID for the tween, which can then be used as a filter with DOTween's static methods.</summary>
- <param name="stringId">The ID to assign to this tween. Can be an int, a string, an object or anything else.</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetId(System.Int32)">
- <summary>Sets an ID for the tween, which can then be used as a filter with DOTween's static methods.</summary>
- <param name="intId">The ID to assign to this tween. Can be an int, a string, an object or anything else.</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetTarget(System.Object)">
- <summary>Sets the target for the tween, which can then be used as a filter with DOTween's static methods.
- <para>IMPORTANT: use it with caution. If you just want to set an ID for the tween use <code>SetId</code> instead.</para>
- When using shorcuts the shortcut target is already assigned as the tween's target,
- so using this method will overwrite it and prevent shortcut-operations like myTarget.DOPause from working correctly.</summary>
- <param name="target">The target to assign to this tween. Can be an int, a string, an object or anything else.</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetLoops(System.Int32,System.Nullable{DG.Tweening.LoopType})">
- <summary>Sets the looping options for the tween.
- Has no effect if the tween has already started</summary>
- <param name="loops">Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence)</param>
- <param name="loopType">Loop behaviour type (default: LoopType.Restart)</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetEase(DG.Tweening.Ease,System.Nullable{System.Single},System.Nullable{System.Single})">
- <summary>Sets the ease of the tween.
- <para>If applied to Sequences eases the whole sequence animation</para></summary>
- <param name="overshootOrAmplitude">Eventual overshoot or amplitude to use with Back or Elastic easeType (default is 1.70158)</param>
- <param name="period">Eventual period to use with Elastic easeType (default is 0)</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetEase(UnityEngine.AnimationCurve)">
- <summary>Sets the ease of the tween using an AnimationCurve.
- <para>If applied to Sequences eases the whole sequence animation</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetEase(DG.Tweening.EaseFunction)">
- <summary>Sets the ease of the tween using a custom ease function.
- <para>If applied to Sequences eases the whole sequence animation</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetRecyclable(System.Boolean)">
- <summary>Sets the recycling behaviour for the tween.</summary>
- <param name="recyclable">If TRUE the tween will be recycled after being killed, otherwise it will be destroyed.</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetUpdate(System.Boolean)">
- <summary>Sets the update type to the one defined in DOTween.defaultUpdateType (UpdateType.Normal unless changed)
- and lets you choose if it should be independent from Unity's Time.timeScale</summary>
- <param name="isIndependentUpdate">If TRUE the tween will ignore Unity's Time.timeScale</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetUpdate(DG.Tweening.UpdateType,System.Boolean)">
- <summary>Sets the type of update (default or independent) for the tween</summary>
- <param name="updateType">The type of update (default: UpdateType.Normal)</param>
- <param name="isIndependentUpdate">If TRUE the tween will ignore Unity's Time.timeScale</param>
- </member>
- <member name="M:DG.Tweening.TweenParams.OnStart(DG.Tweening.TweenCallback)">
- <summary>Sets the onStart callback for the tween.
- Called the first time the tween is set in a playing state, after any eventual delay</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.OnPlay(DG.Tweening.TweenCallback)">
- <summary>Sets the onPlay callback for the tween.
- Called when the tween is set in a playing state, after any eventual delay.
- Also called each time the tween resumes playing from a paused state</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.OnRewind(DG.Tweening.TweenCallback)">
- <summary>Sets the onRewind callback for the tween.
- Called when the tween is rewinded,
- either by calling <code>Rewind</code> or by reaching the start position while playing backwards.
- Rewinding a tween that is already rewinded will not fire this callback</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.OnUpdate(DG.Tweening.TweenCallback)">
- <summary>Sets the onUpdate callback for the tween.
- Called each time the tween updates</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.OnStepComplete(DG.Tweening.TweenCallback)">
- <summary>Sets the onStepComplete callback for the tween.
- Called the moment the tween completes one loop cycle, even when going backwards</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.OnComplete(DG.Tweening.TweenCallback)">
- <summary>Sets the onComplete callback for the tween.
- Called the moment the tween reaches its final forward position, loops included</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.OnKill(DG.Tweening.TweenCallback)">
- <summary>Sets the onKill callback for the tween.
- Called the moment the tween is killed</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.OnWaypointChange(DG.Tweening.TweenCallback{System.Int32})">
- <summary>Sets the onWaypointChange callback for the tween.
- Called when a path tween reaches a new waypoint</summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetDelay(System.Single)">
- <summary>Sets a delayed startup for the tween.
- <para>Has no effect on Sequences or if the tween has already started</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetRelative(System.Boolean)">
- <summary>If isRelative is TRUE sets the tween as relative
- (the endValue will be calculated as <code>startValue + endValue</code> instead than being used directly).
- <para>Has no effect on Sequences or if the tween has already started</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenParams.SetSpeedBased(System.Boolean)">
- <summary>If isSpeedBased is TRUE sets the tween as speed based
- (the duration will represent the number of units the tween moves x second).
- <para>Has no effect on Sequences, nested tweens, or if the tween has already started</para></summary>
- </member>
- <member name="T:DG.Tweening.TweenSettingsExtensions">
- <summary>
- Methods that extend Tween objects and allow to set their parameters
- </summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetAutoKill``1(``0)">
- <summary>Sets the autoKill behaviour of the tween to TRUE.
- <code>Has no effect</code> if the tween has already started or if it's added to a Sequence</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetAutoKill``1(``0,System.Boolean)">
- <summary>Sets the autoKill behaviour of the tween.
- <code>Has no effect</code> if the tween has already started or if it's added to a Sequence</summary>
- <param name="autoKillOnCompletion">If TRUE the tween will be automatically killed when complete</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetId``1(``0,System.Object)">
- <summary>Sets an ID for the tween (<see cref="F:DG.Tweening.Tween.id"/>), which can then be used as a filter with DOTween's static methods.</summary>
- <param name="objectId">The ID to assign to this tween. Can be an int, a string, an object or anything else.</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetId``1(``0,System.String)">
- <summary>Sets a string ID for the tween (<see cref="F:DG.Tweening.Tween.stringId"/>), which can then be used as a filter with DOTween's static methods.<para/>
- Filtering via string is 2X faster than using an object as an ID (using the alternate obejct overload)</summary>
- <param name="stringId">The string ID to assign to this tween.</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetId``1(``0,System.Int32)">
- <summary>Sets an int ID for the tween (<see cref="F:DG.Tweening.Tween.intId"/>), which can then be used as a filter with DOTween's static methods.<para/>
- Filtering via int is 4X faster than via object, 2X faster than via string (using the alternate object/string overloads)</summary>
- <param name="intId">The int ID to assign to this tween.</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLink``1(``0,UnityEngine.GameObject)">
- <summary>Allows to link this tween to a GameObject
- so that it will be automatically killed when the GameObject is destroyed.
- <code>Has no effect</code> if the tween is added to a Sequence</summary>
- <param name="gameObject">The link target (unrelated to the target set via <code>SetTarget</code>)</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLink``1(``0,UnityEngine.GameObject,DG.Tweening.LinkBehaviour)">
- <summary>Allows to link this tween to a GameObject and assign a behaviour depending on it.
- This will also automatically kill the tween when the GameObject is destroyed.
- <code>Has no effect</code> if the tween is added to a Sequence</summary>
- <param name="gameObject">The link target (unrelated to the target set via <code>SetTarget</code>)</param>
- <param name="behaviour">The behaviour to use (<see cref="F:DG.Tweening.LinkBehaviour.KillOnDestroy"/> is always evaluated even if you choose another one)</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetTarget``1(``0,System.Object)">
- <summary>Sets the target for the tween, which can then be used as a filter with DOTween's static methods.
- <para>IMPORTANT: use it with caution. If you just want to set an ID for the tween use <code>SetId</code> instead.</para>
- When using shorcuts the shortcut target is already assigned as the tween's target,
- so using this method will overwrite it and prevent shortcut-operations like myTarget.DOPause from working correctly.</summary>
- <param name="target">The target to assign to this tween. Can be an int, a string, an object or anything else.</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLoops``1(``0,System.Int32)">
- <summary>Sets the looping options for the tween.
- Has no effect if the tween has already started</summary>
- <param name="loops">Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence)</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLoops``1(``0,System.Int32,DG.Tweening.LoopType)">
- <summary>Sets the looping options for the tween.
- Has no effect if the tween has already started</summary>
- <param name="loops">Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence)</param>
- <param name="loopType">Loop behaviour type (default: LoopType.Restart)</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,DG.Tweening.Ease)">
- <summary>Sets the ease of the tween.
- <para>If applied to Sequences eases the whole sequence animation</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,DG.Tweening.Ease,System.Single)">
- <summary>Sets the ease of the tween.
- <para>If applied to Sequences eases the whole sequence animation</para></summary>
- <param name="overshoot">
- Eventual overshoot to use with Back or Flash ease (default is 1.70158 - 1 for Flash).
- <para>In case of Flash ease it must be an intenger and sets the total number of flashes that will happen.
- Using an even number will complete the tween on the starting value, while an odd one will complete it on the end value.</para>
- </param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,DG.Tweening.Ease,System.Single,System.Single)">
- <summary>Sets the ease of the tween.
- <para>If applied to Sequences eases the whole sequence animation</para></summary>
- <param name="amplitude">Eventual amplitude to use with Elastic easeType or overshoot to use with Flash easeType (default is 1.70158 - 1 for Flash).
- <para>In case of Flash ease it must be an integer and sets the total number of flashes that will happen.
- Using an even number will complete the tween on the starting value, while an odd one will complete it on the end value.</para>
- </param>
- <param name="period">Eventual period to use with Elastic or Flash easeType (default is 0).
- <para>In case of Flash ease it indicates the power in time of the ease, and must be between -1 and 1.
- 0 is balanced, 1 weakens the ease with time, -1 starts the ease weakened and gives it power towards the end.</para>
- </param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,UnityEngine.AnimationCurve)">
- <summary>Sets the ease of the tween using an AnimationCurve.
- <para>If applied to Sequences eases the whole sequence animation</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,DG.Tweening.EaseFunction)">
- <summary>Sets the ease of the tween using a custom ease function (which must return a value between 0 and 1).
- <para>If applied to Sequences eases the whole sequence animation</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetRecyclable``1(``0)">
- <summary>Allows the tween to be recycled after being killed.</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetRecyclable``1(``0,System.Boolean)">
- <summary>Sets the recycling behaviour for the tween.</summary>
- <param name="recyclable">If TRUE the tween will be recycled after being killed, otherwise it will be destroyed.</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetUpdate``1(``0,System.Boolean)">
- <summary>Sets the update type to UpdateType.Normal and lets you choose if it should be independent from Unity's Time.timeScale</summary>
- <param name="isIndependentUpdate">If TRUE the tween will ignore Unity's Time.timeScale</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetUpdate``1(``0,DG.Tweening.UpdateType)">
- <summary>Sets the type of update for the tween</summary>
- <param name="updateType">The type of update (defalt: UpdateType.Normal)</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetUpdate``1(``0,DG.Tweening.UpdateType,System.Boolean)">
- <summary>Sets the type of update for the tween and lets you choose if it should be independent from Unity's Time.timeScale</summary>
- <param name="updateType">The type of update</param>
- <param name="isIndependentUpdate">If TRUE the tween will ignore Unity's Time.timeScale</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetInverted``1(``0)">
- <summary>EXPERIMENTAL: inverts this tween, so that it will play from the end to the beginning
- (playing it backwards will actually play it from the beginning to the end).
- <code>Has no effect</code> if the tween has already started or if it's added to a Sequence</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetInverted``1(``0,System.Boolean)">
- <summary>EXPERIMENTAL: inverts this tween, so that it will play from the end to the beginning
- (playing it backwards will actually play it from the beginning to the end).
- <code>Has no effect</code> if the tween has already started or if it's added to a Sequence</summary>
- <param name="inverted">If TRUE the tween will be inverted, otherwise it won't</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnStart``1(``0,DG.Tweening.TweenCallback)">
- <summary>Sets the <code>onStart</code> callback for the tween, clearing any previous <code>onStart</code> callback that was set.
- Called the first time the tween is set in a playing state, after any eventual delay</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnPlay``1(``0,DG.Tweening.TweenCallback)">
- <summary>Sets the <code>onPlay</code> callback for the tween, clearing any previous <code>onPlay</code> callback that was set.
- Called when the tween is set in a playing state, after any eventual delay.
- Also called each time the tween resumes playing from a paused state</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnPause``1(``0,DG.Tweening.TweenCallback)">
- <summary>Sets the <code>onPause</code> callback for the tween, clearing any previous <code>onPause</code> callback that was set.
- Called when the tween state changes from playing to paused.
- If the tween has autoKill set to FALSE, this is called also when the tween reaches completion.</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnRewind``1(``0,DG.Tweening.TweenCallback)">
- <summary>Sets the <code>onRewind</code> callback for the tween, clearing any previous <code>onRewind</code> callback that was set.
- Called when the tween is rewinded,
- either by calling <code>Rewind</code> or by reaching the start position while playing backwards.
- Rewinding a tween that is already rewinded will not fire this callback</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnUpdate``1(``0,DG.Tweening.TweenCallback)">
- <summary>Sets the <code>onUpdate</code> callback for the tween, clearing any previous <code>onUpdate</code> callback that was set.
- Called each time the tween updates</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnStepComplete``1(``0,DG.Tweening.TweenCallback)">
- <summary>Sets the <code>onStepComplete</code> callback for the tween, clearing any previous <code>onStepComplete</code> callback that was set.
- Called the moment the tween completes one loop cycle, even when going backwards</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnComplete``1(``0,DG.Tweening.TweenCallback)">
- <summary>Sets the <code>onComplete</code> callback for the tween, clearing any previous <code>onComplete</code> callback that was set.
- Called the moment the tween reaches its final forward position, loops included</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnKill``1(``0,DG.Tweening.TweenCallback)">
- <summary>Sets the <code>onKill</code> callback for the tween, clearing any previous <code>onKill</code> callback that was set.
- Called the moment the tween is killed</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.OnWaypointChange``1(``0,DG.Tweening.TweenCallback{System.Int32})">
- <summary>Sets the <code>onWaypointChange</code> callback for the tween, clearing any previous <code>onWaypointChange</code> callback that was set.
- Called when a path tween's current waypoint changes</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetAs``1(``0,DG.Tweening.Tween)">
- <summary>Sets the parameters of the tween (id, ease, loops, delay, timeScale, callbacks, etc) as the parameters of the given one.
- Doesn't copy specific SetOptions settings: those will need to be applied manually each time.
- <para>Has no effect if the tween has already started.</para>
- NOTE: the tween's <code>target</code> will not be changed</summary>
- <param name="asTween">Tween from which to copy the parameters</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetAs``1(``0,DG.Tweening.TweenParams)">
- <summary>Sets the parameters of the tween (id, ease, loops, delay, timeScale, callbacks, etc) as the parameters of the given TweenParams.
- <para>Has no effect if the tween has already started.</para></summary>
- <param name="tweenParams">TweenParams from which to copy the parameters</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.Append(DG.Tweening.Sequence,DG.Tweening.Tween)">
- <summary>Adds the given tween to the end of the Sequence.
- Has no effect if the Sequence has already started</summary>
- <param name="t">The tween to append</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.Prepend(DG.Tweening.Sequence,DG.Tweening.Tween)">
- <summary>Adds the given tween to the beginning of the Sequence, pushing forward the other nested content.
- Has no effect if the Sequence has already started</summary>
- <param name="t">The tween to prepend</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.Join(DG.Tweening.Sequence,DG.Tweening.Tween)">
- <summary>Inserts the given tween at the same time position of the last tween, callback or interval added to the Sequence.
- Note that, in case of a Join after an interval, the insertion time will be the time where the interval starts, not where it finishes.
- Has no effect if the Sequence has already started</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.Insert(DG.Tweening.Sequence,System.Single,DG.Tweening.Tween)">
- <summary>Inserts the given tween at the given time position in the Sequence,
- automatically adding an interval if needed.
- Has no effect if the Sequence has already started</summary>
- <param name="atPosition">The time position where the tween will be placed</param>
- <param name="t">The tween to insert</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.AppendInterval(DG.Tweening.Sequence,System.Single)">
- <summary>Adds the given interval to the end of the Sequence.
- Has no effect if the Sequence has already started</summary>
- <param name="interval">The interval duration</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.PrependInterval(DG.Tweening.Sequence,System.Single)">
- <summary>Adds the given interval to the beginning of the Sequence, pushing forward the other nested content.
- Has no effect if the Sequence has already started</summary>
- <param name="interval">The interval duration</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.AppendCallback(DG.Tweening.Sequence,DG.Tweening.TweenCallback)">
- <summary>Adds the given callback to the end of the Sequence.
- Has no effect if the Sequence has already started</summary>
- <param name="callback">The callback to append</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.PrependCallback(DG.Tweening.Sequence,DG.Tweening.TweenCallback)">
- <summary>Adds the given callback to the beginning of the Sequence, pushing forward the other nested content.
- Has no effect if the Sequence has already started</summary>
- <param name="callback">The callback to prepend</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.JoinCallback(DG.Tweening.Sequence,DG.Tweening.TweenCallback)">
- <summary>Inserts the given callback at the same time position of the last tween, callback or interval added to the Sequence.
- Note that, in case of a Join after an interval, the insertion time will be the time where the interval starts, not where it finishes.
- Has no effect if the Sequence has already started</summary>
- /// <param name="callback">The callback to prepend</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.InsertCallback(DG.Tweening.Sequence,System.Single,DG.Tweening.TweenCallback)">
- <summary>Inserts the given callback at the given time position in the Sequence,
- automatically adding an interval if needed.
- Has no effect if the Sequence has already started</summary>
- <param name="atPosition">The time position where the callback will be placed</param>
- <param name="callback">The callback to insert</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.From``1(``0)">
- <summary>Changes a TO tween into a FROM tween: sets the current target's position as the tween's endValue
- then immediately sends the target to the previously set endValue.</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.From``1(``0,System.Boolean)">
- <summary>Changes a TO tween into a FROM tween: sets the current target's position as the tween's endValue
- then immediately sends the target to the previously set endValue.</summary>
- <param name="isRelative">If TRUE the FROM value will be calculated as relative to the current one</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.From``1(``0,System.Boolean,System.Boolean)">
- <summary>Changes a TO tween into a FROM tween: sets the current value of the target as the endValue,
- and the previously passed endValue as the actual startValue.</summary>
- <param name="setImmediately">If TRUE sets the target to from value immediately, otherwise waits for the tween to start</param>
- <param name="isRelative">If TRUE the FROM value will be calculated as relative to the current one</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.From``3(DG.Tweening.Core.TweenerCore{``0,``1,``2},``1,System.Boolean,System.Boolean)">
- <summary>Changes a TO tween into a FROM tween: sets the tween's starting value to the given one
- and eventually sets the tween's target to that value immediately.</summary>
- <param name="fromValue">Value to start from</param>
- <param name="setImmediately">If TRUE sets the target to from value immediately, otherwise waits for the tween to start</param>
- <param name="isRelative">If TRUE the FROM/TO values will be calculated as relative to the current ones</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.From(DG.Tweening.Core.TweenerCore{UnityEngine.Color,UnityEngine.Color,DG.Tweening.Plugins.Options.ColorOptions},System.Single,System.Boolean,System.Boolean)">
- <summary>Changes a TO tween into a FROM tween: sets the tween's starting value to the given one
- and eventually sets the tween's target to that value immediately.</summary>
- <param name="fromAlphaValue">Alpha value to start from (in case of Fade tweens)</param>
- <param name="setImmediately">If TRUE sets the target to from value immediately, otherwise waits for the tween to start</param>
- <param name="isRelative">If TRUE the FROM/TO values will be calculated as relative to the current ones</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.From(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3,DG.Tweening.Plugins.Options.VectorOptions},System.Single,System.Boolean,System.Boolean)">
- <summary>Changes a TO tween into a FROM tween: sets the tween's starting value to the given one
- and eventually sets the tween's target to that value immediately.</summary>
- <param name="fromValue">Value to start from (in case of Vector tweens that act on a single coordinate or scale tweens)</param>
- <param name="setImmediately">If TRUE sets the target to from value immediately, otherwise waits for the tween to start</param>
- <param name="isRelative">If TRUE the FROM/TO values will be calculated as relative to the current ones</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.From(DG.Tweening.Core.TweenerCore{UnityEngine.Vector2,UnityEngine.Vector2,DG.Tweening.Plugins.CircleOptions},System.Single,System.Boolean,System.Boolean)">
- <summary>Changes a TO tween into a FROM tween: sets the tween's starting value to the given one
- and eventually sets the tween's target to that value immediately.</summary>
- <param name="fromValueDegrees">Value to start from (in case of Vector tweens that act on a single coordinate or scale tweens)</param>
- <param name="setImmediately">If TRUE sets the target to from value immediately, otherwise waits for the tween to start</param>
- <param name="isRelative">If TRUE the FROM/TO values will be calculated as relative to the current ones</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetDelay``1(``0,System.Single)">
- <summary>Sets a delayed startup for the tween.<para/>
- In case of Sequences behaves the same as <see cref="M:DG.Tweening.TweenSettingsExtensions.PrependInterval(DG.Tweening.Sequence,System.Single)"/>,
- which means the delay will repeat in case of loops (while with tweens it's ignored after the first loop cycle).<para/>
- Has no effect if the tween has already started</summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetDelay``1(``0,System.Single,System.Boolean)">
- <summary>EXPERIMENTAL: implemented in v1.2.340.<para/>
- Sets a delayed startup for the tween with options to choose how the delay is applied in case of Sequences.<para/>
- Has no effect if the tween has already started</summary>
- <param name="asPrependedIntervalIfSequence">Only used by <see cref="T:DG.Tweening.Sequence"/> types: If FALSE sets the delay as a one-time occurrence
- (defaults to this for <see cref="T:DG.Tweening.Tweener"/> types),
- otherwise as a Sequence interval which will repeat at the beginning of every loop cycle</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetRelative``1(``0)">
- <summary>Sets the tween as relative
- (the endValue will be calculated as <code>startValue + endValue</code> instead than being used directly).
- <para>Has no effect on Sequences or if the tween has already started</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetRelative``1(``0,System.Boolean)">
- <summary>If isRelative is TRUE sets the tween as relative
- (the endValue will be calculated as <code>startValue + endValue</code> instead than being used directly).
- <para>Has no effect on Sequences or if the tween has already started</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetSpeedBased``1(``0)">
- <summary>If isSpeedBased is TRUE sets the tween as speed based
- (the duration will represent the number of units the tween moves x second).
- <para>Has no effect on Sequences, nested tweens, or if the tween has already started</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetSpeedBased``1(``0,System.Boolean)">
- <summary>If isSpeedBased is TRUE sets the tween as speed based
- (the duration will represent the number of units the tween moves x second).
- <para>Has no effect on Sequences, nested tweens, or if the tween has already started</para></summary>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{System.Single,System.Single,DG.Tweening.Plugins.Options.FloatOptions},System.Boolean)">
- <summary>Options for float tweens</summary>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector2,UnityEngine.Vector2,DG.Tweening.Plugins.Options.VectorOptions},System.Boolean)">
- <summary>Options for Vector2 tweens</summary>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector2,UnityEngine.Vector2,DG.Tweening.Plugins.Options.VectorOptions},DG.Tweening.AxisConstraint,System.Boolean)">
- <summary>Options for Vector2 tweens</summary>
- <param name="axisConstraint">Selecting an axis will tween the vector only on that axis, leaving the others untouched</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3,DG.Tweening.Plugins.Options.VectorOptions},System.Boolean)">
- <summary>Options for Vector3 tweens</summary>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3,DG.Tweening.Plugins.Options.VectorOptions},DG.Tweening.AxisConstraint,System.Boolean)">
- <summary>Options for Vector3 tweens</summary>
- <param name="axisConstraint">Selecting an axis will tween the vector only on that axis, leaving the others untouched</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector4,UnityEngine.Vector4,DG.Tweening.Plugins.Options.VectorOptions},System.Boolean)">
- <summary>Options for Vector4 tweens</summary>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector4,UnityEngine.Vector4,DG.Tweening.Plugins.Options.VectorOptions},DG.Tweening.AxisConstraint,System.Boolean)">
- <summary>Options for Vector4 tweens</summary>
- <param name="axisConstraint">Selecting an axis will tween the vector only on that axis, leaving the others untouched</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Vector3,DG.Tweening.Plugins.Options.QuaternionOptions},System.Boolean)">
- <summary>Options for Quaternion tweens</summary>
- <param name="useShortest360Route">If TRUE (default) the rotation will take the shortest route, and will not rotate more than 360°.
- If FALSE the rotation will be fully accounted. Is always FALSE if the tween is set as relative</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Color,UnityEngine.Color,DG.Tweening.Plugins.Options.ColorOptions},System.Boolean)">
- <summary>Options for Color tweens</summary>
- <param name="alphaOnly">If TRUE only the alpha value of the color will be tweened</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Rect,UnityEngine.Rect,DG.Tweening.Plugins.Options.RectOptions},System.Boolean)">
- <summary>Options for Vector4 tweens</summary>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{System.String,System.String,DG.Tweening.Plugins.Options.StringOptions},System.Boolean,DG.Tweening.ScrambleMode,System.String)">
- <summary>Options for Vector4 tweens</summary>
- <param name="richTextEnabled">If TRUE, rich text will be interpreted correctly while animated,
- otherwise all tags will be considered as normal text</param>
- <param name="scrambleMode">The type of scramble to use, if any</param>
- <param name="scrambleChars">A string containing the characters to use for scrambling.
- Use as many characters as possible (minimum 10) because DOTween uses a fast scramble mode which gives better results with more characters.
- Leave it to NULL to use default ones</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3[],DG.Tweening.Plugins.Options.Vector3ArrayOptions},System.Boolean)">
- <summary>Options for Vector3Array tweens</summary>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3[],DG.Tweening.Plugins.Options.Vector3ArrayOptions},DG.Tweening.AxisConstraint,System.Boolean)">
- <summary>Options for Vector3Array tweens</summary>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector2,UnityEngine.Vector2,DG.Tweening.Plugins.CircleOptions},System.Single,System.Boolean,System.Boolean)">
- <summary>Options for ShapeCircle tweens</summary>
- <param name="relativeCenter">If TRUE the center you set in the DOTween.To method will be considered as relative
- to the starting position of the target</param>
- <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},DG.Tweening.AxisConstraint,DG.Tweening.AxisConstraint)">
- <summary>Options for Path tweens (created via the <code>DOPath</code> shortcut)</summary>
- <param name="lockPosition">The eventual movement axis to lock. You can input multiple axis if you separate them like this:
- <para>AxisConstrain.X | AxisConstraint.Y</para></param>
- <param name="lockRotation">The eventual rotation axis to lock. You can input multiple axis if you separate them like this:
- <para>AxisConstrain.X | AxisConstraint.Y</para></param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},System.Boolean,DG.Tweening.AxisConstraint,DG.Tweening.AxisConstraint)">
- <summary>Options for Path tweens (created via the <code>DOPath</code> shortcut)</summary>
- <param name="closePath">If TRUE the path will be automatically closed</param>
- <param name="lockPosition">The eventual movement axis to lock. You can input multiple axis if you separate them like this:
- <para>AxisConstrain.X | AxisConstraint.Y</para></param>
- <param name="lockRotation">The eventual rotation axis to lock. You can input multiple axis if you separate them like this:
- <para>AxisConstrain.X | AxisConstraint.Y</para></param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},UnityEngine.Vector3,System.Nullable{UnityEngine.Vector3},System.Nullable{UnityEngine.Vector3})">
- <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
- Orients the target towards the given position.
- Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
- <param name="lookAtPosition">The position to look at</param>
- <param name="forwardDirection">The eventual direction to consider as "forward".
- If left to NULL defaults to the regular forward side of the transform</param>
- <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},UnityEngine.Vector3,System.Boolean)">
- <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
- Orients the target towards the given position with options to keep the Z rotation stable.
- Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
- <param name="lookAtPosition">The position to look at</param>
- <param name="stableZRotation">If TRUE doesn't rotate the target along the Z axis</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},UnityEngine.Transform,System.Nullable{UnityEngine.Vector3},System.Nullable{UnityEngine.Vector3})">
- <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
- Orients the target towards another transform.
- Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
- <param name="lookAtTransform">The transform to look at</param>
- <param name="forwardDirection">The eventual direction to consider as "forward".
- If left to NULL defaults to the regular forward side of the transform</param>
- <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},UnityEngine.Transform,System.Boolean)">
- <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
- Orients the target towards another transform with options to keep the Z rotation stable.
- Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
- <param name="lookAtTransform">The transform to look at</param>
- <param name="stableZRotation">If TRUE doesn't rotate the target along the Z axis</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},System.Single,System.Nullable{UnityEngine.Vector3},System.Nullable{UnityEngine.Vector3})">
- <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
- Orients the target to the path, with the given lookAhead.
- Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
- <param name="lookAhead">The percentage of lookAhead to use (0 to 1)</param>
- <param name="forwardDirection">The eventual direction to consider as "forward".
- If left to NULL defaults to the regular forward side of the transform</param>
- <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
- </member>
- <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},System.Single,System.Boolean)">
- <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
- Orients the path with options to keep the Z rotation stable.
- Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
- <param name="lookAhead">The percentage of lookAhead to use (0 to 1)</param>
- <param name="stableZRotation">If TRUE doesn't rotate the target along the Z axis</param>
- </member>
- <member name="T:DG.Tweening.LogBehaviour">
- <summary>
- Types of log behaviours
- </summary>
- </member>
- <member name="F:DG.Tweening.LogBehaviour.Default">
- <summary>Log only warnings and errors</summary>
- </member>
- <member name="F:DG.Tweening.LogBehaviour.Verbose">
- <summary>Log warnings, errors and additional infos</summary>
- </member>
- <member name="F:DG.Tweening.LogBehaviour.ErrorsOnly">
- <summary>Log only errors</summary>
- </member>
- <member name="T:DG.Tweening.Tween">
- <summary>
- Indicates either a Tweener or a Sequence
- </summary>
- </member>
- <member name="F:DG.Tweening.Tween.timeScale">
- <summary>TimeScale for the tween</summary>
- </member>
- <member name="F:DG.Tweening.Tween.isBackwards">
- <summary>If TRUE the tween will play backwards</summary>
- </member>
- <member name="F:DG.Tweening.Tween.isInverted">
- <summary>If TRUE the tween is completely inverted but without playing it backwards
- (play backwards will actually play the tween in the original direction)</summary>
- </member>
- <member name="F:DG.Tweening.Tween.id">
- <summary>Object ID (usable for filtering with DOTween static methods). Can be anything except a string or an int
- (use <see cref="F:DG.Tweening.Tween.stringId"/> or <see cref="F:DG.Tweening.Tween.intId"/> for those)</summary>
- </member>
- <member name="F:DG.Tweening.Tween.stringId">
- <summary>String ID (usable for filtering with DOTween static methods). 2X faster than using an object id</summary>
- </member>
- <member name="F:DG.Tweening.Tween.intId">
- <summary>Int ID (usable for filtering with DOTween static methods). 4X faster than using an object id, 2X faster than using a string id.
- Default is -999 so avoid using an ID like that or it will capture all unset intIds</summary>
- </member>
- <member name="F:DG.Tweening.Tween.target">
- <summary>Tween target (usable for filtering with DOTween static methods). Automatically set by tween creation shortcuts</summary>
- </member>
- <member name="F:DG.Tweening.Tween.onPlay">
- <summary>Called when the tween is set in a playing state, after any eventual delay.
- Also called each time the tween resumes playing from a paused state</summary>
- </member>
- <member name="F:DG.Tweening.Tween.onPause">
- <summary>Called when the tween state changes from playing to paused.
- If the tween has autoKill set to FALSE, this is called also when the tween reaches completion.</summary>
- </member>
- <member name="F:DG.Tweening.Tween.onRewind">
- <summary>Called when the tween is rewinded,
- either by calling <code>Rewind</code> or by reaching the start position while playing backwards.
- Rewinding a tween that is already rewinded will not fire this callback</summary>
- </member>
- <member name="F:DG.Tweening.Tween.onUpdate">
- <summary>Called each time the tween updates</summary>
- </member>
- <member name="F:DG.Tweening.Tween.onStepComplete">
- <summary>Called the moment the tween completes one loop cycle</summary>
- </member>
- <member name="F:DG.Tweening.Tween.onComplete">
- <summary>Called the moment the tween reaches completion (loops included)</summary>
- </member>
- <member name="F:DG.Tweening.Tween.onKill">
- <summary>Called the moment the tween is killed</summary>
- </member>
- <member name="F:DG.Tweening.Tween.onWaypointChange">
- <summary>Called when a path tween's current waypoint changes</summary>
- </member>
- <member name="P:DG.Tweening.Tween.isRelative">
- <summary>Tweeners-only (ignored by Sequences), returns TRUE if the tween was set as relative</summary>
- </member>
- <member name="F:DG.Tweening.Tween.debugTargetId">
- <summary>
- Set by SetTarget if DOTween's Debug Mode is on (see DOTween Utility Panel -> "Store GameObject's ID" debug option
- </summary>
- </member>
- <member name="P:DG.Tweening.Tween.active">
- <summary>FALSE when tween is (or should be) despawned - set only by TweenManager</summary>
- </member>
- <member name="P:DG.Tweening.Tween.fullPosition">
- <summary>Gets and sets the time position (loops included, delays excluded) of the tween</summary>
- </member>
- <member name="P:DG.Tweening.Tween.hasLoops">
- <summary>Returns TRUE if the tween is set to loop (either a set number of times or infinitely)</summary>
- </member>
- <member name="P:DG.Tweening.Tween.playedOnce">
- <summary>TRUE after the tween was set in a play state at least once, AFTER any delay is elapsed</summary>
- </member>
- <member name="P:DG.Tweening.Tween.position">
- <summary>Time position within a single loop cycle</summary>
- </member>
- <member name="T:DG.Tweening.Tweener">
- <summary>
- Animates a single value
- </summary>
- </member>
- <member name="M:DG.Tweening.Tweener.ChangeStartValue(System.Object,System.Single)">
- <summary>Changes the start value of a tween and rewinds it (without pausing it).
- Has no effect with tweens that are inside Sequences</summary>
- <param name="newStartValue">The new start value</param>
- <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
- </member>
- <member name="M:DG.Tweening.Tweener.ChangeEndValue(System.Object,System.Single,System.Boolean)">
- <summary>Changes the end value of a tween and rewinds it (without pausing it).
- Has no effect with tweens that are inside Sequences</summary>
- <param name="newEndValue">The new end value</param>
- <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
- <param name="snapStartValue">If TRUE the start value will become the current target's value, otherwise it will stay the same</param>
- </member>
- <member name="M:DG.Tweening.Tweener.ChangeEndValue(System.Object,System.Boolean)">
- <summary>Changes the end value of a tween and rewinds it (without pausing it).
- Has no effect with tweens that are inside Sequences</summary>
- <param name="newEndValue">The new end value</param>
- <param name="snapStartValue">If TRUE the start value will become the current target's value, otherwise it will stay the same</param>
- </member>
- <member name="M:DG.Tweening.Tweener.ChangeValues(System.Object,System.Object,System.Single)">
- <summary>Changes the start and end value of a tween and rewinds it (without pausing it).
- Has no effect with tweens that are inside Sequences</summary>
- <param name="newStartValue">The new start value</param>
- <param name="newEndValue">The new end value</param>
- <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
- </member>
- <member name="T:DG.Tweening.TweenType">
- <summary>
- Used internally
- </summary>
- </member>
- <member name="T:DG.Tweening.UpdateType">
- <summary>
- Update type
- </summary>
- </member>
- <member name="F:DG.Tweening.UpdateType.Normal">
- <summary>Updates every frame during Update calls</summary>
- </member>
- <member name="F:DG.Tweening.UpdateType.Late">
- <summary>Updates every frame during LateUpdate calls</summary>
- </member>
- <member name="F:DG.Tweening.UpdateType.Fixed">
- <summary>Updates using FixedUpdate calls</summary>
- </member>
- <member name="F:DG.Tweening.UpdateType.Manual">
- <summary>Updates using manual update calls</summary>
- </member>
- </members>
- </doc>
|