@esotericsoftware/spine-core
Version:
The official Spine Runtimes for the web.
61 lines (60 loc) • 3.47 kB
TypeScript
/******************************************************************************
* Spine Runtimes License Agreement
* Last updated April 5, 2025. Replaces all prior versions.
*
* Copyright (c) 2013-2025, Esoteric Software LLC
*
* Integration of the Spine Runtimes into software or otherwise creating
* derivative works of the Spine Runtimes is permitted under the terms and
* conditions of Section 2 of the Spine Editor License Agreement:
* http://esotericsoftware.com/spine-editor-license
*
* Otherwise, it is permitted to integrate the Spine Runtimes into software
* or otherwise create derivative works of the Spine Runtimes (collectively,
* "Products"), provided that each user of the Products must obtain their own
* Spine Editor license and redistribution of the Products in any form must
* include this license and copyright notice.
*
* THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES,
* BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THE SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*****************************************************************************/
import type { Animation } from "./Animation.js";
import type { BoneData } from "./BoneData.js";
import { ConstraintData } from "./ConstraintData.js";
import type { Skeleton } from "./Skeleton.js";
import { Slider } from "./Slider.js";
import { SliderPose } from "./SliderPose.js";
import type { FromProperty } from "./TransformConstraintData.js";
/** Stores the setup pose for a {@link Slider}.
*
* See <a href="https://esotericsoftware.com/spine-slider-constraints">Slider constraints</a> in the Spine User Guide. */
export declare class SliderData extends ConstraintData<Slider, SliderPose> {
/** The animation the slider will apply. */
animation: Animation;
/** When true, the animation is applied by adding it to the current pose rather than overwriting it. */
additive: boolean;
/** When true, the animation repeats after its duration, otherwise the last frame is used. */
loop: boolean;
/** When set, the bone's transform property is used to set the slider's {@link SliderPose.time}. */
bone: BoneData | null;
/** When a bone is set, the specified transform property is used to set the slider's {@link SliderPose.time}. */
property: FromProperty;
/** When a bone is set, this is the scale of the {@link property} value in relation to the slider time. */
scale: number;
/** When a bone is set, the offset is added to the property. */
offset: number;
/** When true and a bone is set, the bone's local transform property is read instead of its world transform. */
local: boolean;
/** When a bone is set, the maximum slider time for the bone property range, or 0 if nonessential data was not exported. */
max: number;
constructor(name: string);
create(skeleton: Skeleton): Slider;
}