# 渐晕

# CheckVignetteEnabled

客户端

method in mod.client.component.postProcessControlComp.PostProcessComponent

  • 描述

    检测是否开启了屏幕渐晕(Vignette)效果。

  • 参数

  • 返回值

    数据类型
    说明
    bool True为已开启,False为已关闭。
  • 示例

import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
comp.CheckVignetteEnabled()

# SetEnableVignette

客户端

method in mod.client.component.postProcessControlComp.PostProcessComponent

  • 描述

    设置是否开启屏幕渐晕(Vignette)效果,开启后玩家屏幕周围将出现渐晕,可通过Vignette其他接口设置效果参数。

  • 参数

    参数名
    数据类型
    说明
    enable bool 是否开启Vignette效果,True为开启,False为关闭。
  • 返回值

    数据类型
    说明
    bool 设置是否成功
  • 示例

import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
comp.SetEnableVignette(True)

# SetVignetteCenter

客户端

method in mod.client.component.postProcessControlComp.PostProcessComponent

  • 描述

    设置渐晕(Vignette)的渐晕中心位置,可改变屏幕渐晕的位置。

  • 参数

    参数名
    数据类型
    说明
    center tuple(float,float) 按顺序分别为屏幕位置的x及y值。
  • 返回值

    数据类型
    说明
    bool 设置是否成功
  • 示例

import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
# 调整渐晕中心位置为屏幕中心
comp.SetVignetteCenter((0.5,0.5))

# SetVignetteRGB

客户端

method in mod.client.component.postProcessControlComp.PostProcessComponent

  • 描述

    设置渐晕(Vignette)的渐晕颜色,可改变屏幕渐晕的颜色。

  • 参数

    参数名
    数据类型
    说明
    color tuple(float,float,float) 按顺序分别为颜色的RGB值,值的范围为[0,255],小于或大于这个范围的值将被截取为边界值0或255
  • 返回值

    数据类型
    说明
    bool 设置是否成功
  • 示例

import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
# 设置颜色的值为红色。
comp.SetVignetteRGB((255,0,0))

# SetVignetteRadius

客户端

method in mod.client.component.postProcessControlComp.PostProcessComponent

  • 描述

    设置渐晕(Vignette)的渐晕半径,半径越大,渐晕越小,玩家的视野范围越大。

  • 参数

    参数名
    数据类型
    说明
    radius float 渐晕半径大小,值的范围为[0,1],小于或大于这个范围的值将被截取为边界值0或1
  • 返回值

    数据类型
    说明
    bool 设置是否成功
  • 示例

import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
# 调整渐晕半径为0.5
comp.SetVignetteRadius(0.5)

# SetVignetteSmoothness

客户端

method in mod.client.component.postProcessControlComp.PostProcessComponent

  • 描述

    设置渐晕(Vignette)的渐晕模糊系数,模糊系数越大,则渐晕边缘越模糊,模糊的范围也越大

  • 参数

    参数名
    数据类型
    说明
    radius float 渐晕模糊系数,值的范围为[0,1],小于或大于这个范围的值将被截取为边界值0或1
  • 返回值

    数据类型
    说明
    bool 设置是否成功
  • 示例

import mod.client.extraClientApi as clientApi
comp = clientApi.GetEngineCompFactory().CreatePostProcess(levelId)
# 调整渐晕模糊系数为0.5
comp.SetVignetteSmoothness(0.5)