rott/kf_sources/AcediaCore/Classes/EPlaceable.uc
2026-07-14 20:27:09 +07:00

72 lines
2.8 KiB
Ucode

/**
* Author: dkanus
* Home repo: https://www.insultplayers.ru/git/AcediaFramework/AcediaCore
* License: GPL
* Copyright 2022 - 2024 Anton Tarasenko
*------------------------------------------------------------------------------
* This file is part of Acedia.
*
* Acedia is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3 of the License, or
* (at your option) any later version.
*
* Acedia is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Acedia. If not, see <https://www.gnu.org/licenses/>.
*/
class EPlaceable extends EInterface
abstract;
//! Interface for any entity that can be placed into the game world.
//! To avoid purity for the sake of itself, in Acedia this interface also covers typical components
//! such as collision (shape) and visibility.
/// Returns position of corresponding entity.
public function Vector GetLocation();
/// Changes position of corresponding entity.
public function SetLocation(Vector newPosition);
/// Returns rotation of corresponding entity.
public function Rotator GetRotation();
/// Changes rotation of corresponding entity.
public function SetRotation(Rotator newRotation);
/// Returns whether corresponding entity is considered static, i.e. does not move or
/// change over time.
public function bool IsStatic();
/// Returns whether corresponding entity is capable of colliding other placeables.
public function bool IsColliding();
/// Changes whether corresponding entity is capable of colliding other placeables.
public function SetColliding(bool newColliding);
/// Returns whether corresponding entity is capable of blocking colliding placeables.
/// Blocking placeable entities cannot occupy the same space on the map.
public function bool IsBlocking();
/// Changes whether corresponding entity is capable of blocking colliding placeables.
/// Blocking placeable entities cannot occupy the same space on the map.
public function SetBlocking(bool newBlocking);
/// Checks if given placeable can be seen by players on the map.
///
/// It is not required that it is actually seen by someone at the moment of call, but that it
/// could be visible in principle.
public function bool IsVisible();
/// Changes if given placeable can be seen by players on the map.
///
/// It is not required that it is actually seen by someone at the moment of call, but that it
/// could be visible in principle.
public function SetVisible(bool newVisible);
defaultproperties {
}