API
Return to top
VirtualJoystickPanel
编辑

界面 / VirtualJoystickPanel

VirtualJoystickPanel Class
​

摇杆

Hierarchy ​

  • Widget

    ↳ VirtualJoystickPanel

Table of contents ​

Properties
​

click

Properties
​

onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client
监听自定义属性同步事件

Accessors
​

activeOpacity(): number client
返回激活时的透明度
backgroundDisabledImageId(): string client
返回背景图片禁用状态图片id
backgroundImageDesigner(): JoystickStyleDesigner client
返回输入的背景贴图设置，包括 普通的 点击的 不启用的
backgroundImageId(): string client
返回中心图片普通状态图片id
backgroundImageSize(): Vector2 client
摇杆背景图片大小
backgroundTouchImageId(): string client
返回背景图片按压状态图片id
center(): Vector2 client
返回输入的是摇杆中心位置， 不符合预期会返回默认值
centerDisableImageId(): string client
返回中心图片禁用状态图片id
centerImageDesigner(): JoystickStyleDesigner client
返回输入的中心贴图设置，包括 普通的 点击的 不启用的
centerImageId(): string client
返回中心图片普通状态图片id
centerImageSize(): Vector2 client
摇杆按钮图片大小
centerTouchImage(): string client
返回中心图片按压状态图片id
controlByMouseEnable(): boolean client
获取是否被鼠标控制，只作用于PC端
controlType(): CameraControlType client
返回输入的是摇杆类型， 不符合预期会返回默认值
inActiveOpacity(): number client
返回未激活时的透明度
inputScale(): Vector2 client
返回输入的输入比例
isLocationFixed(): boolean client
拖动后，是否固定摇杆位置
onInputDir(): MulticastDelegate<(vec: Vector2) => void> client
输入移动事件
onJoyStickDown(): MulticastDelegate<() => void> client
摇杆按下事件的代理
onJoyStickUp(): MulticastDelegate<() => void> client
摇杆抬起事件的代理
timeUntilInactive(): number client
进入未激活状态的时间
timeUntilReset(): number client
释放摇杆后的复位时间
click

Accessors
​

alignPosition(): Readonly<Vector2> client
获取控件的对齐位置,在对齐方式为靠右对齐、靠下对齐、中心对齐时，alignPosition的值与positon不同；
autoSizeHorizontalEnable(): boolean client
获取是否自动水平设置大小
autoSizeVerticalEnable(): boolean client
获取是否自动垂直设置大小
cachedGeometry(): Geometry client
获取上一次的GetTickSpaceGeometry
constraints(): Readonly<UIConstraintAnchors> client
获取控件的布局
desiredSize(): Vector2 client
获取期望大小
enable(): boolean client
是否可用
guid(): string client
获取控件GUID
isHovered(): boolean client
是否是hovered
mouseCursor(): MouseCursor client
获取控件上光标类型
name(): string client
获取名字
paintSpaceGeometry(): Geometry client
获取最后一次用于渲染Widget的几何信息
parent(): Widget client
获取父节点
pivot(): Vector2 client
获取控件锚点位置,这个属性决定了控件图形与锚点的相对位置；(0,0)时，锚点位于控件左上角；(0.5,0.5)时，锚点位于控件正中心
position(): Readonly<Vector2> client
获取控件的位置
renderOpacity(): number client
获取渲染透明度
renderScale(): Vector2 client
获取渲染缩放
renderShear(): Vector2 client
获取渲染错切形变
renderTransformAngle(): number client
获取渲染的角度
renderTransformPivot(): Vector2 client
获取渲染锚点
size(): Vector2 client
获取大小
tickSpaceGeometry(): Geometry client
获取最后一次用于驱动Widget Tick的几何信息
transform(): Readonly<UITransform> client
得到控件的大小和位置
visibility(): SlateVisibility client
获取可见性
visible(): boolean client
是否可见
zOrder(): number client
获取zorder

Methods
​

addKey(key: JoystickBindKeyType): void client
同一按键同时只能操控一个UI控件，最新绑定的UI控件会覆盖之前的绑定；脚本中添加的绑定无法覆盖编辑器按键绑定菜单中绑定相同按键的UI控件，但当两个UI控件分别通过代码和菜单绑定到同一按键时，使用代码绑定的优先级更高
getKeys(): JoystickBindKeyType[] client
获取当前UI控件绑定的所有键盘按键，包括编辑器按键绑定菜单和用代码绑定的按键
removeKey(key: JoystickBindKeyType): void client
此操作只会解绑动态绑定的按键无法解除编辑器按键绑定菜单中绑定的按键
resetJoyStick(): void client
强制重置摇杆 - 例如在操控摇杆的时候隐藏其父类节点,这时候摇杆重新显示后无法成功重置
setVisibility(Visibility: SlateVisibility): void client
设置可见性
newObject(Outer?: Widget, InName?: string): VirtualJoystickPanel client
创建 VirtualJoystickPanelDesigner 控件
newObjectAndAdd(InCanvas?: Canvas, Outer?: Widget, InName?: string): VirtualJoystickPanel client
创建 TouchPad 控件
click

