世界模块管理接口 `World`

具体函数名及描述如下:

序号	函数名	函数描述
1	StopParticleOnPos(...)	停止指定位置的粒子特效
2	SetParticleTransform(...)	设置粒子变换
3	PlayParticle(...)	播放粒子特效
4	GetLightByPos(...)	获取光照强度
5	SpawnCreature(...)	生成生物
6	DespawnActor(...)	移除生物
7	GetPlayerTotal(...)	获取玩家数量
8	GetAllPlayers(...)	获取全部玩家对象ID列表
9	GetSpawnPoint(...)	获取世界默认出生点
10	FindCanSpawnMobPosList(...)	查找附近可刷怪位置列表
11	FindNearestPlayerByPos(...)	获取离指定位置最近的玩家
12	PlaySoundEffectOnPos(...)	播放音效
13	StopSoundEffectOnPos(...)	停止指定位置上的音效
14	PauseSoundEffectOnPos(...)	暂停/恢复音效
15	IsDaytime(...)	是否白天
16	SetHours(...)	设置时间（小时）
17	GetHours(...)	获取时间（小时）
18	GetDay(...)	获取天数
19	SetGravity(...)	设置重力
20	AddGravity(...)	增加重力
21	GetGravity(...)	获取重力
22	IsChunkLoaded(...)	区块是否加载
23	CanMobSpawnOnPosXZ(...)	获取可刷怪的Y坐标
24	GetHostWorldId(...)	获取主机星球ID
25	SpawnProjectile(...)	生成投掷物
26	SpawnProjectileByDir(...)	按方向生成投掷物
27	GetBiomeType(...)	获取地形类型
28	GetBiomeGroup(...)	获取地形组类型
29	FindEcosystem(...)	查找地形位置
30	PixelMapAddMarker(...)	地图增加标记
31	PixelMapRefreshMarker(...)	地图刷新标记
32	PixelMapDelMarker(...)	地图删除标记
33	PixelMapAddTexture(...)	增加地图纹理标签
34	PixelMapRefreshTexture(...)	刷新地图纹理标签
35	PixelMapDelTexture(...)	地图删除纹理标签
36	SetSkyBoxColorAnim(...)	设置天空盒颜色(动效)
37	SetTimeVanishingSpeed(...)	设置时间流逝速度
38	SetSkyBoxTemplate(...)	设置天空盒模板
39	SetSkyBoxMaps(...)	设置天空盒贴图
40	SetSkyBoxColor(...)	设置天空盒颜色
41	SetSkyBoxAttr(...)	设置天空盒属性
42	SetSkyBoxAttrWithNoTime(...)	设置天空盒属性(不带时间)
43	SetSkyBoxFilter(...)	设置天空盒滤镜
44	SetSkyBoxSwitch(...)	设置天空盒开关
45	SetSkyBoxMapsAnim(...)	设置天空盒贴图(动效)
46	SetSkyBoxFilterAnim(...)	设置天空盒滤镜(动效)
47	GetLocalDate(...)	获取本地时间字段
48	GetLocalDateString(...)	获取本地时间字符串
49	GetServerDate(...)	获取服务器时间字段
50	GetDateFromTime(...)	时间戳转时间字段
51	GetDirRayDetection(...)	方向射线检测
52	GetRayLength(...)	计算射线长度
53	GetRayBlock(...)	射线命中方块
54	CalcDirectionByYawDirection(...)	局部方向转世界方向(向量)
55	CalcDirectionByYawAngle(...)	局部方向转世界方向(角度)
56	CalcDirectionByCoord(...)	坐标转表
57	CalcDirectionByAngle(...)	角度转方向向量
58	RandomParticleEffectID(...)	随机特效ID
59	RandomSoundID(...)	随机音效ID
60	CalcDistance(...)	计算两点距离
61	SetGroupWeather(...)	设置天气组天气
62	RandomWeatherID(...)	随机天气ID
63	GetGroupWeather(...)	获取天气组天气
64	SetSpawnPoint(...)	设置出生点
65	CalcDirectionByPos2Pos(...)	两点单位方向
66	SetWorldCreateMobRule(...)	设置世界生物生成规则
67	GetWorldCreateMobRule(...)	获取生物生成密度
68	SetMobSpawnDensity(...)
69	SetPlantGrowRate(...)	设置农作物生长倍率
70	SetInnerViewEnable(...)	设置内置界面启用
71	SetMidJoin(...)	设置中途加入开关
72	GetGameMode(...)	获取游戏模式
73	SetLightByPos(...)	设置方块光照

StopParticleOnPos

参数及类型：
- x:number 坐标x(传入创建+偏移后的位置X)
- y:number 坐标y(传入创建+偏移后的位置X)
- z:number 坐标z(传入创建+偏移后的位置X)
- particleId:number / string 特效ID或路径
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：停止指定位置的粒子特效（支持传特效ID或路径）
具体使用案例如下：

lua

    local pos = {x = x, y = y, z = z} -- 创建的位置

    local createoffset = {x = 0,y = 0.5, z = 0} --创建的偏移位置

    local result = World:StopParticleOnPos(pos.x +createoffset.x, pos.y +createoffset.y,pos.z +createoffset.z, 1001, worldId)

