迷你世界 UGC3.0 触发事件 API

一份经过精心分类、重排和美化的交互式文档,助你高效开发!

游戏 (Game)

当地形组的天气改变

TriggerEvent.GroupWeatherChanged

当游戏内某个地形组的天气发生变化时触发。

事件传参:

游戏创建

TriggerEvent.GameStart

当游戏世界成功创建并开始运行时触发,通常在地图加载完成后执行一次。

事件传参:

游戏时间

TriggerEvent.GameHour

当游戏内的时间每经过一个小时(游戏内时间)触发一次。

事件传参:

任意计时器改变

TriggerEvent.MinitimerChange

当任何一个通过脚本或触发器创建的计时器数值发生改变时触发。

事件传参:

配方合成完毕

TriggerEvent.CraftEnd

当玩家或生物在工作台、合成台等地方完成一次物品合成时触发。

参数名说明
eventobjid触发事件的对象ID (通常是玩家)
actorid触发事件的生物类型ID
itemid合成出的道具类型ID
itemnum合成出的道具数量

当熔炼开始

TriggerEvent.FurnaceBegin

当熔炉(或其他熔炼方块)开始进行一次熔炼作业时触发。

参数名说明
x, y, z熔炉方块所在的位置坐标

当熔炼结束

TriggerEvent.FurnaceEnd

当熔炉(或其他熔炼方块)完成一次熔炼作业时触发。

参数名说明
x, y, z熔炉方块所在的位置坐标

玩家 (Player)

玩家复活

TriggerEvent.PlayerRevive

当玩家死亡后复活时触发。

参数名说明
eventobjid复活的玩家对象ID
x, y, z玩家复活的位置坐标

玩家移动

TriggerEvent.PlayerMoveOneBlockSize

当玩家移动了至少一个方块的距离时触发。

参数名说明
eventobjid移动的玩家对象ID
x, y, z玩家当前的位置坐标

当玩家进入游戏

TriggerEvent.GameAnyPlayerEnterGame

当任意一名玩家成功进入游戏世界时触发。

参数名说明
eventobjid进入游戏的玩家对象ID
x, y, z玩家进入游戏时的位置坐标

当玩家离开游戏

TriggerEvent.GameAnyPlayerLeaveGame

当任意一名玩家离开游戏世界时触发。

参数名说明
eventobjid离开游戏的玩家对象ID
x, y, z玩家离开游戏时的位置坐标

当玩家游戏胜利

TriggerEvent.GameAnyPlayerVictory

当任意一名玩家达成游戏胜利条件时触发。

参数名说明
eventobjid达成胜利的玩家对象ID
x, y, z玩家胜利时的位置坐标

当玩家游戏失败

TriggerEvent.GameAnyPlayerDefeat

当任意一名玩家达成游戏失败条件时触发。

参数名说明
eventobjid达成失败的玩家对象ID
x, y, z玩家失败时的位置坐标

当玩家点击任意方块

TriggerEvent.PlayerClickBlock

当玩家用手或物品点击(左键或右键)任意方块时触发。

参数名说明
eventobjid点击的玩家对象ID
x, y, z被点击的方块位置坐标
toobjid被点击的对象ID (此处为方块,但参数保留)
targetactorid被点击的生物类型ID (此处为空)
blockid被点击的方块类型ID

玩家点击实体/对象

这一系列事件在玩家点击不同类型的对象时触发。

  • PlayerClickPlayer: 点击任意玩家
  • PlayerClickMob: 点击任意生物
  • PlayerClickProjectile: 点击任意投掷物
  • PlayerClickDropItem: 点击任意掉落物
  • PlayerClickEntity: 点击任意实体
参数名说明
eventobjid点击的玩家对象ID
x, y, z点击发生的位置坐标 (可能是目标位置)
toobjid被点击的目标对象ID
targetactorid被点击的目标生物类型ID
blockid事件中的方块类型 (若相关)

玩家按键输入

这一系列事件在玩家进行按键操作时触发。

  • PlayerInputKeyClick: 点击按键 (通常用于UI)
  • PlayerInputKeyDown: 按下按键
  • PlayerInputKeyUp: 抬起按键
  • PlayerInputKeyOnPress: 长按按键
参数名说明
eventobjid操作的玩家对象ID
x, y, z玩家的位置坐标
vkey被操作的按键码

玩家发送聊天信息

TriggerEvent.PlayerNewInputContent

当玩家在聊天框输入并发送信息后触发。

参数名说明
eventobjid发送信息的玩家对象ID
x, y, z玩家的位置坐标
content发送的聊天内容字符串

当玩家持枪状态改变时

TriggerEvent.PlayerGunAction

当玩家进行与枪械相关的动作时触发,如开镜、射击、换弹等。

参数名说明
eventobjid操作的玩家对象ID
x, y, z玩家的位置坐标

