What do all the params for Tween.PunchScale mean?

[flo-wolf]

Hi!
I just had some trouble understanding what the parameters for Tween.PunchScale actually mean.
Sadly the decompiled source does not include any summary comments, so I can't just check the function definition for clues (this would be great btw, having some param information in there).

There is frequency, which seems to be the amount of punches within the duration, but with some "falloff". cycles seems to be how many times the frequency is repeated (?). Then there is asymmetryFactor which I am not sure about. It seems to change the looks of the punch, but I can't really figure out how it works. From DOTween I know that the punch strength is not the final localscale value, but actually just an offset, but for others this might not be that intuitive

Would love to know a bit more about those params! By trial and error I will eventually get an understanding of them, some documentation would be nice though

[KyryloKuzyk]

Hey! Shake() and Punch() methods' parameters are documented in the ShakeSettings struct:

    public struct ShakeSettings {
        [Tooltip("Strength is applied per-axis in local space coordinates.\n\n" +
                 "Shakes: the strongest strength component will be used as the main frequency axis. Shakes on secondary axes happen randomly instead of following the frequency.\n\n" +
                 "Punches: strength determines punch direction.\n\n" +
                 "Strength is measured in units (position/scale) or Euler angles (rotation).")]
        public Vector3 strength;
        public float duration;
        [Tooltip("Number of shakes per second.")]
        public float frequency;
        [Tooltip("With enabled falloff shake starts at the highest strength and fades to the end.")]
        public bool enableFalloff;
        [Tooltip("Falloff ease is inverted to achieve the effect of shake 'fading' over time. Typically, eases go from 0 to 1, but falloff ease goes from 1 to 0.\n\n" +
                 "Default is Ease.Linear.\n\n" +
                 "Set to " + nameof(Ease) + "." + nameof(Ease.Custom) + " to have manual control over shake's 'strength' over time.")]
        public Ease falloffEase;
        [Tooltip("Shake's 'strength' over time.")]
        [CanBeNull] public AnimationCurve strengthOverTime;
        [Tooltip("Represents how asymmetrical the shake is.\n\n" +
                 "'0' means the shake is symmetrical around the initial value.\n\n" +
                 "'1' means the shake is asymmetrical and will happen between the initial position and the value of the '" + nameof(strength) + "' vector.\n\n" +
                 "When used with punches, can be treated as the resistance to 'recoil': '0' is full recoil, '1' is no recoil.")]
        [Range(0f, 1f)] public float asymmetry;
        /// <see cref="PrimeTweenManager.defaultShakeEase"/>
        [Tooltip("Ease between adjacent shake points.\n\n" +
                 "Default is Ease.OutQuad.")]
        public Ease easeBetweenShakes;

strength parameter has the same meaning between DOTween and PrimeTween: it's the largest linear/angular offset from the original position/rotation. frequency also has the same meaning, but to remap from DOTween's frequency, PrimeTween multiplies it by the magical 1.35 value in the DOTweenAdapter.

And by the way, PrimeTween comes with full source code available. To index the source code in your IDE, just enable this setting:

To view PrimeTween's XML documentation in your IDE, enable this setting: 'Unity Preferences/External Tools/Generate .csproj files for/Local tarball' and press the 'Regenerate project files' button.