SetParticleTransform

参数及类型：
- pos:table 位置坐标（传入创建+偏移后的位置）
- particleIdArg:number / string / table 特效ID/路径或数组
- offset:table / nil 偏移（米）
- rot:table / nil 旋转
- scale:table / nil 缩放
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：调整指定位置的粒子特效偏移/旋转/缩放（支持单个或多个特效）
具体使用案例如下：

lua

    -- 设置效果缩放2倍 

    local pos = {x = x, y = y, z = z} -- 创建的位置

    local createoffset = {x = 0,y = 0.5, z = 0} --创建的偏移位置

    local result = World:SetParticleTransform({x=pos.x +createoffset.x, y=pos.y +createoffset.y,z=pos.z +createoffset.z}, 1001, {x= 0,y= 0,z=0}, nil, {x = 2, y = 2, z = 2}, worldId)

PlayParticle

参数及类型：
- pos:table 位置（传入创建+偏移后的位置）
- particleIdArg:number / string / table 特效ID/路径或数组
- ptimeArg:number / nil 持续秒数
- offset:table / nil 偏移（米）
- rot:table / nil 旋转
- scale:table / nil 缩放
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：在指定位置播放粒子特效（支持单个或多个特效）
具体使用案例如下：

lua

    local offset = {x=0,y=0.5,z=0}

    local result = World:PlayParticle({x = x, y = y, z = z}, 1001, 2, offset, nil, nil, worldId)

GetLightByPos

参数及类型：
- x:number 坐标x
- y:number 坐标y
- z:number 坐标z
- worldId:number / nil 星球ID
返回值及类型：
- lv:number 光照强度(0~16)，失败为-1
该方法的其他说明：获取指定位置的光照强度
具体使用案例如下：

lua

    local light = World:GetLightByPos(x, y, z, WorldId)

    print("获取光照强度 ", light)

SpawnCreature

参数及类型：
- x:number 坐标x
- y:number 坐标y
- z:number 坐标z
- mobid:number / string 生物类型
- num:number / nil 数量
- trigger:bool / nil 是否触发事件
- worldId:number / nil 星球ID
返回值及类型：
- objs:table / nil 生成的生物ID数组
该方法的其他说明：在指定位置生成生物（怪物/NPC/动物等）
具体使用案例如下：

lua

        local creatures = World:SpawnCreature(x + 5, y + 1, z, 3400, 1, true, worldId)

DespawnActor

参数及类型：
- objid:number 对象objID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：移除一个生物，如果是骑乘的生物则会先把骑乘关系处理掉再移除生物。(玩家不允许移除)
具体使用案例如下：

lua

        local result = World:DespawnActor(creatureId)

GetPlayerTotal

参数及类型：
- alive:number / nil 玩家状态（0阵亡 1存活 -1全部）
返回值及类型：
- ret:number 玩家数量，失败为-1
该方法的其他说明：获取当前玩家数量（可按存活/死亡筛选）
具体使用案例如下：

lua

    local total = World:GetPlayerTotal()

GetAllPlayers

参数及类型：
- alive:number / nil 玩家状态（0阵亡 1存活 -1全部）
返回值及类型：
- list:table / nil 玩家objid数组
该方法的其他说明：获取当前地图中全部玩家对象ID列表（可按存活/死亡筛选）
具体使用案例如下：

lua

    local players = World:GetAllPlayers()

GetSpawnPoint

参数及类型：
- worldId:number / nil 星球ID（nil或-1表示当前星球）
返回值及类型：
- x:number 坐标x
- y:number 坐标y
- z:number 坐标z
该方法的其他说明：取当前地图/世界配置的默认出生点
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(playerId or Player:GetHostUin())

    local x, y, z = World:GetSpawnPoint(worldId)

FindCanSpawnMobPosList

参数及类型：
- centerX:number 中心x
- centerY:number 中心y
- centerZ:number 中心z
- radius:number 半径
- includeCenterPos:bool / nil 是否包含中心点
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- posList:table / nil 位置列表
该方法的其他说明：获取指定中心点周围，以设置的半径为范围的「可刷怪」位置列表，可选是否把中心点也算进结果里
具体使用案例如下：

lua

    local posList = World:FindCanSpawnMobPosList(x, y, z, 10, true, WorldId)

    if posList then

        for i, v in ipairs(posList) do

            print("可以创建生物位置", v.x, v.y, v.z)

        end

    end

FindNearestPlayerByPos

参数及类型：
- posX:number x
- posY:number y
- posZ:number z
- worldId:number / nil 星球ID(默认当前主机星球)
返回值及类型：
- objid:number / nil 玩家ID
该方法的其他说明：以指定位置为中心、在半径范围内查找玩家，返回最近的玩家ID
具体使用案例如下：

lua

    local nearestPlayerId = World:FindNearestPlayerByPos(x, y, z, worldId)

PlaySoundEffectOnPos

