关于UE4的Commandlet,我并没有找到官方文档专门介绍这个功能。不过他的基本功能还是比较直观的:可以通过控制台直接调用一些命令,而这些命令是可以自己定制的。调用的格式是:
[UE4Editor-Cmd.exe路径] [uproject路径] -run=[Commandlet名字] -这条Commandlet的参数
现在我想尝试使用一下这个功能。
观察
首先,UCommandlet
是一个继承自UObject
的类。引擎源代码中存在了它的一些子类,不过并不是很多:
在UCommandlet的定义中,有一个main函数,是作为命令的入口
/**
* Entry point for your commandlet
*
* @param Params the string containing the parameters for the commandlet
*/
virtual int32 Main(const FString& Params) { return 0; }
尝试使用
我从目前这些为数不多的命令中,挑选了一个UTextAssetCommandlet
作为尝试的目标。根据描述,它的功能大概是将Asset转换为文本格式( Commandlet for saving assets in text asset format)。
在TextAssetCommandlet.cpp
可以找到关于参数的信息:
FParse::Value(*InCommandLine, TEXT("mode="), ModeString);
FParse::Value(*InCommandLine, TEXT("filename="), Filename);
FParse::Value(*InCommandLine, TEXT("filter="), FilenameFilter);
FParse::Value(*InCommandLine, TEXT("csv="), Args.CSVFilename);
FParse::Value(*InCommandLine, TEXT("outputpath="), Args.OutputPath);
大概观察代码后发现,filename
指定了Asset的路径(相对于Content目录)。
此外还观察发现,它对于关卡资源也可以处理,因此我决定新建一个关卡,作为目标。关卡的路径为/Content/testFoldertestMap.umap
。
之后我便运行命令:
"D:/Epic Games/UE_4.24/Engine/Binaries/Win64/UE4Editor-Cmd.exe" D:/0_WorkSpace/UE4/test1/test1.uproject -run=TextAsset filename=testFolder/testMap
尝试创建一个Commandlet
创建的步骤很简单,只要在代码中继承一个UCommandlet
类就可以。
这里创建一个空的Commandlet,最终执行命令时会输出一个 Hello Yaksue!
YaksueTestCommandlet.h
:
#pragma once
#include "Commandlets/Commandlet.h"
#include "YaksueTestCommandlet.generated.h"
UCLASS()
class UYaksueTestCommandlet: public UCommandlet
{
GENERATED_BODY()
public:
UYaksueTestCommandlet();
public:
virtual int32 Main(const FString& Params) override;
};
YaksueTestCommandlet.cpp
:
#include "YaksueTestCommandlet.h"
DEFINE_LOG_CATEGORY_STATIC(TestLog, Log, All);
UYaksueTestCommandlet::UYaksueTestCommandlet()
{
LogToConsole = true;
}
int32 UYaksueTestCommandlet::Main(const FString& Params)
{
UE_LOG(TestLog, Display, TEXT("Hello Yaksue!"));
return 0;
}
我将这两个文件放到了项目的代码目录中。之后编译。
然后,就可以调用这个命令了:
"D:/Epic Games/UE_4.24/Engine/Binaries/Win64/UE4Editor-Cmd.exe" D:/0_WorkSpace/UE4/test2/test2.uproject -run=YaksueTest
最后在控制台输出了 Hello Yaksue!