tools.aqua.bgw.components.gamecomponentviews.GameComponentView.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.components.gamecomponentviews

import tools.aqua.bgw.components.ComponentView
import tools.aqua.bgw.components.DynamicComponentView
import tools.aqua.bgw.visual.Visual

/**
 * Abstract baseclass for game components like [CardView]s or [TokenView]s.
 * This class is used to restrict the type argument of containers.
 *
 * @param posX horizontal coordinate for this [GameComponentView].
 * @param posY vertical coordinate for this [GameComponentView].
 * @param width width for this [GameComponentView].
 * @param height height for this [GameComponentView].
 * @param visual visual for this [GameComponentView].
 *
 * @see tools.aqua.bgw.components.container
 */
sealed class GameComponentView(
	posX: Number,
	posY: Number,
	width: Number,
	height: Number,
	visual: Visual
) : DynamicComponentView(posX = posX, posY = posY, width = width, height = height, visual = visual) {
	/**
	 * @throws RuntimeException [GameComponentView] does not support children.
	 */
	override fun removeChild(component: ComponentView) {
		throw RuntimeException("This $this component has no children.")
	}
}