RegisterConsoleCommandHandler

RegisterConsoleCommandHandler

每当在 UE 控制台中输入指定的自定义命令时,RegisterConsoleCommandHandler 都会执行传入的 Lua 函数。

参数

# 类型 说明
1 string 自定义命令的名称
2 function 在 UE 控制台中输入自定义命令时要执行的回调

回调参数

# 类型 说明
1 string 完整命令字符串
2 table 包含参数的表(不含命令名称)
3 FOutputDevice 要写入的输出设备

回调返回值

# 类型 说明
1 bool 是否阻止其他处理器处理此命令

示例

RegisterConsoleCommandHandler("CommandExample", function(FullCommand, Parameters, OutputDevice)
    print("RegisterConsoleCommandHandler:\n")

    print(string.format("Command: %s\n", FullCommand))
    print(string.format("Number of parameters: %i\n", #Parameters))
    
    for ParameterNumber, Parameter in ipairs(Parameters) do
        print(string.format("Parameter #%i -> '%s'\n", ParameterNumber, Parameter))
    end

    OutputDevice:Log("Write something to game console")

    return false
end)

-- Entered into console: CommandExample param1 "param 2" 3
-- Output
--[[
RegisterConsoleCommandHandler:
Command: CommandExample param1 "param 2" 3
Number of parameters: 3
Parameter #1 -> 'param1'
Parameter #2 -> 'param 2'
Parameter #3 -> '3'
--]]

原文:docs/lua-api/global-functions/registerconsolecommandhandler.md · 固定提交 560411f18512 · 来源与 MIT 许可