From e4335b70942157565e86da4d281fefb1bd875079 Mon Sep 17 00:00:00 2001 From: VorTechnix <45538536+VorTechnix@users.noreply.github.com> Date: Thu, 20 Jul 2023 10:46:20 -0700 Subject: [PATCH] added some documentation to register_alias --- worldeditadditions_core/core/register_alias.lua | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/worldeditadditions_core/core/register_alias.lua b/worldeditadditions_core/core/register_alias.lua index 011b70c..fc7be1f 100644 --- a/worldeditadditions_core/core/register_alias.lua +++ b/worldeditadditions_core/core/register_alias.lua @@ -1,6 +1,11 @@ local wea_c = worldeditadditions_core +--- Register an alias for command +-- @param cmdname_target: string - the new alias name +-- @param cmdname_source: string - the source command name +-- @param override: boolean (optional) - whether to override an existing target command +-- @returns: boolean - true if alias registration is successful, false otherwise local function register_alias(cmdname_target, cmdname_source, override) if override == nil then override = false end