当玩家运动状态发生改变

TriggerEvent.PlayerMotionStateChange

当玩家的运动状态发生改变时触发,例如开始/停止奔跑、游泳、飞行等。

参数名说明
x, y, z玩家的位置坐标
eventobjid状态改变的玩家对象ID
switchState事件中的开关状态 (具体代表何种状态需测试)

玩家邀请好友

TriggerEvent.PlayerInvateFriend

当玩家在游戏中向好友发送邀请时触发。

参数名说明
eventobjid发起邀请的玩家对象ID
x, y, z玩家的位置坐标
toobjid被邀请的玩家对象ID

玩家快捷栏事件

与玩家快捷栏相关的系列事件。

  • PlayerSelectShortcut: 选中快捷栏中的某一项。
  • PlayerShortcutChange: 快捷栏发生改变(放入或取出)。
  • PlayerShortcutAddItem: 快捷栏放入道具。
  • PlayerShortcutRemItem: 快捷栏取出道具。
参数名说明
eventobjid玩家对象ID
x, y, z玩家位置
itemid相关的道具ID
shortix快捷栏格子索引
itemnum道具数量
itemix装备栏格子索引 (某些情况下)

玩家背包事件

与玩家背包内容变化相关的系列事件。

  • PlayerBackPackChange: 背包发生改变(放入或取出)。
  • PlayerBackPackAddItem: 背包放入道具。
  • PlayerBackPackRemItem: 背包取出道具。
参数名说明
eventobjid玩家对象ID
x, y, z玩家位置
itemid相关的道具ID
shortix快捷栏格子索引 (某些情况下)
itemnum道具数量
itemix装备栏格子索引 (某些情况下)

玩家装备事件

与玩家装备栏和穿脱装备相关的系列事件。

  • PlayerEquipChange: 装备栏发生改变。
  • PlayerEquipAddItem: 装备栏放入道具。
  • PlayerEquipRemItem: 装备栏取出道具。
  • PlayerEquipOn: 穿上装备。
  • PlayerEquipOff: 脱下装备。
参数名说明
eventobjid玩家对象ID
x, y, z玩家位置
itemid相关的道具/装备ID
shortix快捷栏格子索引 (某些情况下)
itemnum道具数量
itemix装备栏格子索引

角色 (Actor)

当任意玩家受到伤害

TriggerEvent.PlayerBeHurt

当任意玩家受到任何来源的伤害时触发。

参数名说明
x, y, z受伤害玩家的位置
eventobjid造成伤害的对象ID (可能是玩家、生物或其他)
toobjid受到伤害的玩家对象ID
actorid造成伤害的生物类型ID (如果来源是生物)

当任意玩家被击败

TriggerEvent.PlayerDie

当任意玩家生命值降为0或以下而被击败时触发。

参数名说明
x, y, z被击败玩家的位置
eventobjid击败者对象ID
toobjid被击败的玩家对象ID
actorid击败者的生物类型ID (如果来源是生物)

当任意生物受到伤害

TriggerEvent.MobBeHurt

当任意生物(非玩家)受到任何来源的伤害时触发。

参数名说明
x, y, z受伤害生物的位置
eventobjid造成伤害的对象ID
toobjid受到伤害的生物对象ID
actorid造成伤害的生物类型ID (如果来源是生物)

当任意生物被击败

TriggerEvent.MobDie

当任意生物(非玩家)生命值降为0或以下而被击败时触发。

参数名说明
x, y, z被击败生物的位置
eventobjid击败者对象ID
toobjid被击败的生物对象ID
actorid击败者的生物类型ID (如果来源是生物)

角色攻击事件

与角色(玩家或生物)发起攻击及命中相关的系列事件。

  • PlayerAttack: 玩家开始攻击。
  • PlayerAttackHit: 玩家攻击命中目标。
  • MobAttack: 生物开始攻击。
  • MobAttackHit: 生物攻击命中目标。
参数名说明
eventobjid攻击方对象ID
x, y, z攻击方位置
toobjid被攻击方对象ID
targetactorid被攻击方生物类型ID
hurtlv造成的伤害值

击败与造成伤害事件

与角色(玩家或生物)成功击败目标或造成伤害相关的系列事件。

  • PlayerDefeatActor: 玩家击败目标。
  • PlayerDamageActor: 玩家对目标造成伤害。
  • MobBeat: 生物击败目标。
  • MobDamage: 生物对目标造成伤害。
参数名说明
eventobjid攻击方对象ID
x, y, z攻击方位置
toobjid被攻击/击败方对象ID
targetactorid被攻击/击败方生物类型ID
hurtlv造成的伤害值

角色状态(Buff)事件

