工坊手册

主题

EggyController ​

概览 ​

字段值
KindUnit · 单位 Unit
Realmcommon

继承关系 ​

  • Unit（4 属性 / 25 函数 / 6 事件）
    • BaseController（12 属性 / 22 函数 / 11 事件）
      • [EggyController]（7 属性 / 4 函数 / 4 事件）

继承成员 ​

2 个来源 / 16 属性 / 47 函数 / 17 事件

EggyController 是 EggyUnit 的控制器组件，通过 EggyUnit.Controller 属性获取，用于触发前扑、翻滚、抓举和投掷等蛋仔角色动作。

适用场景 ​

当脚本需要控制当前玩家角色或场景中的 EggyUnit 执行动作时，先取得该 EggyUnit 的 Controller，再调用 Rush/Fling/Lift/Throw 等接口。

使用要点 ​

通过 .Controller 属性取得控制器。Lift 的 force_lift_unit 在最新 Meta 中为可选参数：省略时尝试抓举身前目标；需要强制指定目标时，传入已经存在的 EggyUnit 实例。当前运行包即使抓举成功也可能不触发 OnLiftBegin，不要把该事件作为成功判据。

注意事项 ​

EggyController 通过 EggyUnit.Controller 属性获取。Lift 可省略 force_lift_unit；若传入，该值必须是场景中已存在的 EggyUnit 实例。当前运行包实测 Lift 成功时 OnLiftBegin 仍可能不触发；在运行时事件实现与 Meta 对齐前，不要依赖 OnLiftBegin 驱动抓举后的关键业务逻辑。

代码示例 ​

从 EggyUnit.Controller 获取控制器并执行动作 ​

lua
-- @runtime client
-- EggyController 通过 EggyUnit.Controller 属性获取
local Players = game:GetService("Players")
local localPlayer = Players.LocalPlayer
if localPlayer and localPlayer.Character then
    local eggyUnit = localPlayer.Character
    local controller = eggyUnit.Controller  -- 通过 Controller 属性获取
    if controller ~= nil then
        -- 执行前扑动作
        controller:Rush()
        print('EggyController 已触发 Rush')
    end
end

属性 (7) ​

Name类型默认值说明
LiftedEnabledBooltrue布尔属性，表示该控制器所属单位当前是否允许被其他单位抓举。
RollCDTimeFloat0.1浮点属性，表示滚动能力的冷却时间，即两次滚动之间的间隔时长。
RollTimeFloat3.5浮点属性，表示一次滚动的持续时长。
RollChargeTimeFloat15.0浮点属性，表示滚动充能时长。
RollSpeedFloat13.0浮点属性，表示滚动的速度。
ClimbEnabledBoolfalse布尔属性，表示该控制器所属单位是否开启攀爬能力。
ClimbSpeedFloat3.0浮点属性，表示攀爬速度。

关联类型 ​

事件 (4) ​

OnLiftBegin ​

签名：OnLiftBegin(liftedUnit: SpaceUnit) 触发：local

控制器所属单位开始抓举其他单位时触发；回调参数 liftedUnit 是被抓举的 SpaceUnit。

⚙ 最新 Meta 已声明 OnLiftBegin；当前运行包实测调用 Lift 成功抓举目标时仍可能不触发。在运行时事件实现与 Meta 对齐前，该事件只能作为辅助观察信号，不能作为抓举成功判据或关键业务逻辑的唯一入口。

回调参数类型说明
liftedUnitSpaceUnit举起的单位

示例代码

当前版本的事件可用性说明

lua
-- @runtime client
print('当前运行包可能不触发 OnLiftBegin，请勿依赖该事件驱动关键逻辑')

OnLiftEnd ​

签名：OnLiftEnd() 触发：local

本地事件，当该控制器所属单位结束抓举（例如扔出目标或被中断）时触发。

示例代码

监听抓举结束

