mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-17 05:44:08 -07:00
def47cb7ae
This changes running speed into a running multiplier (of walk speed). The advantage is that it simplifies code since you can setup a default run multiplier at the template level and it'll work for all subsequent templates, and technologies cannot forget to change it. It makes specialised unit templates easier to maintain, too. Formations have a 100 run multiplier which effectively sets their maximal walking speed at 100 Reviewed By: bb, O2 JS Simulation Differential Revision: https://code.wildfiregames.com/D438 This was SVN commit r22197.
154 lines
5 KiB
C++
154 lines
5 KiB
C++
/* Copyright (C) 2019 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. 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, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. 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 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef INCLUDED_ICMPUNITMOTION
|
|
#define INCLUDED_ICMPUNITMOTION
|
|
|
|
#include "simulation2/system/Interface.h"
|
|
|
|
#include "simulation2/components/ICmpPathfinder.h" // for pass_class_t
|
|
#include "simulation2/components/ICmpPosition.h" // for entity_pos_t
|
|
|
|
/**
|
|
* Motion interface for entities with complex movement capabilities.
|
|
* (Simpler motion is handled by ICmpMotion instead.)
|
|
*
|
|
* It should eventually support different movement speeds, moving to areas
|
|
* instead of points, moving as part of a group, moving as part of a formation,
|
|
* etc.
|
|
*/
|
|
class ICmpUnitMotion : public IComponent
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Attempt to walk into range of a to a given point, or as close as possible.
|
|
* The range is measured from the center of the unit.
|
|
* If the unit is already in range, or cannot move anywhere at all, or if there is
|
|
* some other error, then returns false.
|
|
* Otherwise, returns true and sends a MotionChanged message after starting to move,
|
|
* and sends another MotionChanged after finishing moving.
|
|
* If maxRange is negative, then the maximum range is treated as infinity.
|
|
*/
|
|
virtual bool MoveToPointRange(entity_pos_t x, entity_pos_t z, entity_pos_t minRange, entity_pos_t maxRange) = 0;
|
|
|
|
/**
|
|
* Determine wether the givven point is within the given range, using the same measurement
|
|
* as MoveToPointRange.
|
|
*/
|
|
virtual bool IsInPointRange(entity_pos_t x, entity_pos_t z, entity_pos_t minRange, entity_pos_t maxRange) const = 0;
|
|
|
|
/**
|
|
* Determine whether the target is within the given range, using the same measurement
|
|
* as MoveToTargetRange.
|
|
*/
|
|
virtual bool IsInTargetRange(entity_id_t target, entity_pos_t minRange, entity_pos_t maxRange) const = 0;
|
|
|
|
/**
|
|
* Attempt to walk into range of a given target entity, or as close as possible.
|
|
* The range is measured between approximately the edges of the unit and the target, so that
|
|
* maxRange=0 is not unreachably close to the target.
|
|
* If the unit is already in range, or cannot move anywhere at all, or if there is
|
|
* some other error, then returns false.
|
|
* Otherwise, returns true and sends a MotionChanged message after starting to move,
|
|
* and sends another MotionChanged after finishing moving.
|
|
* If maxRange is negative, then the maximum range is treated as infinity.
|
|
*/
|
|
virtual bool MoveToTargetRange(entity_id_t target, entity_pos_t minRange, entity_pos_t maxRange) = 0;
|
|
|
|
/**
|
|
* Join a formation, and move towards a given offset relative to the formation controller entity.
|
|
* Continues following the formation until given a different command.
|
|
*/
|
|
virtual void MoveToFormationOffset(entity_id_t target, entity_pos_t x, entity_pos_t z) = 0;
|
|
|
|
/**
|
|
* Turn to look towards the given point.
|
|
*/
|
|
virtual void FaceTowardsPoint(entity_pos_t x, entity_pos_t z) = 0;
|
|
|
|
/**
|
|
* Stop moving immediately.
|
|
*/
|
|
virtual void StopMoving() = 0;
|
|
|
|
/**
|
|
* Get the current movement speed.
|
|
*/
|
|
virtual fixed GetCurrentSpeed() const = 0;
|
|
|
|
/**
|
|
* Get whether the unit is moving.
|
|
*/
|
|
virtual bool IsMoving() const = 0;
|
|
|
|
/**
|
|
* Get how much faster/slower we are than normal.
|
|
*/
|
|
virtual fixed GetSpeedRatio() const = 0;
|
|
|
|
/**
|
|
* Get how much faster than our regular speed we can go.
|
|
*/
|
|
virtual fixed GetRunSpeedMultiplier() const = 0;
|
|
|
|
/**
|
|
* Set the current movement speed.
|
|
* @param speed A ratio of GetWalkSpeed().
|
|
*/
|
|
virtual void SetSpeedRatio(fixed ratio) = 0;
|
|
|
|
/**
|
|
* Get the unit theoretical speed in metres per second.
|
|
* This is affected by SetSpeedRatio.
|
|
*/
|
|
virtual fixed GetSpeed() const = 0;
|
|
|
|
/**
|
|
* Get the unit "raw"/template walk speed after technologies.
|
|
* Calls to SetSpeedRatio have no effect on this (as that affects actual speed, not template).
|
|
*/
|
|
virtual fixed GetWalkSpeed() const = 0;
|
|
/**
|
|
* Set whether the unit will turn to face the target point after finishing moving.
|
|
*/
|
|
virtual void SetFacePointAfterMove(bool facePointAfterMove) = 0;
|
|
|
|
/**
|
|
* Get the unit's passability class.
|
|
*/
|
|
virtual pass_class_t GetPassabilityClass() const = 0;
|
|
|
|
/**
|
|
* Get the passability class name (as defined in pathfinder.xml)
|
|
*/
|
|
virtual std::string GetPassabilityClassName() const = 0;
|
|
|
|
/**
|
|
* Get the unit clearance (used by the Obstruction component)
|
|
*/
|
|
virtual entity_pos_t GetUnitClearance() const = 0;
|
|
|
|
/**
|
|
* Toggle the rendering of debug info.
|
|
*/
|
|
virtual void SetDebugOverlay(bool enabled) = 0;
|
|
|
|
DECLARE_INTERFACE_TYPE(UnitMotion)
|
|
};
|
|
|
|
#endif // INCLUDED_ICMPUNITMOTION
|