Files
@ r26799:826b1c52a903
Branch filter:
Location: cpp/openttd-patchpack/source/src/script/api/script_group.cpp - annotation
r26799:826b1c52a903
8.2 KiB
text/x-c
Fix: no ScriptEvent sub class should export constructors to scripts
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18515:6bcd41f64d33 r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r23384:32564d89d33c r26105:23588534dec9 r26105:23588534dec9 r26105:23588534dec9 r18500:14a481bc4437 r18500:14a481bc4437 r21383:942c32fb8b0e r21383:942c32fb8b0e r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r23607:36c15679007d r18500:14a481bc4437 r18500:14a481bc4437 r23387:5159426b3723 r18500:14a481bc4437 r26115:02430a86c873 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r26115:02430a86c873 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18778:4848b0595531 r18500:14a481bc4437 r18778:4848b0595531 r18778:4848b0595531 r18500:14a481bc4437 r23607:36c15679007d r20473:7d7140ae0710 r20025:983c2ed8d329 r18778:4848b0595531 r18500:14a481bc4437 r26115:02430a86c873 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r23607:36c15679007d r18500:14a481bc4437 r18500:14a481bc4437 r18917:144687613228 r18500:14a481bc4437 r18500:14a481bc4437 r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r26115:02430a86c873 r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r23383:0b1bc007be6a r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r26115:02430a86c873 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r25224:92a124f03ad6 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18774:2977cce7e239 r18500:14a481bc4437 r18500:14a481bc4437 r25879:24d05d83ae3e r25879:24d05d83ae3e r25879:24d05d83ae3e r25879:24d05d83ae3e r25879:24d05d83ae3e r25879:24d05d83ae3e r25879:24d05d83ae3e r25879:24d05d83ae3e r25879:24d05d83ae3e r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r26115:02430a86c873 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r26120:15c912177c88 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18774:2977cce7e239 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r26115:02430a86c873 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r18774:2977cce7e239 r18500:14a481bc4437 r18500:14a481bc4437 r18501:8e3d905ea4bc r18500:14a481bc4437 r18500:14a481bc4437 r18500:14a481bc4437 r26115:02430a86c873 r18500:14a481bc4437 r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23966:9de0a0960701 r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23384:32564d89d33c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23966:9de0a0960701 r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23386:91324a9ce27c r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r26115:02430a86c873 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r26115:02430a86c873 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 r23419:6b552b72acc7 | /*
* This file is part of OpenTTD.
* OpenTTD 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 2.
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file script_group.cpp Implementation of ScriptGroup. */
#include "../../stdafx.h"
#include "script_group.hpp"
#include "script_engine.hpp"
#include "../script_instance.hpp"
#include "../../string_func.h"
#include "../../strings_func.h"
#include "../../autoreplace_func.h"
#include "../../settings_func.h"
#include "../../vehicle_base.h"
#include "../../autoreplace_cmd.h"
#include "../../group_cmd.h"
#include "../../settings_cmd.h"
#include "table/strings.h"
#include "../../safeguards.h"
/* static */ bool ScriptGroup::IsValidGroup(GroupID group_id)
{
const Group *g = ::Group::GetIfValid(group_id);
return g != nullptr && g->owner == ScriptObject::GetCompany();
}
/* static */ ScriptGroup::GroupID ScriptGroup::CreateGroup(ScriptVehicle::VehicleType vehicle_type, GroupID parent_group_id)
{
if (!ScriptObject::Command<CMD_CREATE_GROUP>::Do(&ScriptInstance::DoCommandReturnGroupID, (::VehicleType)vehicle_type, parent_group_id)) return GROUP_INVALID;
/* In case of test-mode, we return GroupID 0 */
return (ScriptGroup::GroupID)0;
}
/* static */ bool ScriptGroup::DeleteGroup(GroupID group_id)
{
EnforcePrecondition(false, IsValidGroup(group_id));
return ScriptObject::Command<CMD_DELETE_GROUP>::Do(group_id);
}
/* static */ ScriptVehicle::VehicleType ScriptGroup::GetVehicleType(GroupID group_id)
{
if (!IsValidGroup(group_id)) return ScriptVehicle::VT_INVALID;
return (ScriptVehicle::VehicleType)((::VehicleType)::Group::Get(group_id)->vehicle_type);
}
/* static */ bool ScriptGroup::SetName(GroupID group_id, Text *name)
{
CCountedPtr<Text> counter(name);
EnforcePrecondition(false, IsValidGroup(group_id));
EnforcePrecondition(false, name != nullptr);
const char *text = name->GetDecodedText();
EnforcePreconditionEncodedText(false, text);
EnforcePreconditionCustomError(false, ::Utf8StringLength(text) < MAX_LENGTH_GROUP_NAME_CHARS, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG);
return ScriptObject::Command<CMD_ALTER_GROUP>::Do(AlterGroupMode::Rename, group_id, 0, text);
}
/* static */ char *ScriptGroup::GetName(GroupID group_id)
{
if (!IsValidGroup(group_id)) return nullptr;
::SetDParam(0, group_id);
return GetString(STR_GROUP_NAME);
}
/* static */ bool ScriptGroup::SetParent(GroupID group_id, GroupID parent_group_id)
{
EnforcePrecondition(false, IsValidGroup(group_id));
EnforcePrecondition(false, IsValidGroup(parent_group_id));
return ScriptObject::Command<CMD_ALTER_GROUP>::Do(AlterGroupMode::SetParent, group_id, parent_group_id, {});
}
/* static */ ScriptGroup::GroupID ScriptGroup::GetParent(GroupID group_id)
{
EnforcePrecondition((ScriptGroup::GroupID)INVALID_GROUP, IsValidGroup(group_id));
const Group *g = ::Group::GetIfValid(group_id);
return (ScriptGroup::GroupID)g->parent;
}
/* static */ bool ScriptGroup::EnableAutoReplaceProtection(GroupID group_id, bool enable)
{
EnforcePrecondition(false, IsValidGroup(group_id));
return ScriptObject::Command<CMD_SET_GROUP_FLAG>::Do(group_id, GroupFlags::GF_REPLACE_PROTECTION, enable, false);
}
/* static */ bool ScriptGroup::GetAutoReplaceProtection(GroupID group_id)
{
if (!IsValidGroup(group_id)) return false;
return HasBit(::Group::Get(group_id)->flags, GroupFlags::GF_REPLACE_PROTECTION);
}
/* static */ int32 ScriptGroup::GetNumEngines(GroupID group_id, EngineID engine_id)
{
if (!IsValidGroup(group_id) && group_id != GROUP_DEFAULT && group_id != GROUP_ALL) return -1;
return GetGroupNumEngines(ScriptObject::GetCompany(), group_id, engine_id);
}
/* static */ int32 ScriptGroup::GetNumVehicles(GroupID group_id, ScriptVehicle::VehicleType vehicle_type)
{
bool valid_group = IsValidGroup(group_id);
if (!valid_group && group_id != GROUP_DEFAULT && group_id != GROUP_ALL) return -1;
if (!valid_group && (vehicle_type < ScriptVehicle::VT_RAIL || vehicle_type > ScriptVehicle::VT_AIR)) return -1;
return GetGroupNumVehicle(ScriptObject::GetCompany(), group_id, valid_group ? ::Group::Get(group_id)->vehicle_type : (::VehicleType)vehicle_type);
}
/* static */ bool ScriptGroup::MoveVehicle(GroupID group_id, VehicleID vehicle_id)
{
EnforcePrecondition(false, IsValidGroup(group_id) || group_id == GROUP_DEFAULT);
EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
return ScriptObject::Command<CMD_ADD_VEHICLE_GROUP>::Do(group_id, vehicle_id, false);
}
/* static */ bool ScriptGroup::EnableWagonRemoval(bool enable_removal)
{
if (HasWagonRemoval() == enable_removal) return true;
return ScriptObject::Command<CMD_CHANGE_COMPANY_SETTING>::Do("company.renew_keep_length", enable_removal ? 1 : 0);
}
/* static */ bool ScriptGroup::HasWagonRemoval()
{
return ::Company::Get(ScriptObject::GetCompany())->settings.renew_keep_length;
}
/* static */ bool ScriptGroup::SetAutoReplace(GroupID group_id, EngineID engine_id_old, EngineID engine_id_new)
{
EnforcePrecondition(false, IsValidGroup(group_id) || group_id == GROUP_DEFAULT || group_id == GROUP_ALL);
EnforcePrecondition(false, ScriptEngine::IsBuildable(engine_id_new));
return ScriptObject::Command<CMD_SET_AUTOREPLACE>::Do(group_id, engine_id_old, engine_id_new, false);
}
/* static */ EngineID ScriptGroup::GetEngineReplacement(GroupID group_id, EngineID engine_id)
{
if (!IsValidGroup(group_id) && group_id != GROUP_DEFAULT && group_id != GROUP_ALL) return ::INVALID_ENGINE;
return ::EngineReplacementForCompany(Company::Get(ScriptObject::GetCompany()), engine_id, group_id);
}
/* static */ bool ScriptGroup::StopAutoReplace(GroupID group_id, EngineID engine_id)
{
EnforcePrecondition(false, IsValidGroup(group_id) || group_id == GROUP_DEFAULT || group_id == GROUP_ALL);
return ScriptObject::Command<CMD_SET_AUTOREPLACE>::Do(group_id, engine_id, ::INVALID_ENGINE, false);
}
/* static */ Money ScriptGroup::GetProfitThisYear(GroupID group_id)
{
if (!IsValidGroup(group_id)) return -1;
Money profit = 0;
for (const Vehicle *v : Vehicle::Iterate()) {
if (v->group_id != group_id) continue;
if (!v->IsPrimaryVehicle()) continue;
profit += v->GetDisplayProfitThisYear();
}
return profit;
}
/* static */ Money ScriptGroup::GetProfitLastYear(GroupID group_id)
{
if (!IsValidGroup(group_id)) return -1;
return ::Group::Get(group_id)->statistics.profit_last_year;
}
/* static */ uint32 ScriptGroup::GetCurrentUsage(GroupID group_id)
{
if (!IsValidGroup(group_id)) return -1;
uint32 occupancy = 0;
uint32 vehicle_count = 0;
for (const Vehicle *v : Vehicle::Iterate()) {
if (v->group_id != group_id) continue;
if (!v->IsPrimaryVehicle()) continue;
occupancy += v->trip_occupancy;
vehicle_count++;
}
if (vehicle_count == 0) return -1;
return occupancy / vehicle_count;
}
/* static */ bool ScriptGroup::SetPrimaryColour(GroupID group_id, ScriptCompany::Colours colour)
{
EnforcePrecondition(false, IsValidGroup(group_id));
return ScriptObject::Command<CMD_SET_GROUP_LIVERY>::Do(group_id, true, (::Colours)colour);
}
/* static */ bool ScriptGroup::SetSecondaryColour(GroupID group_id, ScriptCompany::Colours colour)
{
EnforcePrecondition(false, IsValidGroup(group_id));
return ScriptObject::Command<CMD_SET_GROUP_LIVERY>::Do(group_id, false, (::Colours)colour);
}
/* static */ ScriptCompany::Colours ScriptGroup::GetPrimaryColour(GroupID group_id)
{
EnforcePrecondition(ScriptCompany::Colours::COLOUR_INVALID, IsValidGroup(group_id));
const Group *g = ::Group::GetIfValid(group_id);
if (!HasBit(g->livery.in_use, 0)) return ScriptCompany::Colours::COLOUR_INVALID;
return (ScriptCompany::Colours)g->livery.colour1;
}
/* static */ ScriptCompany::Colours ScriptGroup::GetSecondaryColour(GroupID group_id)
{
EnforcePrecondition(ScriptCompany::Colours::COLOUR_INVALID, IsValidGroup(group_id));
const Group *g = ::Group::GetIfValid(group_id);
if (!HasBit(g->livery.in_use, 1)) return ScriptCompany::Colours::COLOUR_INVALID;
return (ScriptCompany::Colours)g->livery.colour2;
}
|