lua
-- @runtime client
local Players = game:GetService("Players")
local character = Players.LocalPlayer and Players.LocalPlayer.Character
local controller = character and character.Controller
if controller == nil then return end
controller.OnLiftEnd:Once(function()
    print("抓举已结束")
end)

OnLiftedBegin ​

签名：OnLiftedBegin(liftunit: EggyUnit) 触发：local

控制器所属单位开始被其他生物抓举时触发；回调参数 liftunit 是发起抓举的 EggyUnit。

回调参数类型说明
liftunitEggyUnit举起当前对象的生物

示例代码

监听开始被抓举

lua
-- @runtime client
local Players = game:GetService("Players")
local character = Players.LocalPlayer and Players.LocalPlayer.Character
local controller = character and character.Controller
if controller == nil then return end
controller.OnLiftedBegin:Once(function(liftUnit)
    print("被单位抓举:", liftUnit and liftUnit.Name)
end)

OnLiftedEnd ​

签名：OnLiftedEnd() 触发：local

本地事件，当该控制器所属单位结束被抓举状态时触发。

示例代码

监听结束被抓举

lua
-- @runtime client
local Players = game:GetService("Players")
local character = Players.LocalPlayer and Players.LocalPlayer.Character
local controller = character and character.Controller
if controller == nil then return end
controller.OnLiftedEnd:Once(function()
    print("已结束被抓举状态")
end)

函数 (4) ​

Rush ​

签名：Rush() -> void

执行一次前扑。

返回值 void

示例代码

前扑

lua
-- @runtime client
local Players = game:GetService("Players")
local eggyUnit = Players.LocalPlayer and Players.LocalPlayer.Character
local controller = eggyUnit and eggyUnit.Controller
if controller ~= nil then
    controller:Rush()  -- 执行一次前扑
end

Fling ​

签名：Fling() -> void

执行一次翻滚。

返回值 void

示例代码

翻滚

lua
-- @runtime client
local Players = game:GetService("Players")
local eggyUnit = Players.LocalPlayer and Players.LocalPlayer.Character
local controller = eggyUnit and eggyUnit.Controller
if controller ~= nil then
    controller:Fling()  -- 执行一次翻滚
end

Lift ​

签名：Lift(force_lift_unit?: EggyUnit) -> void

EggyController 的函数，用于尝试抓举身前的目标。它接受一个可选参数 force_lift_unit（类型为 EggyUnit），用于指定被强制抓举的对象；不传入该参数时按默认方式选择身前目标。该函数没有返回值。

⚙ force_lift_unit 是可选参数；省略时尝试抓举身前目标，传入时必须是已存在的 EggyUnit。当前运行包实测抓举成功时 OnLiftBegin 仍可能不触发；Lift 调用与事件回调不能互相作为成功验证。

参数类型说明
force_lift_unit?EggyUnit强制抓举目标

返回值 void

示例代码

抓举目标单位

lua
-- @runtime client
local World = game:GetService("World")
local Players = game:GetService("Players")
local eggyUnit = Players.LocalPlayer and Players.LocalPlayer.Character
local controller = eggyUnit and eggyUnit.Controller
-- force_lift_unit 可省略；这里查找场景中已有目标，避免为演示留下临时单位
local targetEggyUnit = World:FindFirstChild("LiftTarget", true)
if controller ~= nil and targetEggyUnit ~= nil then
    controller:Lift(targetEggyUnit)
    print('已发起抓举；当前版本不要以 OnLiftBegin 是否触发作为成功判据')
end

Throw ​

签名：Throw() -> void

扔出当前抓举的对象。

返回值 void

示例代码

投掷抓举的对象

lua
-- @runtime client
local Players = game:GetService("Players")
local eggyUnit = Players.LocalPlayer and Players.LocalPlayer.Character
local controller = eggyUnit and eggyUnit.Controller
if controller ~= nil then
    controller:Throw()  -- 扔出当前抓举的对象
end