SkyBox

天空盒

 用于改变天空盒表现

---

函数列表

SetSkyboxDisplayID

• 描述: 设置天空环境

• 描述: 用于动态改变游戏中的天空环境。

• 范围: 客户端

参数列表:

参数	类型	说明
SkyboxId	number	天空盒ID
Time	number	过渡时长

SkyBox:SetSkyboxDisplayID(1,1)

---

SetSkyBoxRotation

• 描述: 设置天空环境旋转

• 描述: 用于动态改变游戏中的天空环境旋转。

• 描述: 可调节范围：-180至180。

• 范围: 客户端

参数列表:

参数	类型	说明
SkyboxRotation	number	旋转角度

SkyBox:SetSkyBoxRotation(75)

---

SetDirectionalLightIntensity

• 描述: 设置光源强度

• 描述: 用于动态改变游戏中的光源强度。

• 描述: 可调节范围：0至10。

• 范围: 客户端

参数列表:

参数	类型	说明
LightIntensity	number	光源强度

SkyBox:SetDirectionalLightIntensity(10)

---

SetSkylightIntensityScale

• 描述: 设置天光强度

• 描述: 用于动态改变游戏中的天光强度。

• 描述: 可调节范围：0至2。

• 范围: 客户端

参数列表:

参数	类型	说明
LightIntensityScale	number	天光强度

SkyBox:SetSkylightIntensityScale(2)

---

SetDirectionalLightColor

• 描述: 设置光源颜色

• 描述: 用于动态改变游戏中的光源颜色。

• 范围: 客户端

参数列表:

参数	类型	说明
LightColor	string	光源颜色，十六进制颜色码：#FFFFFFFF

SkyBox:SetDirectionalLightColor("#23E0F0")

---

SetDirectionalLightPitch

• 描述: 设置光源高度角

• 描述: 用于动态改变游戏中的光源高度角。

• 描述: 可调节范围：-90至90。

• 范围: 客户端

参数列表:

参数	类型	说明
LightPitch	number	光源高度角

SkyBox:SetDirectionalLightPitch(45)

---

SetDirectionalLightYaw

• 描述: 设置光源方位角

• 描述: 用于动态改变游戏中的光源方位角。

• 描述: 可调节范围：-180至180。

• 范围: 客户端

参数列表:

参数	类型	说明
LightYaw	number	光源方位角

SkyBox:SetDirectionalLightYaw(-120)

---

SetSkyBoxFilterByFilterId

• 描述: 设置天空环境滤镜效果

• 范围: 客户端

参数列表:

参数	类型	说明
FilterId	number	天空滤镜Id

SkyBox:SetSkyBoxFilterByFilterId(17)

---

SetSkyBoxFilterIntensity

• 描述: 设置天空环境滤镜强度

• 范围: 客户端

参数列表:

参数	类型	说明
IntensityNumber	number	滤镜强度范围(0~100)

SkyBox:SetSkyBoxFilterIntensity(50)

---

SetSkyBoxFilterColorTemperature

• 描述: 设置天空环境滤镜色温

• 范围: 客户端

参数列表:

参数	类型	说明
ColorTemperatureNumber	number	色温值 范围(0~3)

SkyBox:SetSkyBoxFilterColorTemperature(1)

---

SetSkyBoxFilterHue

• 描述: 设置天空环境滤镜色调

• 范围: 客户端

参数列表:

参数	类型	说明
HueNumber	number	色调值 范围(-2~2)

SkyBox:SetSkyBoxFilterHue(1)

---

SetSkyBoxFilterExposure

• 描述: 设置天空环境滤镜曝光

• 范围: 客户端

参数列表:

参数	类型	说明
ExposureNumber	number	曝光值 范围(-10~10)

SkyBox:SetSkyBoxFilterExposure(-3)

---

SetSkyBoxFilterBrightness

• 描述: 设置天空环境滤镜亮度

• 范围: 客户端

参数列表:

参数	类型	说明
BrightnessNumber	number	亮度值 范围(0~3)

SkyBox:SetSkyBoxFilterBrightness(1)

---

SetSkyBoxFilterContrast

• 描述: 设置天空环境滤镜对比度

• 范围: 客户端

参数列表:

参数	类型	说明
ContrastNumber	number	对比度值 范围(0~3)

SkyBox:SetSkyBoxFilterContrast(2)

---

SetSkyBoxFilterSaturation

• 描述: 设置天空环境滤镜饱和度

• 范围: 客户端

参数列表:

参数	类型	说明
SaturationNumber	number	对比度值 范围(0~3)

SkyBox:SetSkyBoxFilterSaturation(0)

---

SetSkyBoxBloomIntensity

• 描述: 设置天空环境泛光强度(需启动泛光否则设置不生效)

• 范围: 客户端

参数列表:

参数	类型	说明
Intensity	number	泛光强度 范围(0~100)

SkyBox:SetSkyBoxBloomIntensity(50)

---

SetSkyBoxBloomThreshold

• 描述: 设置天空环境泛光阈值(需启动泛光否则设置不生效)

• 范围: 客户端

参数列表:

参数	类型	说明
Threshold	number	泛光阈值 范围(-1~8)

SkyBox:SetSkyBoxBloomThreshold(6)

---

SetSkyBoxVignetteIntensity

• 描述: 设置天空环境暗角强度(需启动暗角否则设置不生效)

• 范围: 客户端

参数列表:

参数	类型	说明
Intensity	number	暗角强度 范围(0~1)

SkyBox:SetSkyBoxVignetteIntensity(0.5)

---

ExecuteSkyBoxTranByTranIndex

• 描述: 根据变换索引执行天空环境变换

• 范围: 客户端

参数列表:

参数	类型	说明
TranIndex	number	变换索引

SkyBox:ExecuteSkyBoxTranByTranIndex(0)

---

SetSkyFog

• 描述: 设置雾效

• 描述: fogScatteringColor string 雾内散射颜色 十六进制颜色码：#FFFFFFFF

• 描述: fogMaxOpacity float （重要参数）最大透明度 0~1

• 描述: fogStartDistance float 雾起始距离 0~15000

• 描述: fogDensity float （重要参数）雾浓度 0~2

• 描述: fogHeight float 雾起始高度 -50000~50000

• 描述: fogHeightFalloff float 雾高度衰减指数 0~1

• 描述: directionalScatteringColor string 平行光散射颜色 十六进制颜色码：#FFFFFFFF

• 描述: directionalScatteringExponent float 散射指数 2~64

• 描述: directionalScatteringStartDistance float 散射起始距离 0~1000000

• 描述: fogAffectSkybox boolean 影响天空背景

• 范围: 客户端

参数列表:

参数	类型	说明
Enable	boolean	是否启用
Info	table	雾效参数,按照需要将需要设置的参数填入

local Info = {}
Info.fogScatteringColor = "#FFFFFFFF"
Info.fogMaxOpacity = 1
Info.fogStartDistance = 0
Info.fogDensity = 0.5
Info.fogHeight = 0
Info.fogHeightFalloff = 0.5
Info.directionalScatteringColor = "#FFFFFFFF"
Info.directionalScatteringExponent = 2
Info.directionalScatteringStartDistance = 0
Info.fogAffectSkybox = true
SkyBox:SetSkyFog(true, Info)

---