与角色(玩家或生物)获得或失去状态效果相关的系列事件。

  • PlayerAddBuff: 玩家获得状态。
  • PlayerRemoveBuff: 玩家失去状态。
  • MobAddBuff: 生物获得状态。
  • MobRemoveBuff: 生物失去状态。
参数名说明
x, y, z角色位置
buffid相关的状态效果ID
eventobjid获得/失去状态的角色对象ID

角色属性改变事件

当角色(玩家或生物)的属性(如最大生命、攻击力等)发生变化时触发。

  • PlayerChangeAttr: 玩家属性改变。
  • MobChangeAttr: 生物属性改变。
参数名说明
eventobjid属性改变的角色对象ID
x, y, z角色位置

角色权限状态改变事件

当角色(玩家或生物)的某些权限状态发生改变时触发,例如是否能飞、是否无敌等。

  • PlayerAttrStateChange: 玩家权限改变。
  • MobAttrStateChange: 生物权限改变。
参数名说明
x, y, z角色位置
eventobjid权限改变的角色对象ID
switchState事件中的开关状态 (具体代表何种权限需测试)

角色骑乘事件

与角色(玩家或生物)骑乘或取消骑乘坐骑/载具相关的系列事件。

  • PlayerMountActor: 玩家骑乘坐骑/载具。
  • MobMountActor: 生物骑乘坐骑/载具。
  • PlayerDismountActor: 玩家取消骑乘。
  • MobDismountActor: 生物取消骑乘。
参数名说明
eventobjid骑乘者对象ID
x, y, z骑乘者位置
toobjid被骑乘的坐骑/载具对象ID
targetactorid被骑乘的坐骑/载具生物类型ID

当角色举起角色

TriggerEvent.ActorPickupActor

当一个角色(玩家或生物)将另一个角色举起时触发。

参数名说明
eventobjid举起者对象ID
x, y, z举起者位置
toobjid被举起的对象ID
targetactorid被举起的生物类型ID

对象与碰撞 (Object & Collision)

碰撞开始事件

当两个不同类型的对象开始相互碰撞时触发。事件命名格式为 `[对象A]CollideTo[对象B]`。

对象类型包括: Player(玩家), Mob(生物), Missile(投掷物), DropItem(掉落物), Entity(实体), AreaObj(区域)。

例如:PlayerCollideToMob 表示玩家与生物碰撞。

参数名说明
eventobjid触发碰撞的主动对象ID
actorid主动对象的生物类型ID
x, y, z碰撞发生的位置
toobjid被碰撞的目标对象ID

进入/离开区域事件

当一个对象进入或离开一个区域(AreaObj)时触发。事件命名格式为 `[对象类型]AreaIn` 或 `[对象类型]AreaOut`。

对象类型包括: Player, Mob, Missile, DropItem, Entity, AreaObj。

例如:PlayerAreaIn 表示玩家进入区域。

参数名说明
eventobjid进入/离开区域的对象ID
actorid进入/离开区域的对象生物类型ID
x, y, z事件发生的位置

对象创建事件

当特定类型的对象在世界中被创建时触发。

  • MobCreate: 任意生物被创建。
  • EntityCreate: 任意实体被创建。
  • AreaObjCreate: 任意区域被创建。
参数名说明
eventobjid被创建的对象ID
actorid被创建的生物类型ID
x, y, z创建位置
itemid相关的投掷物/道具类型ID (若适用)

方块 (Block)

方块被创建

TriggerEvent.BlockAdd

当一个方块在世界中被放置或生成时触发。

参数名说明
x, y, z方块位置
blockid被创建的方块ID

当方块被破坏

TriggerEvent.BlockRemove

当一个方块被玩家或生物等方式破坏时触发。

参数名说明
x, y, z方块位置
blockid被破坏的方块ID
eventobjid破坏方块的对象ID
actorid破坏方块的生物类型ID

方块挖掘事件

与方块被挖掘过程相关的系列事件。

  • BlockDigBegin: 开始挖掘方块。
  • BlockDigEnd: 挖掘完毕。
  • BlockDigCancel: 挖掘中断。
参数名说明
x, y, z方块位置
blockid被挖掘的方块ID
eventobjid挖掘方块的对象ID
actorid挖掘方块的生物类型ID

方块状态改变事件

与方块自身状态变化相关的系列事件。

  • BlockTrigger: 开关状态改变(如拉杆)。
  • BlockChangeColor: 颜色改变。
  • BlockChangeDir: 方向改变。
参数名说明
x, y, z方块位置
blockid发生改变的方块ID

储存容器事件

与储存容器方块(如箱子)内容变化相关的系列事件。

  • BlockContainerChange: 容器内容发生改变。
  • BlockContainerPutIn: 向容器放入道具。
  • BlockContainerTakeOut: 从容器取出道具。
参数名说明
x, y, z容器方块位置
blockid容器方块ID
itemid相关的道具ID