参数及类型：
- pos:table 位置
- soundId:number 音效ID
- volume:number 音量(0~100)
- pitch:number / nil 音调
- isLoop:bool是否循环
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：在指定位置播放音效（可设置音量/音调/是否循环）
具体使用案例如下：

lua

    local result = World:PlaySoundEffectOnPos({x = x, y = y, z = z}, 10946, 100, 1, false, worldId)

StopSoundEffectOnPos

参数及类型：
- pos:table 位置
- soundId:number 音效ID（-1表示全部）
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：停止指定位置上的音效（传 -1 表示停止该位置所有音效）
具体使用案例如下：

lua

    local result = World:StopSoundEffectOnPos({x = x, y = y, z = z}, 10946, worldId)

PauseSoundEffectOnPos

参数及类型：
- pos:table 位置
- soundId:number 音效ID（-1表示全部）
- pause:boolean true暂停 false恢复
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：暂停或恢复指定位置的音效（传 -1 表示该位置所有音效）
具体使用案例如下：

lua

    local result = World:PauseSoundEffectOnPos({x = x, y = y, z = z}, 10946, true, worldId)

IsDaytime

参数及类型：无
返回值及类型：
- ret:boolean 是否白天
该方法的其他说明：当前是否为白天
具体使用案例如下：

lua

    local isDaytime = World:IsDaytime()

SetHours

参数及类型：
- time:number 小时（0~24）
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：把世界时间设置到某个小时（0~24）
具体使用案例如下：

lua

    local result = World:SetHours(2)

GetHours

参数及类型：无
返回值及类型：
- curHour:number / nil 小时
该方法的其他说明：获取当前世界时间（小时）
具体使用案例如下：

lua

    local hours = World:GetHours()

GetDay

参数及类型：无
返回值及类型：
- ret:number / nil 天数
该方法的其他说明：获取当前世界过了多少天
具体使用案例如下：

lua

    local day = World:GetDay()

SetGravity

参数及类型：
- value:number 重力值
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：设置当前星球的重力倍数（目前只支持当前星球）
具体使用案例如下：

lua

    local result = World:SetGravity(12, worldId)

AddGravity

参数及类型：
- value:number 增加量
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：在当前重力基础上增加一个值
具体使用案例如下：

lua

        local result = World:AddGravity(1, worldId)

GetGravity

参数及类型：
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- value:number / nil 重力值
该方法的其他说明：获取当前星球重力值
具体使用案例如下：

lua

    local gravity = World:GetGravity(worldId)

IsChunkLoaded

参数及类型：
- x:number x坐标
- z:number z坐标
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:boolean 是否已加载
该方法的其他说明：判断某个区块是否已加载
具体使用案例如下：

lua

    local worldId = World:GetHostWorldId()

    local result = World:IsChunkLoaded(x, z, worldId)

CanMobSpawnOnPosXZ

参数及类型：
- x:number x
- y:number y
- z:number z
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- posy:number 查到的可刷怪落脚 Y（-1 表示未找到）
该方法的其他说明：在指定的 x、z 处从高度 y 向上查找，得到第一个可落脚刷怪的高度，找不到合适位置返回 -1。
具体使用案例如下：

lua

    local canSpawnY = World:CanMobSpawnOnPosXZ(x,y, z, WorldId)

    if canSpawnY and canSpawnY > 0 then

        print("可以创建生物位置", x, canSpawnY, z)

    end

GetHostWorldId

参数及类型：无
返回值及类型：
- worldId:number 星球ID
该方法的其他说明：获取主机所在星球ID
具体使用案例如下：

lua

    local worldId = World:GetHostWorldId()

    print("获取主机世界id ", worldId)

SpawnProjectile

参数及类型：
- objid:number / nil 发射者objid
- itemid:number / string 道具ID或资源ID
- x:number 起点x
- y:number 起点y
- z:number 起点z
- dstx:number 目标x
- dsty:number 目标y
- dstz:number 目标z
- speed:number / nil 速度
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- objid:number / nil 投掷物objid
该方法的其他说明：在起点生成一个投掷物并朝目标点飞行（可指定速度）
具体使用案例如下：

lua

        -- 生成石箭往x+20,y+5,z方向射出， 速度10

        local projectile = World:SpawnProjectile((playerId or Player:GetHostUin()), 12051, x, y, z, x + 20, y + 5, z, 10, worldId)

SpawnProjectileByDir

参数及类型：
- objid:number 发射者objid
- itemid:number / string 道具类型/资源ID
- x|y|z:number 生成位置坐标
- dirx|diry|dirz:number 飞行方向分量
- speed:number 速度
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:number / nil 投掷物ID（失败返回nil）
该方法的其他说明：在指定位置生成投掷物，按指定方向飞行（可指定速度）
具体使用案例如下：

lua

        local projectileByDir = World:SpawnProjectileByDir((playerId or Player:GetHostUin()), 12051, x, y, z, 20, 5, 20, 10, worldId)

GetBiomeType

