tools.aqua.bgw.animation.Animation.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bgw-core Show documentation

A framework for board game applications.

There is a newer version: 0.5

/*
 *    Copyright 2021 The BoardGameWork Authors
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

@file:Suppress("unused")

package tools.aqua.bgw.animation

import tools.aqua.bgw.event.AnimationFinishedEvent

/**
 * [Animation] baseclass.
 *
 * @param duration Duration in milliseconds.
 */
sealed class Animation(val duration: Int) {
    
    /**
     * [Boolean] indicating whether the [Animation] is currently running.
     */
    var running: Boolean = false
    
    /**
     * Gets invoked when [Animation] has finished.
     */
    var onFinished: ((AnimationFinishedEvent) -> Unit)? = null
}