Skip to content

内置枚举库

可在代码里直接调用无需新建对象,调用形式如下:

lua
local errorCode = ErrorCode.OK
local worldType = WorldType.OWTYPE_GAMEMAKER

Lua原生数据及其他全局数据的用法描述如下

Lua原生数据类型

数据名称用法描述
nil表示一个无效值(在条件表达式中相当于false)
boolean布尔值,包含两个值:false和true
number实数,表示双精度类型的实浮点数,也可以是整数
string字符串,由一对单引号或双引号来表示
tableLua的一种数据结构,可用来创建不同的数据类型,如:数组、字典等
function由 C 或 Lua 编写的函数

游戏模式

名称用法描述
WorldType.Single单人模式
WorldType.Create多人创造模式
WorldType.Extremity极限模式
WorldType.CreateToRungame由创造模式转的生存
WorldType.Gamemaker自制玩法的编辑模式
WorldType.GamemakerRun自制玩法的运行模式
WorldType.Freemode冒险模式之自由模式
WorldType.Record录像模式

游戏地形

名称用法描述
TerrainType.Flat平坦地形
TerrainType.Normal随机地形

自定义视角编辑状态

名称用法描述
CameraEditState.Null
CameraEditState.Edit编辑
CameraEditState.Test测试

装备部位类型

名称用法描述
EquipSlotType.Head
EquipSlotType.Breast身体
EquipSlotType.Legging
EquipSlotType.Shoe
EquipSlotType.Pifeng披风
EquipSlotType.Weapon武器
EquipSlotType.MaxSlots最大装备栏(用于判断有效性)

游戏战斗结果

名称用法描述
TeamResults.None胜负未定
TeamResults.Win胜利
TeamResults.Lose失败
TeamResults.Dogfall平局

玩家背包类型

名称用法描述
BackpackType.Shortcut快捷栏
BackpackType.Inventory存储栏
BackpackType.Equip装备栏
BackpackType.Extend扩展背包

背包起始索引

名称用法描述
BackpackBeginIndex.Shortcut快捷栏
BackpackBeginIndex.Inventory存储栏
BackpackBeginIndex.Equip装备栏
BackpackBeginIndex.ExtBackpack扩展背包

朝向

名称用法描述
FaceDir.None未指定
FaceDir.NegXx反方向, 西
FaceDir.PosXx正方向, 东
FaceDir.NegZz反方向, 南
FaceDir.PosZz正方向, 北
FaceDir.NegYy反方向, 下
FaceDir.PosYy正方向, 上

朝向类型

名称用法描述
FaceType.Yaw面朝方向
FaceType.Pitch面仰角

生物属性枚举

名称用法描述
CreatureAttr.MaxHp最大生命值
CreatureAttr.CurHp当前生命值
CreatureAttr.HpRecover生命恢复
CreatureAttr.MaxHunger最大饥饿值
CreatureAttr.CurHunger当前饥饿值
CreatureAttr.CurOxygen当前氧气值
CreatureAttr.WalkSpeed移动速度
CreatureAttr.SwinSpeed游泳速度
CreatureAttr.JumpPower跳跃力
CreatureAttr.Dodge闪避率
CreatureAttr.AtkMelee近战攻击
CreatureAttr.AtkRemote远程攻击
CreatureAttr.DefMelee近战防御
CreatureAttr.DefRemote远程防御
CreatureAttr.Dimension模型大小
CreatureAttr.Level等级
CreatureAttr.DefChaos混乱防御
CreatureAttr.PackSize背包空间
CreatureAttr.ViewDistance视野距离
CreatureAttr.BodyLerpSpeed转身速度
CreatureAttr.AtkPhysical物理攻击
CreatureAttr.AtkMagic元素攻击
CreatureAttr.DefPhysical物理防御
CreatureAttr.DefMagic元素防御
CreatureAttr.ExtraHp临时生命值
CreatureAttr.Toughness韧性值
CreatureAttr.FlySpeed飞行速度
CreatureAttr.ViewDis视野范围
CreatureAttr.AttackDis攻击距离
CreatureAttr.Atk攻击力
CreatureAttr.EnableMove可移动
CreatureAttr.EnableAttack可攻击
CreatureAttr.EnableBeattacked可被攻击
CreatureAttr.EnableBekilled可被杀死
CreatureAttr.EnablePickup可拾取道具
CreatureAttr.EnableDeathdropitem死亡掉落

生物/玩家

