沙盘引擎 (SEngine)

创意诞生沙盘世界,不止如此想象!

用户工具

站点工具


scripting:client:radar

这是本文档旧的修订版!




📚 Client/Radar

名词 解释
Radar 游戏雷达、小地图
Canvas 游戏大地图、平面地图
Compass 游戏顶部的方向、角度标尺

📒 Event

📘 OnRadarCanvasActive( active )

当游戏大地图(平面地图)开启或关闭时触发。

📒 Static Function

📘 Radar.SetActive()

设置游戏小地图开关。

function Radar.SetActive( active: bool )

📘 Radar.GetActive()

获取游戏小地图开关。

function Radar.GetActive(): bool

📘 Radar.SetCanvasActive()

设置游戏大地图开关。

function Radar.SetCanvasActive( active: bool )

📘 Radar.GetCanvasActive()

获取游戏大地图开关。

function Radar.GetCanvasActive(): bool

📘 Radar.SetCanvasAutoBound()

设置游戏大地图自动范围模式开关。

此模式启用后,将会使大地图类似【小地图】自动跟随效果,适用于非完整使用的小型地图、部分玩法类型使用。

function Radar.SetCanvasAutoBound( active: bool, fovScale: float = 1.0 )
  • fovScale:数值越大,可见范围越大

📘 Radar.GetCanvasAutoBound()

获取游戏大地图自动范围模式开关。

function Radar.GetCanvasAutoBound(): bool

📘 Radar.SetCompassActive()

设置游戏方向标尺开关。

function Radar.SetCompassActive( active: bool )

📘 Radar.GetCompassActive()

获取游戏方向标尺开关。

function Radar.GetCompassActive(): bool

📘 Radar.SetStyle()

设置游戏小地图风格(形状)。

注意:此方法每次执行后,为了兼容最新风格形状,将会自动执行一次Radar.SetSkin()

function Radar.SetStyle( style: int )
风格 说明
0 圆形(默认)
1 正方形
2 长方形(宽)

📘 Radar.GetStyle()

获取游戏小地图风格(形状)。

function Radar.GetStyle(): int

📘 Radar.SetSkin()

设置游戏小地图样式贴图。

注意:每当Radar.SetStyle()被执行后,Skin都将被自动重置为符合形状的内置贴图(0或1),如果有设置外部(10000+)贴图的需求,应该在每次设置形状(Radar.SetStyle())后执行一次此方法。

function Radar.SetSkin( skin: int )
//example for 'Radar.SetStyle()'
Radar.SetStyle(0); //circle
Radar.SetSkin(10000); //Custom circle style texture(*.png)
 
//or
Radar.SetStyle(1); //rectangular(or 'Radar.SetStyle(2)')
Radar.SetSkin(10000); //Custom rectangular style texture(*.png)
贴图 说明
0 内置圆形(Style == 0
1 内置矩形(正方形、长方形)(Style == 1 || 2
10000+ 放置在目录Store\Radar\Skin的贴图

📘 Radar.GetSkin()

获取游戏小地图样式贴图。

function Radar.GetSkin(): int

📘 Radar.SetSize()

设置游戏小地图尺寸缩放,默认值1.0

function Radar.SetSize( size: float )

📘 Radar.GetSize()

获取游戏小地图尺寸缩放。

function Radar.GetSize(): float

📘 Radar.SetPivot()

设置游戏小地图位置锚点。

function Radar.SetPivot( pivot: int )
Pivot 说明
0 左上
1 右上
2 左下
3 右下

📘 Radar.GetPivot()

获取游戏小地图位置锚点。

function Radar.GetPivot(): int

📘 Radar.SetPathTarget()

设置游戏地图导航线路目标。

注意:玩家仍然可以手动打开大地图设置目的地,两者使用相同的逻辑,如果不希望玩家手动修改目的地,可考虑每帧执行此方法。

function Radar.SetPathTarget( target: Vector, autoReset: bool = false )
  • target目标坐标
  • autoReset到达后自动取消导航

📘 Radar.GetPathTarget()

获取游戏地图导航线路目标。

注意:玩家仍然可以手动打开大地图设置目的地,两者使用相同的逻辑,因此此方法有可能得到的是玩家所设置的目的地。

function Radar.GetPathTarget(): Vector

📘 Radar.ResetPathTarget()

取消游戏地图导航线路目标。

function Radar.ResetPathTarget()

📘 Radar.SetPathTargetColor()

设置游戏地图导航线路颜色,默认值Color(255, 204, 0)

function Radar.SetPathTargetColor( color: Color )

📘 Radar.GetPathTargetColor()

获取游戏地图导航线路颜色。

function Radar.GetPathTargetColor(): Color

📘 Radar.SetFocusScale()

设置游戏小地图焦点视角缩放,默认值1.0

缩放数值越大,地图可见的区域越多,数值限制为0.5 ~ 5.0

function Radar.SetFocusScale( scale: float )

📘 Radar.GetFocusScale()

获取游戏小地图焦点视角缩放。

function Radar.GetFocusScale(): float

📘 Radar.SetFocusColor()

设置游戏小地图焦点遮罩颜色,默认值Color(255, 255, 255, 0)(默认Alpha == 0)。

此功能可设置小地图顶部半透明颜色遮罩,以提示玩家不同的状态(例如:被通缉时,可设置为黄色或红色)。

function Radar.SetFocusColor( color: Color )

📘 Radar.GetFocusColor()

获取游戏小地图焦点遮罩颜色。

function Radar.GetFocusColor(): Color

scripting/client/radar.1722776444.txt.gz · 最后更改: 2024/08/04 21:00 由 bibiboxs