API类型

如需查阅全部API，请前往开发者文档查看：

开发者文档链接： 元件脚本 API文档 | 元梦之星

API类型

角色与生物

API类型	说明	运行环境
AI角色 (AICharacter)	AI角色类API，可对场景中AI控制的角色进行控制，通常用来制作机器人补全功能。	在服务端运行
玩家角色 (Character)	角色类API，可对玩家控制的角色进行相关操作，如改变角色位置、改变角色形象等。	在客户端运行
客户端假人 (FakeCharacter)	客户端假人类API，可在客户端创建新的角色，并进行控制。	在客户端运行
生物 (Creature)	生物类API，可对生物进行相关操作，如改变位置、旋转、缩放、开启追踪等。	在客户端和服务端运行
动画系统 (Animation)	动画系统类API，可以对角色或生物进行动作控制。	在服务端和客户端运行

游戏元素与特效

API类型	说明	运行环境
元件基础 (Element)	元件类API，可对元件进行相关操作，如改变位置、旋转、缩放、物理特性等。	在客户端运行
功能元件 (FuncElement)	功能元件类API，可用于对功能元件进行相关操作处理。	在服务端和客户端运行
逻辑元件 (LogicElement)	逻辑元件类API，可用于对逻辑元件进行相关操作处理。	在服务端和客户端运行
物理元件（PhysicsElement）	物理元件类API，用于处理物理元件进行相关操作。	在服务端和客户端运行
触发盒 (TriggerBox)	触发盒类API，用于处理元件触发盒相关操作，如改变位置、旋转、缩放等。	在服务端和客户端运行

界面与交互

API类型	说明	运行环境
摄像机 (Camera)	相机类API，可对场景中的相机进行控制，如改变位置和改变附加的角色等。	在客户端运行
引导系统 (Guide)	引导类API，可对目标指引进行相关操作，如改变指引图案与文字等，通常用来制作局内引导功能。	在客户端运行
粒子特效 (Particle)	粒子特效类API，对粒子特效进行控制处理。	在服务端和客户端运行
游玩交互 (PlayInteractive)	游玩交互类API，用于游玩时对场景物体进行点击拖拽等交互行为的控制。	在服务端和客户端运行
自定义界面 (UI)	自定义界面类API，可对控件进行相关操作，如控制控件显隐、改变进度条的值、改变控件文本等，通常用来制作控件相关功能。 提供注册控件点击、弹起、移动时回调函数的API，可用于制作监听该回调时触发的后续操作。如点击指定控件显示指定控件。	在客户端运行

音频与视觉

API类型	说明	运行环境
音频 (Audio)	音频类API，可对音频类进行相关操作，通常用来制作游戏中的各种音效。	在客户端运行
录音 (Voice)	录音类API，可对音效进行相关操作，如播放音效等。	在客户端运行
天空盒 (SkyBox)	天空盒类型API，用于处理天空盒相关操作，如改变天空盒样式等，通常用于制作氛围转换。	在客户端运行

数据与存储

API类型	说明	运行环境
存档系统 (Archive)	存档类API，可对玩家云存档进行相关操作，通常用来存储玩家游玩进度。	在服务端和客户端运行
数组 (Array)	数组类API，可对table进行相关操作，通常用来对table中的元素进行增删改查。	在客户端和服务端运行
互动数值操作类 (PublicDB)	互动数值操作类类API，用于处理互动数值相关操作。	在服务端和客户端运行

社交与通信

API类型	说明	运行环境
聊天系统 (Chat)	聊天系统类API，可以对玩家的语音和文本聊天进行控制。	在客户端和服务端运行
分享 (Share)	分享类API，用来制作地图分享相关功能。	在客户端运行
社交控件 (Social)	社交控件类API，对社交控制进行操作。	在服务端和客户端运行
阵营 (Team)	阵营类API，用于处理阵营相关的内容。	在服务端和客户端运行

游戏系统

API类型	说明	运行环境
成就系统 (Achievement)	成就类API，可对玩家成就进度进行相关操作，通常用来制作成就解锁相关功能。	在服务端和客户端运行
玩家货币 (Currency)	货币类API，可对玩家货币进行相关操作，如增减玩家货币等，通常用来制作局内购买功能。	在服务端和客户端运行
自定义物品（CustomItem）	自定义物品类API，对自定义武器、装备等进行相关操作。	在服务端和客户端运行
自定义属性（CustomProperty）	自定义属性类API，对元件身上的自定义属性进行相关操作。	在服务端和客户端运行
伤害系统 (Damage)	伤害类API，用来对计算与处理角色与生物受到的伤害、受到的治疗与生命。	在客户端和服务端运行
引擎类 (Engine)	引擎类API，提供各类引擎相关的结构体和处理API。	在客户端和服务端运行
背包系统 (Inventory)	背包系统类API，可对背包掉落物品进行相关操作，如给玩家增减物品，创建物品等。	在服务端和客户端运行
打印信息 (Log)	打印信息类API，可在控制台日志打印信息，如打印字符串、数值等，通常用来在开发阶段调试Lua脚本。	在服务端和客户端运行
排行榜 (Rank)	排行榜类API，用于处理排行榜相关操作，如对玩家展示地图排行榜，玩家好友排行榜，记录玩家排行榜排名等，计分类型有时间与分数两种形式。 需先在地图设置-其他设置-排行榜设置中建立排行榜才可对该排行榜进行操作。	在服务端和客户端运行
地图设置（Setting）	地图设置类API，用于处理地图设置相关操作。	在服务端和客户端运行
商店 (Shop)	商店类API，用于处理局内商店相关操作，如对玩家显示局内商店界面等。	在服务端和客户端运行
技能系统（Skill)	技能系统类API，用于处理角色充能大招与技能相关操作。	在服务端和客户端运行
剧情系统(Story)	剧情系统类API，用于处理剧情相关操作。	在客户端运行
系统 (System)	系统类API，提供各类系统事件和相关信息，用于管理事件触发后的操作。	在客户端运行
任务系统(Task)	任务系统类API，用于处理任务相关操作。	在服务端运行

工具类

API类型	说明	运行环境
其他服务 (MiscService)	其他服务类API，提供了其他实用功能，包含对象转字符串、获取随机颜色、获取当前游戏时间等API。	在服务端和客户端运行
定时器 (TimerManager)	时间管理类API，提供各类定时器和延迟调用函数。	在服务端和客户端运行
数学 (UMath)	数学类API，可进行计算等相关操作，如数值计算、向量计算等，通常用来计算所需的数值、位置和力的大小。	在服务端和客户端运行

事件系统

API类型	说明	运行环境
事件系统 (Events)	事件系统类API，监听游戏内各类系统事件处理，注册玩家自定义事件。	在服务端和客户端运行