名称用法描述
RoleAttr.MaxHp最大生命值
RoleAttr.CurHp当前生命值
RoleAttr.HpRecover生命恢复
RoleAttr.CurHunger饥饿度
RoleAttr.MaxOxygen最大氧气值
RoleAttr.CurOxygen当前氧气值
RoleAttr.WalkSpeed移动速度
RoleAttr.RunSpeed奔跑速度
RoleAttr.SwinSpeed游泳速度
RoleAttr.JumpPower跳跃力
RoleAttr.Gravity重力值
RoleAttr.CurStrength当前体力值
RoleAttr.MaxStrength当前最大体力值
RoleAttr.FlySpeed飞行速度
RoleAttr.AttackDis攻击距离
RoleAttr.ViewDis视野距离
RoleAttr.Atk攻击力
RoleAttr.PunchArmor近战防御
RoleAttr.RangeArmor远程防御

道具设置枚举

名称用法描述
ItemAbility.Throw道具不可丢弃
ItemAbility.Drop道具不可掉落

生物行为枚举

名称用法描述
CreatureMotion.Idle空闲
CreatureMotion.Standby待机
CreatureMotion.Stroll闲逛
CreatureMotion.AtkMelee近战攻击
CreatureMotion.AtkRemote远程攻击
CreatureMotion.Follow跟随
CreatureMotion.Swim游泳
CreatureMotion.RunAway逃跑
CreatureMotion.SelfBomb自爆
CreatureMotion.Beattracted被吸引
CreatureMotion.Copulation交配

玩家行为枚举

名称用法描述
PlayerMotion.Static静止
PlayerMotion.Walk行走
PlayerMotion.Run奔跑
PlayerMotion.Jump跳跃
PlayerMotion.JumpTwice二段跳
PlayerMotion.Sneak潜行
PlayerMotion.FallGround落地
PlayerMotion.Swim游泳

角色行为枚举

名称用法描述
RoleMotion.Stand站立
RoleMotion.Walk行走
RoleMotion.Run奔跑
RoleMotion.Jump跳跃
RoleMotion.Sneak潜行
RoleMotion.FallGround落地
RoleMotion.Swim游泳

伤害类型枚举

名称用法描述
HurtType.All所有伤害(只设置免疫伤害接口有效)

队伍属性枚举

名称用法描述
TeamAttr.PlayerNum玩家数量
TeamAttr.Score分数

方块属性枚举

名称用法描述
BlockAttr.ExplodeResistance爆炸抗性
BlockAttr.Hardness硬度
BlockAttr.Glissade滑行惯性
BlockAttr.BurningSpeed燃烧速度
BlockAttr.BurningProbability燃烧几率
BlockAttr.Lightness亮度

方块权限

名称用法描述
BlockLimits.EnableDestroyed可破坏
BlockLimits.EnableBeoperated可操作
BlockLimits.EnableBepushed可被推动
BlockLimits.EnableDropItem可掉落道具
BlockLimits.BepushedDropItem被推动掉落

方块状态

名称用法描述
BlockStatus.Active活跃(被激活)
BlockStatus.Inactive不活跃(未被激活)

天气状态枚举,局部天气

名称用法描述
GroupWeatherType.ShineAndRain晴雨交替
GroupWeatherType.Shine晴天
GroupWeatherType.Rain雨天
GroupWeatherType.Thunder雷暴
GroupWeatherType.Bad恶劣天气
GroupWeatherType.Snow雪天
GroupWeatherType.Sandduststorm沙尘暴
GroupWeatherType.Tempest暴风雨
GroupWeatherType.Blizzard暴风雪

地形组枚举值

名称用法描述
WeatherGroup.Global全局对象
WeatherGroup.Common常见组
WeatherGroup.Ocean海洋组
WeatherGroup.Desert沙漠组
WeatherGroup.Frigidzone普通寒带组
WeatherGroup.Coldzone高峰寒带组
WeatherGroup.Volcano火山组
WeatherGroup.Nunja湿地组
WeatherGroup.Plain平坦组
WeatherGroup.AirIsland空岛组

视口方向

名称用法描述
ViewPortType.Main主视角
ViewPortType.Back背视角
ViewPortType.Front正视角
ViewPortType.Back2背视角2
ViewPortType.Top俯视角
ViewPortType.Custom自定义视角

变量类型

名称用法描述
VarType.Pos位置
VarType.Areains区域
VarType.Number数值
VarType.String字符串
VarType.Boolean布尔值
VarType.Player玩家
VarType.PlayerGroup玩家组
VarType.BlockType方块类型
VarType.ItemType道具类型
VarType.Creature生物
VarType.CreatureType生物类型
VarType.CreatureGroup生物组
VarType.Timer定时器
VarType.EffectType特效类型
VarType.PosGroup位置组
VarType.AreaGroup区域组
VarType.NumberGroup数值组
VarType.StringGroup字符串组
VarType.BooleanGroup布尔值组
VarType.BlockTypeGroup方块类型组
VarType.ItemTypeGroup道具类型组
VarType.CreatureTypeGroup生物类型组
VarType.TimerGroup计时器组
VarType.EffectTypeGroup特效类型组

