Add sanity checks to the Lua script trait.

This commit is contained in:
Matthias Mailänder
2023-06-03 14:14:31 +02:00
committed by Gustas
parent 06df75ffee
commit c31f2abfc9
2 changed files with 44 additions and 0 deletions

View File

@@ -0,0 +1,42 @@
#region Copyright & License Information
/*
* Copyright (c) The OpenRA Developers and Contributors
* This file is part of OpenRA, which is free software. It is made
* available to you under the terms of the GNU General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version. For more
* information, see COPYING.
*/
#endregion
using System;
using OpenRA.FileSystem;
using OpenRA.Mods.Common.Scripting;
using OpenRA.Server;
namespace OpenRA.Mods.Common.Lint
{
public class CheckLuaScript : ILintMapPass, ILintServerMapPass
{
void ILintMapPass.Run(Action<string> emitError, Action<string> emitWarning, ModData modData, Map map)
{
CheckLuaScriptFileExistance(emitError, map.Package, modData.DefaultFileSystem, map.Rules);
}
void ILintServerMapPass.Run(Action<string> emitError, Action<string> emitWarning, ModData modData, MapPreview map, Ruleset mapRules)
{
CheckLuaScriptFileExistance(emitError, map.Package, modData.DefaultFileSystem, mapRules);
}
static void CheckLuaScriptFileExistance(Action<string> emitError, IReadOnlyPackage package, IReadOnlyFileSystem fileSystem, Ruleset mapRules)
{
var luaScriptInfo = mapRules.Actors[SystemActors.World].TraitInfoOrDefault<LuaScriptInfo>();
if (luaScriptInfo == null)
return;
foreach (var script in luaScriptInfo.Scripts)
if (!package.Contains(script) && !fileSystem.Exists(script))
emitError($"Lua script `{script}` does not exist.");
}
}
}

View File

@@ -18,9 +18,11 @@ using OpenRA.Traits;
namespace OpenRA.Mods.Common.Scripting namespace OpenRA.Mods.Common.Scripting
{ {
[TraitLocation(SystemActors.World)]
[Desc("Part of the new Lua API.")] [Desc("Part of the new Lua API.")]
public class LuaScriptInfo : TraitInfo, Requires<SpawnMapActorsInfo> public class LuaScriptInfo : TraitInfo, Requires<SpawnMapActorsInfo>
{ {
[Desc("File names with location relative to the map.")]
public readonly HashSet<string> Scripts = new(); public readonly HashSet<string> Scripts = new();
public override object Create(ActorInitializer init) { return new LuaScript(this); } public override object Create(ActorInitializer init) { return new LuaScript(this); }