ZEPETO.Character.Controller
117 分
类型 说明 zepetoplayers /#zepetoplayers 用于同时控制 zepeto 玩家与 zepeto 角色的管理器类。 spawninfo /#spawninfo 表示 zepeto 角色的生成位置。 zepetocharacter /#zepetocharacter 表示可在 zepeto world 中加载并控制的 zepeto 角色。 cameradata /#cameradata 表示 zepetocamera 的初始配置。 characterdata /#characterdata 表示 zepetocharacter 的初始配置。 controllerdata /#controllerdata 表示 zepetoplayercontrol 的配置。 floatinguidata /#floatinguidata 负责管理角色相关 ui 设置的类。 localplayer /#localplayer 用于管理本地玩家动作的类,涵盖移动、服装自定义以及 zepeto 摄像机交互。 zepetocamera /#zepetocamera 为 zepeto character controller 内使用而设计的摄像机控制类。 zepetoplayer /#zepetoplayer 表示 zepeto 玩家。 zepetoplayercontrol /#zepetoplayercontrol 管理 zepeto 玩家的输入控制。 zepetocameracontrol /#zepetocameracontrol 管理 zepeto 环境中的摄像机控制,包括摄像机移动与缩放的输入处理。 characterstate /#characterstate 表示 zepeto 角色的状态。 charactermovestate /#charactermovestate 表示 zepeto 角色的详细移动状态。 characterjumpstate /#characterjumpstate 表示 zepeto 角色的详细跳跃状态。 characterlandingstate /#characterlandingstate 表示 zepeto 角色的详细落地状态。 knowsockets /#knowsockets 定义角色上一组已知的挂点(socket)。 motionstate /#motionstate 用于管理角色动作状态与配置的类。 characterstatemachine /#characterstatemachine 负责将 animator 与 zepeto 角色的角色状态保持同步的类。 statemachine /#statemachine statemachine 用于管理 states 、 transitions 和 events 。它会根据指定条件和经过时间更新状态,从而实现对对象各种状态的定义与控制。 statestatus /#statestatus 表示状态机中某个状态可能处于的状况,用于指示该状态生命周期的当前阶段。 custommotiondata /#custommotiondata 表示角色动作的自定义配置。 charactershadow /#charactershadow 负责管理 zepeto 角色阴影的类。 camerastate /#camerastate 表示 zepetocamera 的状态。 zepetoscreenstick /#zepetoscreenstick 用于处理 zepeto 环境中摇杆交互的类。 zepetoscreencontrol /#zepetoscreencontrol 用于在 zepeto 环境中创建 ui 控件的抽象类。 zepetoscreenbutton /#zepetoscreenbutton 用于处理 zepeto 环境中按钮交互的类。 zepetoscreentouchpad /#zepetoscreentouchpad 用于处理 zepeto 环境中触摸板交互的类。 uizepetoplayercontrol /#uizepetoplayercontrol 为本地玩家角色提供基于 ui 的控制的类。 inputhelper /#inputhelper 用于辅助输入处理的工具类。 eventreceiver /#eventreceiver 负责处理 zepeto world 内角色相关事件或通用事件的类。 transitionbase /#transitionbase 用于定义状态机中状态之间转换的基类。 state /#state 表示状态机中的一个状态。 transition /#transition 用于定义状态机中状态之间转换的泛型类。 zepetocharacter loadingstatus /#zepetocharacterloadingstatus zepeto 角色的加载状态。 playercontrolmode /#playercontrolmode enum zepetoplayers class 用于同时控制 zepeto 玩家与 zepeto 角色的管理器类。 属性 名称 类型 说明 cameradata cameradata /#cameradata zepetocamera 的配置。 characterdata characterdata /#characterdata zepetocharacter 的配置。 controllerdata controllerdata /#controllerdata zepetoplayercontrol 的配置。 floatinguidata floatinguidata /#floatinguidata 角色相关的 ui 设置。 instance (static) zepetoplayers /#zepetoplayers zepetoplayers 的单例实例。 localplayer localplayer /#localplayer 本地玩家。 zepetocamera zepetocamera /#zepetocamera zepeto 摄像机。 事件 名称 类型 说明 onaddedlocalplayer unityevent 创建本地玩家实例时触发的事件。 onaddedplayer unityevent\<string> 创建玩家实例时触发的事件。 onremovedplayer unityevent\<string> 移除玩家实例时触发的事件。 方法 add oninitialized static add oninitialized(value action) → void 为 zepetoplayers 初始化时调用的事件添加处理函数。 参数 类型 value action remove oninitialized static remove oninitialized(value action) → void 移除 zepetoplayers 初始化时调用的事件的处理函数。 参数 类型 value action hasplayer hasplayer(id string) → boolean 检查是否存在与指定会话 id 关联的玩家实例。 参数 类型 说明 id string 会话 id 返回值: boolean getplayer getplayer(id string) → zepetoplayer 获取与指定会话 id 关联的玩家实例。 参数 类型 说明 id string 会话 id 返回值: zepetoplayer /#zepetoplayer — 与指定 id 关联的玩家对象。 若不存在该 id 对应的玩家,则返回 null 。 getplayerwithuserid getplayerwithuserid(userid string) → zepetoplayer 获取与指定用户 id 关联的玩家实例。 参数 类型 说明 userid string 用户 id 返回值: zepetoplayer /#zepetoplayer — 与指定用户 id 关联的玩家对象。 removeplayer removeplayer(id string) → void 移除与指定会话 id 关联的玩家实例。 参数 类型 说明 id string 会话 id deformdefaultcostume deformdefaultcostume() → void 移除所有玩家角色所穿戴的体型变形道具。 恢复为默认体型并应用默认 zepeto 服装。 deformdefaultproperties deformdefaultproperties() → void 移除所有玩家角色所穿戴的体型变形道具。 spawninfo class 表示 zepeto 角色的生成位置。 属性 名称 类型 说明 default (static) spawninfo /#spawninfo 默认生成位置。 position vector3 zepeto 角色生成时的位置。 rotation quaternion zepeto 角色生成时的旋转。 zepetocharacter class 表示可在 zepeto world 中加载并控制的 zepeto 角色。 属性 名称 类型 说明 additionalwalkspeed number 获取附加的行走速度。 additionalrunspeed number 获取附加的奔跑速度。 additionaljumppower number 获取附加的跳跃力。 constraintrotation boolean 决定是否限制角色的旋转。 zepetoanimator animator zepeto 角色的 animator。 walkspeed number 获取总行走速度,即基础速度与附加速度之和。 runspeed number 获取总奔跑速度,即基础速度与附加速度之和。 jumppower number 获取总跳跃力,即基础跳跃力与附加跳跃力之和。 basewalkspeed number 获取基础行走速度。 baserunspeed number 获取基础奔跑速度。 basejumppower number 获取基础跳跃力。 trymove boolean 表示角色是否正在尝试移动。 tryjump boolean 表示角色是否正在尝试跳跃。 trydoublejump boolean 表示角色是否正在尝试二段跳。 motionstate motionstate /#motionstate 角色的动作状态与配置。 loadingstatus loadingstatus /#zepetocharacterloadingstatus 角色的加载状态。 context zepetocontext 角色的 zepeto context。 statemachine characterstatemachine /#characterstatemachine 角色的状态机。 currentstate characterstate /#characterstate 状态机中定义的角色当前状态。 currentstatestatus statestatus /#statestatus 状态机中定义的角色当前状态的状况。 elapsedtime number 自角色初始化以来经过的时间(秒)。 事件 名称 类型 说明 onchangedstate unityevent\<characterstate, characterstate> 角色状态发生变化时触发的事件。已注册的监听器会收到两个参数: 新的角色状态。(类型: characterstate ) 之前的角色状态。(类型: characterstate ) onupdatestate unityevent\<characterstate> 角色状态处于 statestatus update 状况时触发的事件。已注册的监听器会收到一个参数: 当前的角色状态。(类型: characterstate ) 方法 syncstateanimation syncstateanimation() → void 将 animator 与 zepeto 角色的当前角色状态同步。 changestateanimation changestateanimation(state characterstate) → void 在 animator 上播放与所提供角色状态相对应的动画。 参数 类型 说明 state characterstate /#characterstate 表示要播放动画的角色状态。 changestateanimation changestateanimation(state characterstate, movestate charactermovestate) → void 在 animator 上播放与所提供角色状态相对应的动画。 参数 类型 说明 state characterstate /#characterstate 表示要播放动画的角色状态。 movestate charactermovestate /#charactermovestate 当 state 为 characterstate move 时用于动画的移动状态(可选)。 changestateanimation changestateanimation(state characterstate, jumpstate characterjumpstate) → void 在 animator 上播放与所提供角色状态相对应的动画。 参数 类型 说明 state characterstate /#characterstate 表示要播放动画的角色状态。 jumpstate characterjumpstate /#characterjumpstate 当 state 为 characterstate jump 时用于动画的跳跃状态(可选)。 changestateanimation changestateanimation(state characterstate, landingstate characterlandingstate) → void 在 animator 上播放与所提供角色状态相对应的动画。 参数 类型 说明 state characterstate /#characterstate 表示要播放动画的角色状态。 landingstate characterlandingstate /#characterlandingstate 当 state 为 characterstate landing 时用于动画的落地状态(可选)。 move move(dir vector2) → void 使角色朝指定方向移动。 参数 类型 说明 dir vector2 角色应移动的方向。 move move(dir vector3) → void 使角色朝指定方向移动。 参数 类型 说明 dir vector3 角色应移动的方向。 movecontinuously movecontinuously(dir vector2) → void 以角色当前朝向为基准,使其朝指定方向持续移动。 参数 类型 说明 dir vector2 以角色当前朝向为基准,角色应移动的方向。 movecontinuously movecontinuously(dir vector3) → void 以角色当前朝向为基准,使其朝指定方向持续移动。 参数 类型 说明 dir vector3 以角色当前朝向为基准,角色应移动的方向。 movetoposition movetoposition(pos vector3) → void 使角色移动到指定位置。 参数 类型 说明 pos vector3 角色应移动到的目的地。 stopmoving stopmoving() → void 停止角色的移动。 jump jump() → void 使角色跳跃。 doublejump doublejump() → void 使角色进行二段跳。 teleport teleport(pos vector3, rot quaternion) → void 将角色瞬间移动到指定的 transform。 参数 类型 说明 pos vector3 角色将被传送到的位置。 rot quaternion 角色传送后的旋转。 setgesture setgesture(gesture animationclip) → void 播放角色对应指定手势的动作。 参数 类型 说明 gesture animationclip 角色将执行的手势。 cancelgesture cancelgesture() → void 停止手势的播放。 getsocket getsocket(socket knowsockets) → transform 获取角色某个挂点的 transform 。 参数 类型 说明 socket knowsockets /#knowsockets 挂点(socket)。 返回值: transform — 与指定挂点关联的 transform 组件。 getsocket getsocket(socket string) → transform 获取角色某个挂点的 transform 。 参数 类型 说明 socket string 挂点(socket)的名称。 返回值: transform — 与指定挂点关联的 transform 组件。 getbodymodifierproperties getbodymodifierproperties() → zepetopropertyflag\[] 获取与角色所穿戴体型变形道具关联的角色属性。 返回值: zepetopropertyflag\[] — 与角色所穿戴体型变形道具关联的角色属性。 deformdefaultproperties deformdefaultproperties() → void 移除角色所穿戴的体型变形道具,并恢复为默认体型。 deformdefaultcostume deformdefaultcostume() → void 移除角色所穿戴的体型变形道具,恢复为默认体型,并应用默认 zepeto 服装。 add loadedcharacter add loadedcharacter(value action) → void 添加用于处理角色加载完成的回调函数。 参数 类型 value action remove loadedcharacter remove loadedcharacter(value action) → void 移除用于处理角色加载完成的回调函数。 参数 类型 value action cameradata class 表示 zepetocamera 的初始配置。 属性 名称 类型 说明 cameraprefab gameobject 用于初始化 zepetocamera 的预制件。 maxzoomdistance number 摄像机可从目标拉远的默认最大距离。 minzoomdistance number 摄像机可向目标拉近的默认最小距离。 maxpitch number 摄像机绕目标旋转的最大垂直角度。 minpitch number 摄像机绕目标旋转的最小垂直角度。 offset vector3 摄像机相对于目标的默认偏移。 lockxaxis boolean 表示摄像机的 x 轴旋转是否被锁定。 layer layermask 定义摄像机可与之发生碰撞的层。 collisiontimethreshold number 摄像机碰撞检测的时间阈值,影响摄像机对碰撞的响应速度。 zoomspeed number 缩放的速度。 zoomdampspeed number 缩放的插值速度。 rotationspeed number 旋转的速度。 rotationdampspeed number 旋转的插值速度。 characterculling boolean 表示是否启用角色剔除,以避免摄像机距离过近时出现渲染问题。 targetscaleweight number 应用于目标缩放的权重,用于调整摄像机的位置与行为。 characterdata class 表示 zepetocharacter 的初始配置。 属性 名称 类型 说明 slopelimit number 角色可攀爬的最大坡度。 stepoffset number 角色可跨越的最大垂直高度差。 skinwidth number 用于碰撞检测的皮肤宽度,可防止角色陷入其他碰撞体。 minmovedistance number 角色可通过的最小间隙。 center vector3 角色碰撞体的中心点。 radius number 角色胶囊碰撞体的半径。 height number 角色胶囊碰撞体的高度。 layer layermask 定义角色可与之发生碰撞的层。 shadow gameobject 角色阴影的视觉表现。 animatorcontroller runtimeanimatorcontroller 角色的 animator controller。 walkspeed number 角色的行走速度。 runspeed number 角色的奔跑速度。 jumppower number 角色的跳跃力。 custommotiondata custommotiondata /#custommotiondata 角色动作的自定义配置。 controllerdata class 表示 zepetoplayercontrol 的配置。 属性 名称 类型 说明 inputasset inputactionasset 用于管理复杂输入配置的输入操作与绑定容器。 eventsystem gameobject 处理用户输入并传递给 ui 组件。负责按钮点击、拖动、放置等交互。 usedefaultvirtualcontroller boolean 决定是否使用默认 v pad。 usedefaultinputcontroller boolean 决定是否使用默认输入控制器。 verticalcontroller gameobject 用于竖屏方向的 v pad 控制器预制件。 horizontalcontroller gameobject 用于横屏方向的 v pad 控制器预制件。 floatinguidata class 负责管理角色相关 ui 设置的类。 属性 名称 类型 说明 shownicknamelocalplayer boolean 决定是否显示本地玩家角色的昵称 ui。 shownicknameotherplayers boolean 决定是否显示其他玩家角色的昵称 ui。 showbubblechatlocalplayer boolean 决定是否显示本地玩家角色的气泡聊天 ui。 showbubblechatotherplayers boolean 决定是否显示其他玩家角色的气泡聊天 ui。 useminiprofileonapp boolean 决定点击角色时是否显示迷你资料弹窗 ui。 localplayer class 用于管理本地玩家动作的类,涵盖移动、服装自定义以及 zepeto 摄像机交互。 属性 名称 类型 说明 movingaxis transform 本地玩家 zepeto 角色的移动中心轴。 zepetocamera zepetocamera /#zepetocamera 与本地玩家关联的 zepeto 摄像机实例。 zepetoplayer zepetoplayer /#zepetoplayer 与本地玩家关联的 zepeto 玩家实例。 方法 setcostume setcostume(itemcode string, complete? action) → void 更改本地玩家 zepeto 角色的服装。会抛出通用 exception 。 参数 类型 说明 itemcode string 服装的道具 id。 complete (可选) action 用于处理完成事件的回调函数。 jump jump() → void 使本地玩家的 zepeto 角色跳跃。 doublejump doublejump() → void 使本地玩家的 zepeto 角色进行二段跳。 move move(dir vector2) → void 使本地玩家的 zepeto 角色朝指定方向移动。 参数 类型 说明 dir vector2 角色应移动的方向。 move move(dir vector3) → void 使本地玩家的 zepeto 角色朝指定方向移动。 参数 类型 说明 dir vector3 角色应移动的方向。 stopmoving stopmoving() → void 停止本地玩家的 zepeto 角色。 zepetocamera class 为 zepeto character controller 内使用而设计的摄像机控制类。 属性 名称 类型 说明 additionalmaxzoomdistance number 在默认最大缩放值基础上追加的距离。 additionalminzoomdistance number 在默认最小缩放值基础上追加的距离。 additionaloffset vector3 应用于摄像机相对目标位置的额外偏移。 currentstate camerastate /#camerastate 获取当前的摄像机状态。 currentstatestatus statestatus /#statestatus 获取当前摄像机状态的状况。 position vector3 获取当前摄像机的位置值。 rotation quaternion 获取当前摄像机的旋转值。 distance number 与目标之间的距离。 cameraparent transform 摄像机父物体的 transform 。 isfollow boolean 获取表示摄像机是否正在跟随目标的标志。 statemachine statemachine\<camerastate> /#statemachine 获取摄像机的状态机。 followtarget transform 获取目标的 transform 。默认情况下设置为本地玩家角色的 head upper 。 maxzoomdistance number 经计算得出的摄像机可从目标拉远的最大距离。 minzoomdistance number 经计算得出的摄像机可向目标拉近的最小距离。 lookoffset vector3 经计算得出的摄像机相对于目标的偏移。 lockxaxis boolean 表示摄像机的 x 轴旋转是否被锁定。 collisionlayer layermask 定义摄像机可与之发生碰撞的层。 targetscaleweight number 应用于目标缩放的权重,用于调整摄像机的位置与行为。 usecharacterculling boolean 表示是否启用角色剔除,以避免摄像机距离过近时出现渲染问题。 zoomspeed number 缩放的速度。 zoomdampspeed number 缩放的插值速度。 rotationspeed number 旋转的速度。 rotationdampspeed number 旋转的插值速度。 camera camera unity 的 camera 。 事件 名称 类型 说明 onchangedstate unityevent\<camerastate, camerastate> 摄像机状态发生变化时触发的事件。已注册的监听器会收到两个参数: 新的摄像机状态。(类型: camerastate ) 之前的摄像机状态。(类型: camerastate ) onupdatestate unityevent\<camerastate> 当前摄像机状态处于 statestatus update 状况时触发的事件。已注册的监听器会收到一个参数: 当前的摄像机状态。(类型: camerastate ) 方法 create static create(camera camera, data cameradata) → zepetocamera 创建 zepetocamera 实例。 参数 类型 说明 camera camera 作为 zepetocamera 基础的 unity camera 对象。 data cameradata /#cameradata zepetocamera 的初始配置。 返回值: zepetocamera /#zepetocamera — zepetocamera 的新实例。 setfollowtarget setfollowtarget(target transform, scalereference? transform) → void 设置摄像机的跟随目标。 参数 类型 说明 target transform 表示摄像机应跟随对象的 transform 。 scalereference (可选) transform 用作缩放摄像机跟随行为参考的 transform 。若提供该参数,摄像机会根据此参考对象的缩放来调整与目标之间的距离。 rotate rotate(delta vector2) → void 旋转摄像机。 参数 类型 说明 delta vector2 旋转量。 dozoom dozoom(delta number) → void 缩放摄像机。 参数 类型 说明 delta number 缩放量。 zepetoplayer class 表示 zepeto 玩家。 属性 名称 类型 说明 userid string 玩家的用户 id,是在创建账号时随机分配的唯一 id。 name string 玩家的用户名,由用户在 zepeto 应用中设置。 character zepetocharacter /#zepetocharacter 玩家的 zepeto 角色。 islocalplayer boolean 表示是否为本地玩家。 方法 getprofiletextureasync getprofiletextureasync(complete action\<texture2d>) → void 获取玩家的头像。会抛出通用 exception 。 参数 类型 说明 complete action\<texture2d> 用于处理所获取头像的回调函数。 release release() → void 释放 zepeto 玩家对象。 zepetoplayercontrol class 管理 zepeto 玩家的输入控制。 方法 create static create(playeractions playeractions) → zepetoplayercontrol 创建 zepetoplayercontrol 实例。 参数 类型 说明 playeractions playeractions 要与 zepetoplayercontrol 关联的输入操作集合。 返回值: zepetoplayercontrol /#zepetoplayercontrol — zepetoplayercontrol 的新实例。 该实例已挂载到新的游戏对象上,可以处理玩家的输入操作。 zepetocameracontrol class 管理 zepeto 环境中的摄像机控制,包括摄像机移动与缩放的输入处理。 方法 create static create(cameraactions cameraactions) → zepetocameracontrol 创建 zepetocameracontrol 实例。 参数 类型 说明 cameraactions cameraactions 要与 zepetocameracontrol 关联的摄像机操作集合。这些操作定义了摄像机如何响应用户输入。 返回值: zepetocameracontrol /#zepetocameracontrol — zepetocameracontrol 的新实例。 该实例已挂载到新的游戏对象上,可以处理摄像机的输入操作。 characterstate enum 表示 zepeto 角色的状态。 名称 值 说明 invalid 0 未初始化或无效。 idle 1 角色未进行任何移动或动作。 walk 2 角色正在缓慢移动。 run 3 角色正在快速移动。 jumpidle 4 角色正在原地跳跃。 jumpmove 5 角色正朝某一方向跳跃,将垂直起跳与水平移动结合在一起。 teleport 20 角色正从一个位置移动到另一个位置,且不经过中间的空间。 gesture 30 角色正在执行手势。 move 102 一般移动状态。 moveturn 103 角色正在改变移动方向。 jump 104 一般跳跃状态。 stamp 106 角色正在进行踏地动作。 falling 108 角色正处于自由落体状态。 landing 109 角色在下落后回到地面。 charactermovestate enum 表示 zepeto 角色的详细移动状态。 名称 值 说明 none 1 none movewalk 0 缓慢移动。 moverun 1 快速移动。 characterjumpstate enum 表示 zepeto 角色的详细跳跃状态。 名称 值 说明 none 1 none jumpidle 0 原地跳跃。 jumpmove 1 朝某一方向跳跃,将垂直起跳与水平移动结合在一起。 jumpdash 2 快速跳跃。 jumpdouble 3 在跳跃过程中进行第二次跳跃。 characterlandingstate enum 表示 zepeto 角色的详细落地状态。 名称 值 说明 none 1 none landingslight 0 轻微冲击的落地。 landingdeep 1 强烈冲击的落地。 landingroll 2 翻滚落地。 knowsockets enum 定义角色上一组已知的挂点(socket)。 名称 值 说明 head upper 0 表示角色头部的上半部分。 motionstate class 用于管理角色动作状态与配置的类。 属性 名称 类型 说明 usedoublejump boolean 决定角色是否可以进行二段跳。 doublejumppower number 二段跳时施加的额外力。 uselanding boolean 决定是否应用落地动作。 uselandingroll boolean 决定角色落地时是否进行翻滚。 landingrollspeed number 获取或设置角色的落地翻滚速度。 usemoveturn boolean 决定是否播放角色改变移动方向时的动作。 gravity number 施加于角色的重力。 currentjumpstate characterjumpstate /#characterjumpstate 获取角色当前的跳跃状态。 currentlandingstate characterlandingstate /#characterlandingstate 获取角色当前的落地状态。 currentmovestate charactermovestate /#charactermovestate 获取角色当前的移动状态。 characterstatemachine class · extends statemachine\<characterstate> /#statemachine 负责将 animator 与 zepeto 角色的角色状态保持同步的类。 属性 名称 类型 说明 constraintstateanimation boolean 决定是否将 animator 与 zepeto 角色的当前角色状态同步。若设为 true ,animator 状态将不会根据当前角色状态进行更新。 方法 syncstateanimation syncstateanimation() → void 将 animator 与 zepeto 角色的当前角色状态同步。 changestateanimation changestateanimation(state characterstate) → void 在 animator 上播放与所提供角色状态相对应的动画。 参数 类型 说明 state characterstate /#characterstate 表示要播放动画的角色状态。 statemachine class statemachine manages the states , transitions , and events 通过根据指定条件和经过时间更新状态,实现对对象各种状态的定义与控制。 属性 名称 类型 说明 onchangedstate action\<tenum, tenum> 摄像机状态发生变化时触发的事件。已注册的监听器会收到两个参数: 新的状态。 之前的状态。 events transitionbase\<tenum>\[] /#transitionbase 提供状态机中定义的所有事件的数组。 current state\<tenum> /#state 获取当前状态。 prev state\<tenum> /#state 获取之前的状态。 isrunning boolean 表示状态机是否正在处理状态与转换。 statecount number 获取状态机中定义的状态数量。 transitioncount number 获取状态机中定义的转换数量。 方法 findstate findstate(state tenum, success action\<state\<tenum>>, failed action) → void 在状态机中查找状态,成功时执行回调。 参数 类型 说明 state tenum 要在状态机中查找的状态。 success action\<state\<tenum>> 用于处理所找到 state 的回调函数。 failed action 用于处理未找到该状态情况的回调函数。 findtransitions findtransitions(from tenum, success action\<transition\<tenum>\[]>, failed action) → void 在状态机中查找转换,成功时执行回调。 参数 类型 说明 from tenum 转换的起始状态。 success action\<transition\<tenum>\[]> 用于处理所找到 transition 数组的回调函数。 failed action 用于处理未找到转换情况的回调函数。 findtransition findtransition(from tenum, to tenum, success action\<transition\<tenum>>, failed action) → void 在状态机中查找某个转换,成功时执行回调。 参数 类型 说明 from tenum 转换的起始状态。 to tenum 转换将要到达的状态。 success action\<transition\<tenum>> 用于处理所找到 transition 的回调函数。 failed action 用于处理未找到该转换情况的回调函数。 start start(state tenum) → void 启动状态机的处理。 参数 类型 说明 state tenum 状态机开始处理时所处的状态。 update update(deltatime number) → void 更新状态机的当前状态与转换。 参数 类型 说明 deltatime number 自上次调用 update 以来经过的时间(秒)。 stop stop() → void 停止状态机的处理。 enterstate enterstate(state tenum) → void 将状态机转换到指定状态。 参数 类型 说明 state tenum 状态机将要转换到的状态。 leavestate leavestate(nextstate tenum) → void 状态机退出当前状态。 参数 类型 说明 nextstate tenum 由当前状态的 onleave 处理的下一个状态。 statestatus enum 表示状态机中某个状态可能处于的状况,用于指示该状态生命周期的当前阶段。 名称 值 说明 wait 0 状态处于非激活状态,等待被进入。 enter 1 状态正处于进入过程中。 update 2 状态处于激活状态,其逻辑正在执行。 end 3 状态已完成其激活阶段,准备结束。 leave 4 状态正处于退出过程中。 custommotiondata class 表示角色动作的自定义配置。 属性 名称 类型 说明 usedoublejump boolean 决定角色是否可以进行二段跳。 doublejumppower number 二段跳时施加的额外力。 uselanding boolean 决定是否应用落地动作。 uselandingroll boolean 决定角色落地时是否进行翻滚。 landingrollspeed number 落地翻滚动作的播放速度。 usemoveturn boolean 决定是否播放角色改变移动方向时的动作。 gravity number 施加于角色的重力。 walkthreshold number 触发行走动作加速所需的最小输入值。 runthreshold number 从行走动作切换为奔跑动作所需的最小输入值。 fallingtimethreshold number 判定角色是否进入下落状态所需的最短下落时间。 fallingspeedthreshold number 判定角色是否进入下落状态所需的最小下落速度。 landingtimethreshold number 判定角色是否已落地所需的最短着地时间。 landingspeedthreshold number 判定角色落地时能否执行额外动作所需的最小下落速度。 landingimpactspeedthreshold number 判定角色落地时是否受到更大冲击所需的最小下落速度。 landingrollspeedthreshold number 触发落地翻滚所需的最大下落速度。 moveturnanglethreshold number 触发转身动作所需的最小转向角度。 moveturnspeedthreshold number 触发转身动作所需的最小移动速度。 moveturntimethreshold number 转身动作的持续时间。 jumpdashspeedthreshold number 触发冲刺所需的最小跳跃速度。 walkclipbasespeed number 行走动作的基础速度。 stampclipnormalizedtime number 踏地动作的持续时间。 landingclipnormalizedtime number 落地动作的持续时间。 landingrollclipnormalizedtime number 落地翻滚动作的持续时间。 moveturnclipnormalizedtime number 转身动作的持续时间。 charactershadow class 负责管理 zepeto 角色阴影的类。 属性 名称 类型 说明 target transform 表示作为 transform 参考的对象。 autosynctransform boolean 决定是否将阴影位置同步到目标。 camerastate enum 表示 zepetocamera 的状态。 名称 值 说明 idle 0 摄像机未跟随目标。 follow 1 摄像机正在跟随目标。 zepetoscreenstick class · extends zepetoscreencontrol /#zepetoscreencontrol 用于处理 zepeto 环境中摇杆交互的类。 事件 名称 类型 说明 onpointerdownevent unityevent 按下摇杆时触发的事件。 ondragevent unityevent\<vector2> 拖动摇杆时触发的事件。 onpointerupevent unityevent 松开摇杆时触发的事件。 方法 ondrag ondrag(eventdata pointereventdata) → void 管理拖动行为,计算位置增量并将其限制在指定的移动范围内。 以归一化后的位置值触发 ondragevent 。 会抛出 argumentnullexception 。 参数 类型 说明 eventdata pointereventdata 与拖动事件相关的数据。 zepetoscreencontrol class 用于在 zepeto 环境中创建 ui 控件的抽象类。 方法 onpointerdown onpointerdown(eventdata pointereventdata) → void 处理用户按下 ui 控件时的事件。 参数 类型 说明 eventdata pointereventdata 与指针按下事件相关的数据。 onpointerup onpointerup(eventdata pointereventdata) → void 处理用户松开 ui 控件时的事件。 参数 类型 说明 eventdata pointereventdata 与指针松开事件相关的数据。 zepetoscreenbutton class · extends zepetoscreencontrol /#zepetoscreencontrol 用于处理 zepeto 环境中按钮交互的类。 事件 名称 类型 说明 onpointdownevent unityevent 按下按钮时触发的事件。 onpointupevent unityevent 松开按钮时触发的事件。 zepetoscreentouchpad class · extends zepetoscreencontrol /#zepetoscreencontrol 用于处理 zepeto 环境中触摸板交互的类。 属性 名称 类型 说明 canvasgrouptouchpadbackground canvasgroup 用于管理触摸板背景不透明度与交互的 canvas group 组件。 touchpadbackgroundcurve animationcurve 用于触摸板背景淡入淡出效果的动画曲线。 touchhandle recttransform 表示触摸手柄的 recttransform 组件。 touchhandleanimator animator 用于为触摸手柄制作动画的 animator 组件。 touchhandleorigin recttransform 表示触摸手柄原始位置的 recttransform 。 touchhandleoriginanimator animator 用于触摸手柄原点的 animator 组件。 事件 名称 类型 说明 onpointerdownevent unityevent 按下触摸板时触发的事件。 ondragevent unityevent\<vector2> 拖动触摸板时触发的事件。 onpointerupevent unityevent 松开触摸板时触发的事件。 方法 onpointerclick onpointerclick(eventdata pointereventdata) → void 处理触摸板上的点击事件。会抛出 argumentnullexception 。 参数 类型 说明 eventdata pointereventdata 与拖动事件相关的数据。 ondrag ondrag(eventdata pointereventdata) → void 管理拖动行为,计算位置增量并将其限制在指定的移动范围内。 以归一化后的位置值触发 ondragevent 。 会抛出 argumentnullexception 。 参数 类型 说明 eventdata pointereventdata 与拖动事件相关的数据。 uizepetoplayercontrol class 为本地玩家角色提供基于 ui 的控制的类。 方法 startmoving startmoving() → void 将本地玩家角色的移动标志设为 true 。 move move(delta vector2) → void 设置本地玩家 zepeto 角色的移动方向。 参数 类型 delta vector2 stopmoving stopmoving() → void 停止本地玩家的 zepeto 角色。 jump jump() → void 使本地玩家的 zepeto 角色跳跃。 doublejump doublejump() → void 使本地玩家的 zepeto 角色进行二段跳。 update update() → void 更新本地玩家 zepeto 角色的移动方向。 inputhelper class 用于辅助输入处理的工具类。 方法 ispointeroveruiobjectcurrentposition static ispointeroveruiobjectcurrentposition() → boolean 判断指针当前是否位于 ui 对象之上。 返回值: boolean — 若指针位于 ui 对象之上,则返回 true 。 ispointeroveruiobject static ispointeroveruiobject(position vector2) → boolean 检查屏幕上的指定位置是否位于 ui 元素之上。 参数 类型 说明 position vector2 屏幕上的位置。 返回值: boolean — 若该位置位于 ui 对象之上,则返回 true 。 eventreceiver class 负责处理 zepeto world 内角色相关事件或通用事件的类。 事件 名称 类型 说明 oncharacterclick (static) unityevent\<string, zepetocontext> 点击角色时触发的事件。 oncharacterprofileclick (static) unityevent\<string, zepetocontext> 点击角色资料时触发的事件。 onclick (static) unityevent\<number> 可用于各类交互元素的通用点击事件。 transitionbase class 用于定义状态机中状态之间转换的基类。 属性 名称 类型 说明 to tenum 转换将要到达的状态。 duration number 转换从开始到结束应持续的时间(秒)。 status statestatus /#statestatus 转换的状况。 isrunning boolean 表示该转换当前是否处于 statestatus enter 或 statestatus update 状况。 方法 check check() → boolean 检查触发转换的条件是否满足。 返回值: boolean — 若转换的条件已满足,则为 true 。 state class 表示状态机中的一个状态。 属性 名称 类型 说明 onupdatestate action\<tenum> 用于处理状态更新的回调函数。 statetype tenum 状态的类型。 status statestatus /#statestatus 状态的状况。 transition class · extends transitionbase\<tenum> /#transitionbase 用于定义状态机中状态之间转换的泛型类。 属性 名称 类型 说明 from tenum 转换的起始状态。 zepetocharacter loadingstatus enum zepeto 角色的加载状态。 名称 值 说明 notloaded 0 角色尚未开始加载过程。 loading 1 角色正处于加载过程中。 loaded 2 角色已完全加载。 error 3 加载过程中发生错误。 playercontrolmode enum 名称 值 default 0 walkonly 1 runonly 2