图文信息枚举

名称用法描述
GraphicsType.Hornbook文字板
GraphicsType.Suspendbook漂浮文字
GraphicsType.Progress进度条
GraphicsType.ArrowPos箭头 指向位置
GraphicsType.ArrowActor箭头 指向生物
GraphicsType.LinePos线 指向位置
GraphicsType.LineActor线 指向生物
GraphicsType.SurfacePos面 指向界面
GraphicsType.SurfaceActor面 指向生物
GraphicsType.Image图片

排序方式

名称用法描述
SortType.Up升序,
SortType.Down降序,

移动方式

名称用法描述
MoveType.Walking行走,
MoveType.Flying飞行,
MoveType.Swimming游泳,
MoveType.Auto自动调整

显示板视频播放模式

名称用法描述
ViedoPlayMode.Repeat循环播放
ViedoPlayMode.Once单次播放

时间值枚举

名称用法描述
EventDate.Year
EventDate.Month
EventDate.Day
EventDate.Hour
EventDate.Minute
EventDate.Second
EventDate.Timestamp时间戳
EventDate.Dayofweek星期几

道具属性

名称用法描述
ItemAttr.Attack攻击力
ItemAttr.Stackmax叠加数
ItemAttr.ShortDefense近战防御
ItemAttr.LongDefense远程防御
ItemAttr.ExplodeDefense爆炸防御
ItemAttr.FireDefense燃烧防御
ItemAttr.PoisonDefense毒素防御
ItemAttr.WitherDefense混乱防御
ItemAttr.Duration耐久度
ItemAttr.FireInterval射击间隔
ItemAttr.Magazines弹夹量
ItemAttr.Quality品质
ItemAttr.ItemType道具类型

掉落物掉落方式

名称用法描述
DropMode.DiscardItem丢弃道具
DropMode.DestroyBox箱子被破坏掉落
DropMode.DefeatMob生物被击败掉落
DropMode.DestroyBlock方块被破坏掉落
DropMode.SpawnItem触发器创建
DropMode.ChangePlayMode掉落物对象转玩法创建

动作播放方式

名称用法描述
AnimMode.Loop循环播放
AnimMode.Once播放一次
AnimMode.OnceStop播放一次完毕,停在末尾
AnimMode.Default表格默认值播放

线性变换

名称用法描述
Easing.None无动画
Easing.Linear直线变换
Easing.QuadIn平方曲线1渐入
Easing.QuadOut平方曲线2渐出
Easing.QuadInOut平方曲线3进出
Easing.ExpoIn指数曲线1渐入
Easing.ExpoOut指数曲线2渐出
Easing.ExpoInOut指数曲线3进出
Easing.CircIn圆曲线1渐入
Easing.CircOut圆曲线2渐出
Easing.CircInOut圆曲线3进出
Easing.ElasticIn弹簧曲线1渐入
Easing.ElasticOut弹簧曲线2渐出
Easing.ElasticInOut弹簧曲线3进出
Easing.BackIn回退曲线1渐入
Easing.BackOut回退曲线2渐出
Easing.BackInOut回退曲线3进出
Easing.BounceIn弹跳曲线1渐入
Easing.BounceOut弹跳曲线1渐出
Easing.BounceInOut弹跳曲线1进出

天空盒贴图

名称用法描述
SkyboxMap.Sky天空贴图
SkyboxMap.Sun太阳贴图
SkyboxMap.Moon月亮贴图

天空盒颜色

名称用法描述
SkyboxColor.Top天空顶部颜色
SkyboxColor.Middle天空腰部颜色
SkyboxColor.Bottom天空底部颜色
SkyboxColor.Light天空光照颜色
SkyboxColor.Env环境光颜色
SkyboxColor.Sun太阳颜色
SkyboxColor.Moon月亮颜色
SkyboxColor.Cloud云颜色
SkyboxColor.Fog雾颜色

天空盒参数

名称用法描述
SkyboxAttr.SunScale太阳大小
SkyboxAttr.MoonScale月亮大小
SkyboxAttr.StarDensity星星密度
SkyboxAttr.CloudSpeed云的运动速度
SkyboxAttr.CloudDensity云的密度
SkyboxAttr.CloudHigh云的高度
SkyboxAttr.FogreMinDis雾的最近距离
SkyboxAttr.FogreMaxDis雾的最远距离
SkyboxAttr.Template模板