参数及类型：
- posX|posZ:number 位置坐标
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:number / nil 地形类型（BiomeType）
该方法的其他说明：获取指定位置的地形类型；取不到返回 nil
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(playerId or Player:GetHostUin())

    local biomeType = World:GetBiomeType(x, z, worldId)

    if biomeType == BiomeType.GrassLand then

        print("草原")

    elseif biomeType == BiomeType.Forest then

        print("森林")

    end

GetBiomeGroup

参数及类型：
- posX|posZ:number 位置坐标
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:number / nil 地形组类型（WeatherGroup）
该方法的其他说明：获取指定位置的地形组类型；取不到返回 nil
具体使用案例如下：

lua

    local group = World:GetBiomeGroup(x, z, WorldId)

FindEcosystem

参数及类型：
- x|y|z:number 查找起点位置坐标
- biomeType:number 地形类型（BiomeType）BiomeType
- radius:number / nil 查找半径
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- retX|retY|retZ:number / nil 找到的地形位置坐标（失败返回nil）
该方法的其他说明：从起点附近搜索指定地形类型，找到则返回目标坐标，找不到返回 nil,radius是 (2radius + 1) ^ 2个chunk, radius = 4就需要遍历81个chunk,8116*16个方块
具体使用案例如下：

lua

    local x,y,z = World:FindEcosystem(centerX, centerY, centerZ, BiomeType.GrassLand, 50, worldId)

    if x and y and z then

        print("找到草原", x, y, z)

    end

PixelMapAddMarker

参数及类型：
- uin:number 玩家ID
- id:string 标记ID
- params:table 标记参数
- worldid:number / nil 星球ID
返回值及类型：
- ret:boolean 是否添加成功
该方法的其他说明：在地图上添加一个开发者标记点（查看下案例，了解params结构）
具体使用案例如下：

lua

    -- 参数说明

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local x, y, z = Actor:GetPosition(targetPlayerId)

    if x == nil or y == nil or z == nil then

        x, y, z = GetPlayerPos()

    end

    x, y, z = x or 0, y or 0, z or 0

    local params = {

        posX  = x,--（必填）

        posZ = z,--（必填）

        -- name ="测试名",   --名字

        iconName = "0_10074",  --图片路径（必填）

        -- zoomMin = 0,  --最小scale倍率

        -- zoomMax = 100,  --最大scale倍率

        -- isTrace = false,  --是否追踪 

        -- isRadarTrace = false,  --雷达上是否追踪

        -- appearInBlockFog = true,  --

        -- isCanUI = false,  --是否能点击

        -- desc = "",   --描述

        -- level = 4,  --UI层级

    }

    local result = World:PixelMapAddMarker(targetPlayerId, "markId_123", params, worldId)

PixelMapRefreshMarker

参数及类型：
- uin:number 玩家ID
- id:string 标记ID
- params:table 标记参数(提供改变的参数即可)
- worldid:number / nil 星球ID
返回值及类型：
- ret:boolean 是否刷新成功
该方法的其他说明：刷新地图上的开发者标记点（params 只需提供要变更的字段）
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local x, y, z = Actor:GetPosition(targetPlayerId)

    if x == nil or y == nil or z == nil then

        x, y, z = GetPlayerPos()

    end

    x, y, z = x or 0, y or 0, z or 0

    local params = {

        posX  = x,

        posZ = z,

        -- name = defaultCustomMarkerConfig[1].name,   名字

        iconName = "0_10103", --图片ID

        -- zoomMin = 0, 最小scale倍率

        -- zoomMax = 100, 最大scale倍率

        -- isTrace = false, 是否追踪 

        -- isRadarTrace = false, 雷达上是否追踪

        -- appearInBlockFog = true, 

        -- isCanUI = false, 是否能点击

        -- desc = "",  描述

        -- level = 4,  UI层级

    }

    local result = World:PixelMapRefreshMarker(targetPlayerId, "markId_123", params, worldId)

PixelMapDelMarker

参数及类型：
- uin:number 玩家ID
- id:string 标记ID
- worldid:number / nil 星球ID
返回值及类型：
- ret:boolean 是否删除成功
该方法的其他说明：删除地图上的开发者标记点
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local result = World:PixelMapDelMarker(targetPlayerId, "markId_123", worldId)

PixelMapAddTexture

参数及类型：
- uin:number 玩家ID
- id:string 纹理ID
- params:table 纹理参数
- worldid:number / nil 星球ID
返回值及类型：
- ret:boolean 是否添加成功
该方法的其他说明：在地图纹理节点上叠加一张纹理（可用于背景/遮罩/自定义装饰）
具体使用案例如下：

lua

    --开发者添加纹理到地图纹理节点，可以修饰原本的地图纹理(比如加背景，遮罩，自定义地图纹理)

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local x, y, z = Actor:GetPosition(targetPlayerId)

    if x == nil or y == nil or z == nil then

        x, y, z = GetPlayerPos()

    end

    x, y, z = x or 0, y or 0, z or 0

    local params = {

        filePath = "0_10103", --图片id

        width = 100,     --宽度

        height = 100,    --高度

        posX = x,      --在地图上的方块位置

        posZ = z,      --在地图上的方块位置

        level = 11,     --层级  官方地图纹理层级为10

        pivotX = 0,      --x轴锚点

        pivotY = 0,      --z轴锚点

        alpha = 1,     --透明度

        scale = 1,     --缩放

        rotation = 0,  --旋转

        colorR = 255, --颜色

        colorG = 255, --颜色

        colorB = 255, --颜色

    }

    local result = World:PixelMapAddTexture(targetPlayerId, "textureId_1", params, worldId)