Methods
​

addChild(child: Widget): void client
添加子节点
clone(position: Vector2, Parent?: Widget): Widget client
克隆UI控件及其子节点到指定父控件位置（默认到其父节点）
destroyObject(): void client
立刻移除并销毁 不可以在使用
equal(that: Widget): boolean client
判断是不是同一个对象
findChildByPath(inPath: string): Widget client
通过相对路径查找节点
getChildAt(index: number): Widget client
获取第几位子节点
getChildByName<T: extends Widget<T>>(name: string): T: extends Widget<T> client
通过名字查找节点
getChildrenCount(): number client
获取子节点数量
getCustomProperties(): string[] client
获取所有自定义属性
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType client
获取自定义属性
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client
给定对象属性修改时触发的事件代理
invalidateLayoutAndVolatility(): void client
立刻触发重新渲染的和排布计算
removeAllChildren(): void client
清除所有子节点,会销毁UI无法再使用
removeChild(child: Widget): void client
移除节点,会销毁UI无法在使用
removeChildAt(index: number): void client
移除第几个节点,会销毁UI无法再使用
removeObject(): void client
立刻移除并添加到根节点 可以再使用
serialize(): string client
序列化UI控件
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void client
设置自定义属性
deserialize(Data: string, Parent?: Widget): Widget client
反序列化UI

Properties ​

Accessors ​

activeOpacity
​

• get activeOpacity(): number client

• set activeOpacity(Value): void client

返回激活时的透明度

Returns ​

number返回激活时的透明度

设置激活时的透明度

Parameters ​

Value number透明度

backgroundDisabledImageId
​

• get backgroundDisabledImageId(): string client

• set backgroundDisabledImageId(id): void client

返回背景图片禁用状态图片id

Returns ​

string返回背景图片禁用状态图片id

设置背景图片禁用状态图片id

Parameters ​

id string资源id

backgroundImageDesigner
​

• get backgroundImageDesigner(): JoystickStyleDesigner client

返回输入的背景贴图设置，包括 普通的 点击的 不启用的

Returns ​

JoystickStyleDesigner返回输入的背景贴图设置，包括 普通的 点击的 不启用的

backgroundImageId
​

• get backgroundImageId(): string client

• set backgroundImageId(id): void client

返回中心图片普通状态图片id

Returns ​

string返回中心图片普通状态图片id

设置背景图片普通状态图片id

Parameters ​

id string资源id

backgroundImageSize
​

• get backgroundImageSize(): Vector2 client

• set backgroundImageSize(inSize): void client

摇杆背景图片大小

Returns ​

Vector2摇杆背景图片大小

摇杆背景图片大小

Parameters ​

inSize Vector2摇杆背景图片大小

backgroundTouchImageId
​

• get backgroundTouchImageId(): string client

• set backgroundTouchImageId(id): void client

返回背景图片按压状态图片id

Returns ​

string返回背景图片按压状态图片id

设置背景图片按压状态图片id

Parameters ​

id string资源id

center
​

• get center(): Vector2 client

• set center(inValue): void client

返回输入的是摇杆中心位置， 不符合预期会返回默认值

Returns ​

Vector2回输入的是摇杆中心位置， 不符合预期会返回默认值

设置输入的中心位置

Parameters ​

inValue Vector2新的中心位置

centerDisableImageId
​

• get centerDisableImageId(): string client

• set centerDisableImageId(id): void client

返回中心图片禁用状态图片id

Returns ​

string返回中心图片禁用状态图片id

设置中心图片禁用状态图片id

Parameters ​

id string资源id

centerImageDesigner
​

• get centerImageDesigner(): JoystickStyleDesigner client

返回输入的中心贴图设置，包括 普通的 点击的 不启用的

Returns ​

JoystickStyleDesigner返回中心贴图设置

centerImageId
​

• get centerImageId(): string client

• set centerImageId(id): void client

返回中心图片普通状态图片id

Returns ​

string返回中心图片普通状态图片id

设置中心图片普通状态图片id

Parameters ​

id string资源id

centerImageSize
​

• get centerImageSize(): Vector2 client

• set centerImageSize(inSize): void client

摇杆按钮图片大小

Returns ​

Vector2摇杆按钮图片大小

摇杆按钮图片大小

Parameters ​

inSize Vector2摇杆按钮图片大小

centerTouchImage
​

• get centerTouchImage(): string client

• set centerTouchImage(id): void client

返回中心图片按压状态图片id

Returns ​