道具 & 掉落物 (Item & Drop)

玩家道具交互事件

与玩家主动使用、获取、消耗道具相关的系列事件。

  • PlayerAddItem: 获得道具 (进入背包)。
  • PlayerUseItem: 开始使用道具。
  • PlayerChargeItemBegin: 开始蓄力道具。
  • PlayerConsumeItem: 消耗道具。
  • PlayerPickUpItem: 拾取掉落物。
  • PlayerDiscardItem: 丢弃道具。
  • PlayerChargeItemEnd: 结束蓄力道具。
参数名说明
eventobjid玩家对象ID
x, y, z玩家位置
itemid相关的道具ID
itemnum相关的道具数量

当掉落物创建

TriggerEvent.ItemCreate

当一个道具以掉落物的形式在世界中创建时触发。

参数名说明
eventobjid掉落物对象ID
x, y, z掉落物位置
itemid掉落物的道具ID

当掉落物被拾取

TriggerEvent.DropItemPickup

当一个掉落物被拾取时触发 (注意与 `PlayerPickUpItem` 的区别)。

参数名说明
eventobjid拾取者对象ID
itemid被拾取的道具ID
x, y, z拾取发生的位置

当掉落物消失

TriggerEvent.ItemDisappear

当一个掉落物因为超时或其他原因从世界中消失时触发。

参数名说明
eventobjid消失的掉落物对象ID
itemid消失的道具ID
x, y, z掉落物消失的位置

投掷物 (Projectile)

投掷物创建

TriggerEvent.MissileCreate

当一个投掷物(如弓箭、雪球)被创建时触发。

参数名说明
eventobjid投掷物对象ID
itemid创建投掷物的道具ID
actorid发射者的生物类型ID
x, y, z创建位置

当投掷物击中目标

与投掷物击中不同类型目标相关的系列事件。

  • ProjectileHitBlock: 击中任意方块。
  • ProjectileHitPlayer: 击中任意玩家。
  • ProjectileHitMob: 击中任意生物。
  • ProjectileHitProj: 击中任意投掷物。
  • ProjectileHitItem: 击中任意掉落物。
  • ProjectileHitEntity: 击中任意实体。
参数名说明
eventobjid投掷物对象ID
itemid投掷物的道具ID
toobjid被击中的目标对象ID
targetactorid被击中的目标生物类型ID
x, y, z击中位置

界面 (UI)

界面显示/隐藏

与自定义界面的打开和关闭相关的事件。

  • UIShow: 当前界面被打开。
  • UIHide: 当前界面被关闭。
参数名说明
CustomUI相关的界面ID
x, y, z玩家位置
eventobjid玩家对象ID

界面元件交互事件

与点击、触摸、长按界面中各种元件(按钮、3D模型等)相关的系列事件。

  • UIButtonClick / UIGLoader3DTouchClick: 元件被点击。
  • UIButtonTouchBegin / UIGLoader3DTouchBegin: 元件被按下。
  • UIButtonTouchEnd / UIGLoader3DTouchEnd: 元件被抬起。
  • UIButtonLongPress / UIGLoader3DLongPress: 元件被长按。
参数名说明
eventobjid玩家对象ID
uielement被交互的元件ID
x, y, z玩家位置

玩家在界面输入字符串

TriggerEvent.UILostFocus

当玩家在界面的输入框中完成输入(输入框失去焦点)时触发。

参数名说明
eventobjid玩家对象ID
content输入的字符串内容
uielement相关的输入框元件ID

元件动画装载器播放完毕

TriggerEvent.UISpineComplete

当界面中的Spine或序列帧动画元件播放完成一个循环时触发。

参数名说明
eventobjid玩家对象ID
uielement播放完毕的动画元件ID
x, y, z玩家位置

特效 (Particle)

当特效被创建

与在不同目标(位置、对象、玩家等)上创建特效相关的系列事件。

  • ParticlePosOnCreate: 在任意位置创建。
  • ParticleObjectOnCreate: 在任意对象上创建。
  • ParticlePlayerOnCreate: 在任意玩家上创建。
  • ParticleMobOnCreate: 在任意生物上创建。
  • ParticleProjectileOnCreate: 在任意投掷物上创建。
  • ParticleItemOnCreate: 在任意掉落物上创建。
  • ParticleEntityOnCreate: 在任意实体上创建。
参数名说明
eventobjid特效绑定的对象ID (如果绑定在对象上)
x, y, z特效创建的位置
effectid被创建的特效类型ID

开发者 (Developer)

任意玩家购买或提取开发者商店道具

TriggerEvent.DeveloperBuyItem

当有玩家在开发者商店中购买或提取道具时触发。

参数名说明
itemid被购买/提取的道具ID
eventobjid进行操作的玩家对象ID
x, y, z玩家的位置