PixelMapRefreshTexture

参数及类型：
- uin:number 玩家ID
- id:string 纹理ID
- params:table 纹理参数(提供改变的参数即可)
- worldid:number / nil 星球ID
返回值及类型：
- ret:boolean 是否刷新成功
该方法的其他说明：刷新地图上的开发者纹理标签（params 只需提供要变更的字段）
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local x, y, z = Actor:GetPosition(targetPlayerId)

    if x == nil or y == nil or z == nil then

        x, y, z = GetPlayerPos()

    end

    x, y, z = x or 0, y or 0, z or 0

    local params = {

        filePath = "0_10104", --图片id

        width = 100,     --宽度

        height = 100,    --高度

        posX = x,      --在地图上的方块位置

        posZ = z,      --在地图上的方块位置

        level = 11,     --层级  官方地图纹理层级为10

        pivotX = 0,      --x轴锚点

        pivotY = 0,      --z轴锚点

        alpha = 1,     --透明度

        scale = 1,     --缩放

        rotation = 0,  --旋转

        colorR = 255, --颜色

        colorG = 255, --颜色

        colorB = 255, --颜色

    }

    local result = World:PixelMapRefreshTexture(targetPlayerId, "textureId_1", params, worldId)

PixelMapDelTexture

参数及类型：
- uin:number 玩家ID
- id:string 纹理ID
- worldid:number / nil 星球ID
返回值及类型：
- ret:boolean 是否删除成功
该方法的其他说明：删除地图上的开发者纹理标签
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local result = World:PixelMapDelTexture(targetPlayerId, "textureId_1", worldId)

SetSkyBoxColorAnim

参数及类型：
- playerid:number 玩家ID
- itype:number 颜色属性枚举(SkyboxColor)SkyboxColor
- color:string 16进制颜色值(如0xffffff)
- animId:number 动画枚举(Easing)Easing
- animTime:number 动画时间
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：给指定玩家设置天空盒颜色参数（带动画过渡）
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local result = World:SetSkyBoxColorAnim(targetPlayerId, SkyboxColor.Moon, [=[0xffe082]=], Easing.Linear, 1, worldId)

SetTimeVanishingSpeed

参数及类型：
- speed:number 时间流逝速度
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置天空盒时间流逝速度
具体使用案例如下：

lua

    local result = World:SetTimeVanishingSpeed(20)

SetSkyBoxTemplate

参数及类型：
- value:number / string 模板值
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置天空盒模板（官方模板填数值，自定义模板填ID）
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(Player:GetHostUin())

    local result = World:SetSkyBoxTemplate(7, worldId)

SetSkyBoxMaps

参数及类型：
- itype:number 贴图类型(SkyboxMap)SkyboxMap
- url:string 图片链接
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置天空盒贴图
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(Player:GetHostUin())

    local result = World:SetSkyBoxMaps(SkyboxMap.Sky, [=[0_30011]=], worldId)

SetSkyBoxColor

参数及类型：
- time:number 游戏时间(小时)
- itype:number 颜色属性枚举(SkyboxColor)SkyboxColor
- color:string 16进制颜色值(如0xffffff)
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置天空盒在指定时间点的颜色参数
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(playerId or Player:GetHostUin())

    local time = SkyboxTime.Current

    local colorType = SkyboxColor.Top

    local color = [=[0x1e88e5]=]

    local result = World:SetSkyBoxColor(time, colorType, color, worldId)

SetSkyBoxAttr

参数及类型：
- time:number 游戏时间(小时)
- itype:number 参数类型(SkyboxAttr)SkyboxAttr
- value:number 参数值(0~100)
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置天空盒在指定时间点的属性参数
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(playerId or Player:GetHostUin())

    local time = SkyboxTime.Current

    local attr = SkyboxAttr.SunScale

    local value = 20

    local result = World:SetSkyBoxAttr(time, attr, value, worldId)

SetSkyBoxAttrWithNoTime

参数及类型：
- itype:number 参数类型(SkyboxAttrNoTime)SkyboxAttrNoTime
- value:number 参数值(0~100)
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置天空盒属性参数（不带时间维度，直接作用于当前配置）
具体使用案例如下：

lua

        local result = World:SetSkyBoxAttrWithNoTime(SkyboxAttrNoTime.Metallic, 50, worldId)

SetSkyBoxFilter

参数及类型：
- playerid:number 玩家ID
- itype:number 参数类型(SkyboxFilter)SkyboxFilter
- value:number / string 参数值(0~100)或16进制颜色值(如0xffffff)
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：给指定玩家设置天空盒滤镜参数（数值或颜色）
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local result = World:SetSkyBoxFilter(targetPlayerId, SkyboxFilter.Contrast, 50, worldId)