天空盒环境粒子参数

名称用法描述
SkyboxParticle.Strength强度
SkyboxParticle.Range范围
SkyboxParticle.Speed速度
SkyboxParticle.Randomness运动不规则度

天空盒滤镜参数

名称用法描述
SkyboxFilter.Contrast对比度
SkyboxFilter.Saturation饱和度
SkyboxFilter.Flood泛光强度
SkyboxFilter.Exposure曝光强度
SkyboxFilter.Volumelight体积光强度
SkyboxFilter.Gamma伽马强度
SkyboxFilter.Dof景深强度-暂时没用到
SkyboxFilter.Color滤镜颜色
SkyboxFilter.Lut色彩校正
SkyboxFilter.Template滤镜模板

天空盒开关

名称用法描述
SkyboxSwitch.Fogenable雾开关

摄像机属性

名称用法描述
CameraModel.MoveFollow跟随角色移动
CameraModel.RotateFollow跟随角色旋转
CameraModel.Autoindent阻挡后自动缩进
CameraModel.RelativeRotate相对人物旋转
CameraModel.RoleTranslucent角色半透

摄像机旋转模式

名称用法描述
CameraRotate.AllDir全方向
CameraRotate.OnlyYaw仅左右
CameraRotate.OnlyPitch仅上下
CameraRotate.NoTurn无法转动

绝对阵营

名称用法描述
AbsoluteCampType.Noteam无队伍
AbsoluteCampType.Team1队伍1
AbsoluteCampType.Team2队伍2
AbsoluteCampType.Team3队伍3
AbsoluteCampType.Team4队伍4
AbsoluteCampType.Team5队伍5
AbsoluteCampType.Team6队伍6
AbsoluteCampType.TeamNpc1绝对阵营-npc队伍1
AbsoluteCampType.TeamNpc2绝对阵营-npc队伍2
AbsoluteCampType.TeamNpc3绝对阵营-npc队伍3
AbsoluteCampType.Enemy中立敌对
AbsoluteCampType.Passive中立被动

相对阵营

名称用法描述
RelativeCampType.Friendly友方
RelativeCampType.Enemy敌方
RelativeCampType.Neutral中立
RelativeCampType.Any任意

玩家关系

名称用法描述
PlayerRelations.CollectMaps收藏地图
PlayerRelations.EvaluateMaps评价地图
PlayerRelations.InviteFriend邀请好友

货币类型

名称用法描述
MiniCurrency.MiniBean迷你豆
MiniCurrency.MiniCoin迷你币
MiniCurrency.MiniPoint迷你点

开发者商店页面类型

名称用法描述
MiniShopPage.Item道具购买
MiniShopPage.Skin皮肤
MiniShopPage.Convert兑换
MiniShopPage.Welfare福利
MiniShopPage.MiniVip大会员
MiniShopPage.WareHouse打开仓库
MiniShopPage.CustomCoin打开自定义货币界面

像素单位

名称用法描述
PixelUnits.Percentage百分比
PixelUnits.Value绝对值

水平偏移

名称用法描述
HorizontalOffset.Left居左
HorizontalOffset.Centered居中
HorizontalOffset.Right居右

垂直偏移

名称用法描述
VerticalOffset.Top居上
VerticalOffset.Centered居中
VerticalOffset.Bottom居下

元件类型

名称用法描述
ElementType.Texture图片
ElementType.Button按钮
ElementType.Text文本
ElementType.InputText输入框
ElementType.Loader3D3d装载器
ElementType.SlidingContainer滑动容器

插件类型

名称用法描述
CustomModType.Block方块插件 预制
CustomModType.Monster生物插件
CustomModType.Item道具插件
CustomModType.Recipe配方插件
CustomModType.Furnace熔炼插件
CustomModType.Status状态插件
CustomModType.Biome地形插件
CustomModType.Actor实体
CustomModType.UIUI
CustomModType.Rule世界规则

天气类型

名称用法描述
WeatherType.None无天气
WeatherType.Sunshine晴天
WeatherType.Rain雨天
WeatherType.Sandstorm沙尘暴
WeatherType.Snow雪天
WeatherType.UnderWater暴雨
WeatherType.Volcano火山
WeatherType.Custom自定义

进度图案

名称用法描述
ProgressImg.Background进度背景
ProgressImg.Progress进度值

射线检测返回类型