string返回中心图片按压状态图片id

置中心图片按压状态图片id

Parameters ​

id string资源id

controlByMouseEnable
​

• get controlByMouseEnable(): boolean client

• set controlByMouseEnable(controlByMouse): void client

获取是否被鼠标控制，只作用于PC端

Returns ​

boolean是否被鼠标控制

设置是否被鼠标控制，只作用于PC端

Parameters ​

controlByMouse boolean是否被鼠标控制

controlType
​

• get controlType(): CameraControlType client

• set controlType(NewControlType): void client

返回输入的是摇杆类型， 不符合预期会返回默认值

Returns ​

CameraControlType返回输入的摇杆类型

设置输入的摇杆类型，人物的移动和技能摇杆的移动类型

Parameters ​

NewControlType CameraControlType摇杆类型

inActiveOpacity
​

• get inActiveOpacity(): number client

• set inActiveOpacity(Value): void client

返回未激活时的透明度

Returns ​

number返回未激活时的透明度

设置未激活时的透明度

Parameters ​

Value number透明度

inputScale
​

• get inputScale(): Vector2 client

• set inputScale(inScale): void client

返回输入的输入比例

Returns ​

Vector2返回输入的输入比例

设置输入的输入比例

Parameters ​

inScale Vector2新的输入比例

isLocationFixed
​

• get isLocationFixed(): boolean client

• set isLocationFixed(enable): void client

拖动后，是否固定摇杆位置

Returns ​

booleanboolean

拖动后，是否固定摇杆位置

Parameters ​

enable boolean是否固定摇杆位置

onInputDir
​

• get onInputDir(): MulticastDelegate<(vec: Vector2) => void> client

输入移动事件

Returns ​

MulticastDelegate<(vec: Vector2) => void>输入移动事件

onJoyStickDown
​

• get onJoyStickDown(): MulticastDelegate<() => void> client

摇杆按下事件的代理

Returns ​

MulticastDelegate<() => void>按下摇杆事件的代理

onJoyStickUp
​

• get onJoyStickUp(): MulticastDelegate<() => void> client

摇杆抬起事件的代理

Returns ​

MulticastDelegate<() => void>抬起摇杆事件的代理

timeUntilInactive
​

• get timeUntilInactive(): number client

• set timeUntilInactive(Value): void client

进入未激活状态的时间

Returns ​

number进入未激活状态的时间，以秒为单位

进入未激活状态的时间

Parameters ​

Value number进入未激活状态的时间，以秒为单位

timeUntilReset
​

• get timeUntilReset(): number client

• set timeUntilReset(Value): void client

释放摇杆后的复位时间

Returns ​

number复位时间 以秒为单位

释放摇杆后的复位时间

Parameters ​

Value number复位时间 以秒为单位

Methods ​

addKey
​

• addKey(key): void client

同一按键同时只能操控一个UI控件，最新绑定的UI控件会覆盖之前的绑定；脚本中添加的绑定无法覆盖编辑器按键绑定菜单中绑定相同按键的UI控件，但当两个UI控件分别通过代码和菜单绑定到同一按键时，使用代码绑定的优先级更高

Parameters ​

key JoystickBindKeyType按键

getKeys
​

• getKeys(): JoystickBindKeyType[] client

获取当前UI控件绑定的所有键盘按键，包括编辑器按键绑定菜单和用代码绑定的按键

Returns ​

JoystickBindKeyType[]返回当前控件绑定的按键,可能为空

removeKey
​

• removeKey(key): void client

此操作只会解绑动态绑定的按键无法解除编辑器按键绑定菜单中绑定的按键

Parameters ​

key JoystickBindKeyType按键

resetJoyStick
​

• resetJoyStick(): void client

强制重置摇杆 - 例如在操控摇杆的时候隐藏其父类节点,这时候摇杆重新显示后无法成功重置

setVisibility
​

• setVisibility(Visibility): void client

设置可见性

Parameters ​

Visibility SlateVisibility可见性

newObject
​

• Static newObject(Outer?, InName?): VirtualJoystickPanel client

创建 VirtualJoystickPanelDesigner 控件

Parameters ​

Outer? Widget创建控件的外 Outer 对象 default:null
InName? string创建控件的名称 default:null range:设置合理的名称即可

Returns ​

VirtualJoystickPanel返回创建的控件

newObjectAndAdd
​

• Static newObjectAndAdd(InCanvas?, Outer?, InName?): VirtualJoystickPanel client

创建 TouchPad 控件

Parameters ​

InCanvas? Canvas父节点 default:null
Outer? Widget创建控件的外 Outer 对象 default:null
InName? string创建控件的名称 default: null range:设置合理的名称即可

Returns ​

VirtualJoystickPanel返回创建的对象

当 Outer 和 InName 与已有的对象相同时，旧的对象会被销毁