X-Git-Url: https://git.yukkurigames.com/?p=string-lerp.git;a=blobdiff_plain;f=README.md;fp=README.md;h=d96fd9fd54f302fead9bf75fcd02c45947c62914;hp=6d892629c526e92d131c559c8e465aafc4503c1d;hb=203ddaf6c8bc3326257cfeeda9a01752fbc7ab5c;hpb=eb2b2d4d7a57095b17f17eb6cfc084cbaa37ea90 diff --git a/README.md b/README.md index 6d89262..d96fd9f 100644 --- a/README.md +++ b/README.md @@ -60,12 +60,13 @@ Otherwise, they are passed through `fastLerp`. Lerp all the numbers in the string from their values in `a` to their values in `b`. -Numbers may have a leading `-` and a single `.` to mark the decimal -point, but something must be after the `.`. If both of the numbers in -a pair are integers, the result is clamped to an integer. +Numbers may have a leading "-" and a single "." to mark the decimal +point, but something must be after the ".". No other floating point +syntax (e.g. `1e6`) is supported. They are treated as fixed-point +values, with the point's position itself interpolating. -For example, `numericLerp("0.0", "100", 0.123) === "12.3"` because the -`.` in `0.0` is interpreted as a decimal point. +For example, `numericLerp("0.0", "100.0", 0.123) === "12.3"` because +the `.` in `0.0` is interpreted as a decimal point. But `numericLerp("0.", "100.", 0.123) === "12."` because the strings are interpreted as integers followed by a full stop.