名称用法描述
RayDetectType.Block方块类型
RayDetectType.Player玩家
RayDetectType.Actor生物
RayDetectType.ActorType生物类型

获取玩家内部控件高度

名称用法描述
PlayerBodyUIHight.Nick昵称
PlayerBodyUIHight.Title称号
PlayerBodyUIHight.EffEct头部动效
PlayerBodyUIHight.HpBar血条

UI滑动方向

名称用法描述
UIScollDir.Horizontal水平滑动
UIScollDir.Vertical垂直滑动
UIScollDir.Both自由滑动

角度朝向

名称用法描述
TurnFaceDir.Yaw水平朝向
TurnFaceDir.Pitch垂直朝向

进度值类型

名称用法描述
ProgressVal.Min最小值
ProgressVal.Max最大值
ProgressVal.Current当前值
ProgressVal.CurAndMax当前值和最大值

天空盒时间

名称用法描述
SkyboxTime.Current当前时间
SkyboxTime.Time0天空盒0点
SkyboxTime.Time4天空盒4点
SkyboxTime.Time6天空盒6点
SkyboxTime.Time8天空盒8点
SkyboxTime.Time12天空盒12点
SkyboxTime.Time16天空盒16点
SkyboxTime.Time18天空盒18点
SkyboxTime.Time20天空盒20点
SkyboxTime.TimeAll所有时间段

枪械状态

名称用法描述
GunState.Entry进入
GunState.Exit离开

枪械触发事件类型

名称用法描述
GunAction.Equip举枪
GunAction.Idle腰射待机
GunAction.Fire腰射开火
GunAction.Load腰射手动上膛
GunAction.Run持枪冲刺
GunAction.Aim瞄准待机
GunAction.AimFire瞄准开火
GunAction.AimLoad瞄准手动上膛
GunAction.Reload腰射换弹
GunAction.ReloadEmpty腰射空仓换弹
GunAction.Inspect检视

枪械禁用类型

名称用法描述
GunActionBan.Equip举枪
GunActionBan.Fire腰射开火
GunActionBan.Load腰射手动上膛
GunActionBan.Run持枪冲刺
GunActionBan.Aim瞄准待机
GunActionBan.AimFire瞄准开火
GunActionBan.AimLoad瞄准手动上膛
GunActionBan.Reload腰射换弹
GunActionBan.ReloadEmpty腰射空仓换弹
GunActionBan.Inspect检视

动作总开关

名称用法描述
Ability.Movement移动能力总开关
Ability.Walking行走
Ability.Flying飞行
Ability.Swimming游泳
Ability.Sneaking潜行
Ability.Sprinting疾跑
Ability.Cube方块能力总开关
Ability.Interaction交互方块
Ability.Place摆放方块
Ability.Break破坏方块
Ability.Item道具能力总开关
Ability.Use使用道具
Ability.Pick拾取道具
Ability.Drop丢弃道具
Ability.Attack普通攻击
Ability.CanBePickup可被举起
Ability.CanUseItemWhenBePickup被举起时可否使用道具
Ability.EnableBeattacked可受伤
Ability.EnableBekilled可被杀死
Ability.EnableDeathdropitem杀死有掉落物
Ability.EnableSwitchShortcut可切换快捷栏
Ability.EnableRotatingCamera可旋转摄像机

输出日志等级

名称用法描述
LogLevel.Print普通输出
LogLevel.Warn警告输出
LogLevel.Error错误输出

错误码

名称用法描述
ErrorCode.OK成功
ErrorCode.FAILED失败

举起动作类型

名称用法描述
PickupActionType.Pickup拾取
PickupActionType.Drop放下
PickupActionType.Throw投掷
PickupActionType.Unbind解绑

玩家内置UI类型

名称用法描述
PlayerNameType.Nick昵称
PlayerNameType.Title称号
PlayerNameType.EffEct头部特效

枪械属性

名称用法描述
GunAttr.ReloadPhase2Time换弹行为时间
GunAttr.ReloadPhase2TimeEmpty空仓换弹行为时间

对象类型

名称用法描述
ObjType.Entity实体
ObjType.Mob生物
ObjType.Player玩家
ObjType.World世界
ObjType.Block方块
ObjType.UIUI编辑界面
ObjType.Area区域
ObjType.Projectile投掷物对象
ObjType.Pos位置
ObjType.DropItem掉落物

组件属性访问权限

名称用法描述
CmpProPermission.Public公开
CmpProPermission.Private私有
CmpProPermission.Read只读

设备类型

名称用法描述
DeviceType.PCPC端
DeviceType.Android安卓
DeviceType.IOS苹果
DeviceType.Other其他