SetSkyBoxSwitch

参数及类型：
- time:number 游戏时间(小时)
- itype:number 参数类型(SkyboxSwitch)SkyboxSwitch
- value:number 开关值(0/1)
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置天空盒属性开关
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(Player:GetHostUin())

    local time = SkyboxTime.Current

    local switch = SkyboxSwitch.Fogenable

    local visible = true

    local result = World:SetSkyBoxSwitch(time, switch, visible, worldId)

SetSkyBoxMapsAnim

参数及类型：
- playerid:number 玩家ID
- itype:number 贴图类型(SkyboxMap)SkyboxMap
- url:string 图片链接
- animId:number 动画枚举(Easing)Easing
- animTime:number 动画时间
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：给指定玩家设置天空盒贴图（带动画过渡）
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local result = World:SetSkyBoxMapsAnim(targetPlayerId, SkyboxMap.Sky, [=[0_30005]=], Easing.BackOut, 1, worldId)

SetSkyBoxFilterAnim

参数及类型：
- playerid:number 玩家ID
- itype:number 参数类型(SkyboxFilter)SkyboxFilter
- value:number / string 参数值(0~100)或颜色值
- animId:number 动画枚举(Easing)Easing
- animTime:number 动画时间
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：给指定玩家设置天空盒滤镜参数（带动画过渡）
具体使用案例如下：

lua

    local targetPlayerId = playerId or Player:GetHostUin()

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local result = World:SetSkyBoxFilterAnim(targetPlayerId, SkyboxFilter.Color, [=[0xffee58]=], Easing.Linear, 1, worldId)

GetLocalDate

参数及类型：
- enum:number 枚举值（EventDate）
返回值及类型：
- ret:number 时间值
该方法的其他说明：获取本地设备时间的指定字段
具体使用案例如下：

lua

    local date = World:GetLocalDate(EventDate.Day)

GetLocalDateString

参数及类型：无
返回值及类型：
- ret:string 时间字符串
该方法的其他说明：获取完整本地设备时间字符串
具体使用案例如下：

lua

    local dateString = World:GetLocalDateString()

GetServerDate

参数及类型：
- enum:number 枚举值（EventDate）
返回值及类型：
- ret:number 时间值（取不到返回0）
该方法的其他说明：获取服务器时间的指定字段（云服模式下会回退到本地时间）
具体使用案例如下：

lua

    local date = World:GetServerDate()

GetDateFromTime

参数及类型：
- time:number 时间戳
- enum:number 枚举值（EventDate）EventDate
返回值及类型：
- ret:number 时间值（入参非法返回0）
该方法的其他说明：把时间戳拆出指定字段（年/月/日/时/分/秒等）
具体使用案例如下：

lua

    local date = World:GetDateFromTime(os.time(), EventDate.Day)

GetDirRayDetection

参数及类型：
- posbegin:table 起点{x=0,y=0,z=0}
- dir:table 方向向量{x=0,y=0,z=0}
- maxlen:number 最大检测距离
- picktype:number 检测类型(RayDetectType)RayDetectType
- worldId:number / nil 星球ID
- ignoreObjs:table / nil 忽略对象ID数组
- ignorePrefabs:table / nil 忽略方块/生物类型数组
返回值及类型： ret:number|nil,vec:table|nil:命中ID与命中位置{x=0,y=0,z=0}（未命中返回nil）
该方法的其他说明：从起点沿方向做射线检测，返回命中的对象/方块及命中位置
具体使用案例如下：

lua

    local uin = targetPlayerId

    local worldId = Actor:GetObjWorldId(targetPlayerId)

    local ray = Player:GetAimDir(uin)

    local x,y,z = Player:GetRayOriginPos(uin)

    local id,pos = World:GetDirRayDetection({x=x, y=y, z=z}, {x= ray.x, y= ray.y, z= ray.z}, 10, RayDetectType.Block, worldId)

GetRayLength

参数及类型：
- srcx|srcy|srcz:number 起点坐标
- dstx|dsty|dstz:number 终点坐标
- distance:number 最大检测距离
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:number / nil 射线长度（失败返回nil）
该方法的其他说明：从起点到终点方向做射线检测，计算射线在遇到方块前的长度
具体使用案例如下：

lua

    local length = World:GetRayLength(x, y, z, x, y + 20, z, 100, WorldId)

GetRayBlock

参数及类型：
- srcx|srcy|srcz:number 起点坐标
- face:number 方向/面
- distance:number 最大检测距离
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:number / string / nil 方块ID（可能返回自定义资源ID；未命中返回nil）
该方法的其他说明：从起点沿指定面/方向做射线检测，返回命中的方块ID（未命中返回nil）
具体使用案例如下：

lua

    local block = World:GetRayBlock(x, y, z, FaceDir.NegY, 100, WorldId)

CalcDirectionByYawDirection

参数及类型：
- objid:number 对象ID
- vx|vy|vz:number 局部方向分量
返回值及类型： ret:table|nil:世界方向向量{x: number, y: number, z: number}（失败返回nil）
该方法的其他说明：把局部坐标方向转换为世界方向（忽略视角仰角）
具体使用案例如下：

