Initial commit: OpenRA game engine
Fork from OpenRA/OpenRA with one-click launch script (start-ra.cmd) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
let5sne.win10
@@ -0,0 +1,210 @@
|
||||
#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 System.Linq;
|
||||
using OpenRA;
|
||||
using OpenRA.Scripting;
|
||||
|
||||
namespace OpenRA.Mods.Common.UtilityCommands.Documentation
|
||||
{
|
||||
sealed class ExtractLuaDocsCommand : IUtilityCommand
|
||||
{
|
||||
string IUtilityCommand.Name => "--lua-docs";
|
||||
|
||||
bool IUtilityCommand.ValidateArguments(string[] args)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
[Desc("Generate Lua API documentation in MarkDown format.")]
|
||||
void IUtilityCommand.Run(Utility utility, string[] args)
|
||||
{
|
||||
// HACK: The engine code assumes that Game.modData is set.
|
||||
Game.ModData = utility.ModData;
|
||||
|
||||
var version = utility.ModData.Manifest.Metadata.Version;
|
||||
if (args.Length > 1)
|
||||
version = args[1];
|
||||
|
||||
Console.WriteLine("This is an automatically generated listing of the Lua map scripting API for version {0} of OpenRA.", version);
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("OpenRA allows custom maps and missions to be scripted using Lua 5.1.");
|
||||
Console.WriteLine("These scripts run in a sandbox that prevents access to unsafe functions (e.g. OS or file access), " +
|
||||
"and limits the memory and CPU usage of the scripts.");
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("You can access this interface by adding the [LuaScript](../traits/#luascript) trait to the world actor in your map rules " +
|
||||
"(note, you must replace the spaces in the snippet below with a single tab for each level of indentation):");
|
||||
Console.WriteLine("```\nRules:\n\tWorld:\n\t\tLuaScript:\n\t\t\tScripts: myscript.lua\n```");
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("Map scripts can interact with the game engine in three ways:");
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("* Global tables provide functions for interacting with the global world state, or performing general helper tasks.");
|
||||
Console.WriteLine("They exist in the global namespace, and can be called directly using ```<table name>.<function name>```.");
|
||||
Console.WriteLine("* Individual actors expose a collection of properties and commands that query information or modify their state.");
|
||||
Console.WriteLine(" * Some commands, marked as <em>queued activity</em>, are asynchronous. Activities are queued on the actor, and will run in " +
|
||||
"sequence until the queue is empty or the Stop command is called. Actors that are not performing an activity are Idle " +
|
||||
"(actor.IsIdle will return true). The properties and commands available on each actor depends on the traits that the actor " +
|
||||
"specifies in its rule definitions.");
|
||||
Console.WriteLine("* Individual players expose a collection of properties and commands that query information or modify their state.");
|
||||
Console.WriteLine("The properties and commands available on each actor depends on the traits that the actor specifies in its rule definitions.");
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("For a basic guide about map scripts see the [`Map Scripting` wiki page](https://github.com/OpenRA/OpenRA/wiki/Map-scripting).");
|
||||
Console.WriteLine();
|
||||
|
||||
var tables = utility.ModData.ObjectCreator.GetTypesImplementing<ScriptGlobal>()
|
||||
.OrderBy(t => t.Name);
|
||||
|
||||
Console.WriteLine("## Global Tables");
|
||||
|
||||
foreach (var t in tables)
|
||||
{
|
||||
var name = Utility.GetCustomAttributes<ScriptGlobalAttribute>(t, true).First().Name;
|
||||
var members = ScriptMemberWrapper.WrappableMembers(t);
|
||||
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("### " + name);
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("| Function | Description |");
|
||||
Console.WriteLine("|---------:|-------------|");
|
||||
|
||||
foreach (var m in members.OrderBy(m => m.Name))
|
||||
{
|
||||
var memberString = m.LuaDocString();
|
||||
var desc = Utility.HasAttribute<DescAttribute>(m) ? Utility.GetCustomAttributes<DescAttribute>(m, true).First().Lines.JoinWith("<br />") : "";
|
||||
if (Utility.HasAttribute<ObsoleteAttribute>(m))
|
||||
{
|
||||
memberString = $"<s>{memberString}</s>";
|
||||
desc += $"<br />**Deprecated: {Utility.GetCustomAttributes<ObsoleteAttribute>(m, true).First().Message}**";
|
||||
}
|
||||
|
||||
Console.WriteLine($"| **{memberString}** | {desc} |");
|
||||
}
|
||||
}
|
||||
|
||||
Console.WriteLine();
|
||||
|
||||
Console.WriteLine("## Actor Properties / Commands");
|
||||
|
||||
var actorCategories = utility.ModData.ObjectCreator.GetTypesImplementing<ScriptActorProperties>().SelectMany(cg =>
|
||||
{
|
||||
var catAttr = Utility.GetCustomAttributes<ScriptPropertyGroupAttribute>(cg, false).FirstOrDefault();
|
||||
var category = catAttr != null ? catAttr.Category : "Unsorted";
|
||||
|
||||
var required = ScriptMemberWrapper.RequiredTraitNames(cg);
|
||||
return ScriptMemberWrapper.WrappableMembers(cg).Select(mi => (category, mi, required));
|
||||
}).GroupBy(g => g.category).OrderBy(g => g.Key);
|
||||
|
||||
foreach (var kv in actorCategories)
|
||||
{
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("### " + kv.Key);
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("| Function | Description |");
|
||||
Console.WriteLine("|---------:|-------------|");
|
||||
|
||||
foreach (var property in kv.OrderBy(p => p.mi.Name))
|
||||
{
|
||||
var mi = property.mi;
|
||||
var memberString = mi.LuaDocString();
|
||||
var required = property.required;
|
||||
var hasDesc = Utility.HasAttribute<DescAttribute>(mi);
|
||||
var hasRequires = required.Length > 0;
|
||||
var isActivity = Utility.HasAttribute<ScriptActorPropertyActivityAttribute>(mi);
|
||||
var isDeprecated = Utility.HasAttribute<ObsoleteAttribute>(mi);
|
||||
|
||||
if (isDeprecated)
|
||||
Console.Write($"| **<s>{memberString}</s>**");
|
||||
else
|
||||
Console.Write($"| **{memberString}**");
|
||||
|
||||
if (isActivity)
|
||||
Console.Write("<br />*Queued Activity*");
|
||||
|
||||
Console.Write(" | ");
|
||||
|
||||
if (hasDesc)
|
||||
Console.Write(Utility.GetCustomAttributes<DescAttribute>(mi, false).First().Lines.JoinWith("<br />"));
|
||||
|
||||
if (hasDesc && hasRequires)
|
||||
Console.Write("<br />");
|
||||
|
||||
if (hasRequires)
|
||||
Console.Write($"**Requires {(required.Length == 1 ? "Trait" : "Traits")}:** {required.JoinWith(", ")}");
|
||||
|
||||
if (isDeprecated)
|
||||
Console.Write($"**Deprecated: {Utility.GetCustomAttributes<ObsoleteAttribute>(mi, true).First().Message}**");
|
||||
|
||||
Console.WriteLine(" |");
|
||||
}
|
||||
}
|
||||
|
||||
Console.WriteLine();
|
||||
|
||||
Console.WriteLine("## Player Properties / Commands");
|
||||
|
||||
var playerCategories = utility.ModData.ObjectCreator.GetTypesImplementing<ScriptPlayerProperties>().SelectMany(cg =>
|
||||
{
|
||||
var catAttr = Utility.GetCustomAttributes<ScriptPropertyGroupAttribute>(cg, false).FirstOrDefault();
|
||||
var category = catAttr != null ? catAttr.Category : "Unsorted";
|
||||
|
||||
var required = ScriptMemberWrapper.RequiredTraitNames(cg);
|
||||
return ScriptMemberWrapper.WrappableMembers(cg).Select(mi => (category, mi, required));
|
||||
}).GroupBy(g => g.category).OrderBy(g => g.Key);
|
||||
|
||||
foreach (var kv in playerCategories)
|
||||
{
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("### " + kv.Key);
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("| Function | Description |");
|
||||
Console.WriteLine("|---------:|-------------|");
|
||||
|
||||
foreach (var property in kv.OrderBy(p => p.mi.Name))
|
||||
{
|
||||
var mi = property.mi;
|
||||
var memberString = mi.LuaDocString();
|
||||
var required = property.required;
|
||||
var hasDesc = Utility.HasAttribute<DescAttribute>(mi);
|
||||
var hasRequires = required.Length > 0;
|
||||
var isActivity = Utility.HasAttribute<ScriptActorPropertyActivityAttribute>(mi);
|
||||
var isDeprecated = Utility.HasAttribute<ObsoleteAttribute>(mi);
|
||||
|
||||
if (isDeprecated)
|
||||
Console.Write($"| **<s>{memberString}</s>**");
|
||||
else
|
||||
Console.Write($"| **{memberString}**");
|
||||
|
||||
if (isActivity)
|
||||
Console.Write("<br />*Queued Activity*");
|
||||
|
||||
Console.Write(" | ");
|
||||
|
||||
if (hasDesc)
|
||||
Console.Write(Utility.GetCustomAttributes<DescAttribute>(mi, false).First().Lines.JoinWith("<br />"));
|
||||
|
||||
if (hasDesc && hasRequires)
|
||||
Console.Write("<br />");
|
||||
|
||||
if (hasRequires)
|
||||
Console.Write($"**Requires {(required.Length == 1 ? "Trait" : "Traits")}:** {required.JoinWith(", ")}");
|
||||
|
||||
if (isDeprecated)
|
||||
Console.Write($"**Deprecated: {Utility.GetCustomAttributes<ObsoleteAttribute>(mi, true).First().Message}**");
|
||||
|
||||
Console.WriteLine(" |");
|
||||
}
|
||||
|
||||
Console.WriteLine();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user