lua

    local direction = World:CalcDirectionByYawDirection(Player:GetHostUin(), 100, 100, 100)

CalcDirectionByYawAngle

参数及类型：
- objid:number 对象ID
- yaw:number 水平角(度制)
- pitch:number 俯仰角(度制)
返回值及类型：
- ret:table / nil 世界方向向量{x,y,z}（失败返回nil）
该方法的其他说明：把局部球坐标方向转换为世界方向（忽略视角仰角）
具体使用案例如下：

lua

    local direction = World:CalcDirectionByYawAngle(Player:GetHostUin(), 30, 45)

CalcDirectionByCoord

参数及类型：
- x:number 坐标分量x
- y:number 坐标分量y
- z:number 坐标分量z
返回值及类型： ret:table:方向向量{x: number, y: number, z: number}
该方法的其他说明：不做任何数学换算，只是把三个坐标放进一张表里
具体使用案例如下：

lua

    local direction = World:CalcDirectionByCoord(10 ,20, 30)

CalcDirectionByAngle

参数及类型：
- yaw:number 水平角(度制)
- pitch:number 俯仰角(度制)
返回值及类型： ret:table|nil:方向向量{x: number, y: number, z: number}（入参非法返回nil）
该方法的其他说明：把水平角和俯仰角转换为方向向量
具体使用案例如下：

lua

    local direction = World:CalcDirectionByAngle(45, 45)

RandomParticleEffectID

参数及类型：无
返回值及类型：
- ret:number / nil 特效ID（取不到返回nil）
该方法的其他说明：从粒子特效表中随机返回一个可触发的特效ID
具体使用案例如下：

lua

    local id = World:RandomParticleEffectID()

RandomSoundID

参数及类型：无
返回值及类型：
- ret:number / nil 音效ID（取不到返回nil）
该方法的其他说明：从音效表中随机返回一个音效ID
具体使用案例如下：

lua

    local id = World:RandomSoundID()

CalcDistance

参数及类型：
- posSrc:table:源坐标{x: number, y: number, z: number}
- posDst:table:目标坐标{x: number, y: number, z: number}
返回值及类型：
- ret:number / nil 两点距离（入参非法返回nil）
该方法的其他说明：计算两个三维坐标之间的直线距离
具体使用案例如下：

lua

    local distance = World:CalcDistance({x = 0, y = 0, z = 0}, {x = 10, y = 0, z = 0})

SetGroupWeather

参数及类型：
- groupid:number 天气组ID(WeatherGroup)WeatherGroup
- weatherid:number 天气ID(GroupWeatherType)GroupWeatherType
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置某个天气组的天气状态
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(playerId or Player:GetHostUin())

    local result = World:SetGroupWeather(WeatherGroup.Common, GroupWeatherType.Shine, worldId)

RandomWeatherID

参数及类型：无
返回值及类型：
- ret:number / nil 天气ID（取不到返回nil）
该方法的其他说明：从可用天气列表中随机一个天气ID
具体使用案例如下：

lua

    local id = World:RandomWeatherID()

GetGroupWeather

参数及类型：
- groupid:number 天气组ID(WeatherGroup)WeatherGroup
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:number / nil 天气值（入参非法返回nil）
该方法的其他说明：获取指定天气组当前的天气值
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(playerId or Player:GetHostUin())

    local weather = World:GetGroupWeather(WeatherGroup.Common, worldId)

SetSpawnPoint

参数及类型：
- x|y|z:number 方块坐标
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置世界默认出生点坐标
具体使用案例如下：

lua

    local result = World:SetSpawnPoint(x, y, z)

CalcDirectionByPos2Pos

参数及类型：
- pos1:table 位置1{x=number,y=number,z=number}
- pos2:table 位置2{x=number,y=number,z=number}
返回值及类型：
- ret:table / nil 单位方向{x,y,z}（入参非法返回nil）
该方法的其他说明：计算从位置1指向位置2的单位方向向量
具体使用案例如下：

lua

        local result = World:CalcDirectionByPos2Pos({x = x, y = y, z = z}, {x = x + 10, y = y, z = z})

SetWorldCreateMobRule

参数及类型：
- cfgs:table 生物规则配置
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置世界生物生成规则,地图没有这个地形会设置失败（不保存，退出游戏后失效）
具体使用案例如下：

lua

    local  cfgs = {

        -- 草原

        [BiomeType.GrassLand] = {

            {

                id = 3400, -- 生物id，嘟嘟鸟

                weight = 100 -- 权重

            },

            {

                id = 3401, -- 生物id

                weight = 100 -- 权重

            },

        },

        [BiomeType.Forest] = {--迷拉星森林

            {

                id = 3400,

                weight = 50

            }

        }

    }

    local result = World:SetWorldCreateMobRule(cfgs, worldId)

GetWorldCreateMobRule

参数及类型：
- biometype:number 地形类型(BiomeType), biometype < 0 返回全部, biometype > 0 返回指定地形BiomeType
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:table / nil biometype < 0 时返回 {[biomeId]={{id, weight}}}, biometype > 0 时返回 {{id, weight}}
该方法的其他说明：获取生物生成密度（不保存，退出游戏后失效）
具体使用案例如下：

lua

    local grassLandRules = World:GetWorldCreateMobRule(BiomeType.GrassLand, worldId)

    local forestRules = World:GetWorldCreateMobRule(BiomeType.Forest, worldId)

SetMobSpawnDensity

参数及类型：
- mobType:number
- density:number
- worldId:number|nil
返回值及类型： ret:boolean
该方法的主要作用：
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(playerId or Player:GetHostUin())

    local result = World:SetMobSpawnDensity(MobType.Passive, 100, worldId) -- 设置动物密度

SetPlantGrowRate

参数及类型：
- rate:number 时间倍率(>0)
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置农作物生长时间倍率（在原时间上乘以系数；不保存，退出游戏后失效）
具体使用案例如下：

lua

    local worldId = Actor:GetObjWorldId(playerId or Player:GetHostUin())

    local result = World:SetPlantGrowRate(0.5, worldId) -- 设置生长速度为原来的0.5倍

SetInnerViewEnable

参数及类型：
- iview:number 弹窗类型枚举(InnerPopUpview)InnerPopUpview
- bopen:boolean 启用(true)/禁用(false)
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置某类内置界面是否禁用
具体使用案例如下：

lua

    -- 一般和Player:OpenInnerView 接口配合使用

    local ret = World:SetInnerViewEnable(InnerPopUpview.CollectMaps,false)

    if ret then

        print("设置成功")

    end

SetMidJoin

参数及类型：
- enable:boolean 是否允许中途加入
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置是否允许中途加入
具体使用案例如下：

lua

    local ret = World:SetMidJoin(true)

    if ret then

        print("设置成功")

    end

GetGameMode

参数及类型：无
返回值及类型：
- ret:number / nil 游戏模式(WorldType)
该方法的其他说明：获取当前游戏模式
具体使用案例如下：

lua

    local curmode = World:GetGameMode()

    if curmode and curmode == WorldType.GamemakerRun then

        print("当前地图是玩法模式")

    elseif curmode and curmode == WorldType.Single then

        print("当前地图是冒险模式")

    end

SetLightByPos

参数及类型：
- x:number 位置x
- y:number 位置y
- z:number 位置z
- value:number 光照强度(0~15)
- worldId:number / nil 星球ID(默认当前主机所在星球)
返回值及类型：
- ret:boolean 是否设置成功
该方法的其他说明：设置指定位置的方块光照强度<1.50+>
具体使用案例如下：

lua

    local result = World:SetLightByPos(x, y, z, 10, WorldId)

    print("设置光照强度 10 ", result)

世界模块管理接口 World ​

StopParticleOnPos ​

SetParticleTransform ​

PlayParticle ​

GetLightByPos ​

SpawnCreature ​

DespawnActor ​

GetPlayerTotal ​

GetAllPlayers ​

GetSpawnPoint ​

FindCanSpawnMobPosList ​

FindNearestPlayerByPos ​

PlaySoundEffectOnPos ​

StopSoundEffectOnPos ​

PauseSoundEffectOnPos ​

IsDaytime ​

SetHours ​

GetHours ​

GetDay ​

SetGravity ​

AddGravity ​

GetGravity ​

IsChunkLoaded ​

CanMobSpawnOnPosXZ ​

GetHostWorldId ​

SpawnProjectile ​

SpawnProjectileByDir ​

GetBiomeType ​

GetBiomeGroup ​

FindEcosystem ​

PixelMapAddMarker ​

PixelMapRefreshMarker ​

PixelMapDelMarker ​

PixelMapAddTexture ​

PixelMapRefreshTexture ​

PixelMapDelTexture ​

SetSkyBoxColorAnim ​

SetTimeVanishingSpeed ​

SetSkyBoxTemplate ​

SetSkyBoxMaps ​

SetSkyBoxColor ​

SetSkyBoxAttr ​

SetSkyBoxAttrWithNoTime ​

SetSkyBoxFilter ​

SetSkyBoxSwitch ​

SetSkyBoxMapsAnim ​

SetSkyBoxFilterAnim ​

GetLocalDate ​

GetLocalDateString ​

GetServerDate ​

GetDateFromTime ​

GetDirRayDetection ​

GetRayLength ​

GetRayBlock ​

CalcDirectionByYawDirection ​

CalcDirectionByYawAngle ​

CalcDirectionByCoord ​

CalcDirectionByAngle ​

RandomParticleEffectID ​

RandomSoundID ​

CalcDistance ​

SetGroupWeather ​

RandomWeatherID ​

GetGroupWeather ​

SetSpawnPoint ​

CalcDirectionByPos2Pos ​

SetWorldCreateMobRule ​

GetWorldCreateMobRule ​

SetMobSpawnDensity ​

SetPlantGrowRate ​

SetInnerViewEnable ​

SetMidJoin ​

GetGameMode ​

SetLightByPos ​