ZEPETO.Character.Controller

type description zepetoplayers /#zepetoplayers manager class designed for controlling both zepeto player and zepeto character spawninfo /#spawninfo represents the spawning location of a zepeto character zepetocharacter /#zepetocharacter represents a zepeto character that can be loaded and controlled in a zepeto world cameradata /#cameradata represents the initial configuration for a zepetocamera characterdata /#characterdata represents the initial configuration for a zepetocharacter controllerdata /#controllerdata represents the configuration for a zepetoplayercontrol floatinguidata /#floatinguidata class responsible for managing character related ui settings localplayer /#localplayer class designed to manage the local player's actions, including movement, costume customization, and zepeto camera interactions zepetocamera /#zepetocamera camera control class designed for use within a zepeto character controller zepetoplayer /#zepetoplayer represents a zepeto player zepetoplayercontrol /#zepetoplayercontrol manages the input control for a zepeto player zepetocameracontrol /#zepetocameracontrol manages the camera controls in a zepeto environment, including input handling for camera movement and zoom characterstate /#characterstate represents the state of a zepeto character charactermovestate /#charactermovestate represents the detailed moving state of a zepeto character characterjumpstate /#characterjumpstate represents the detailed jumping state of a zepeto character characterlandingstate /#characterlandingstate represents the detailed landing state of a zepeto character knowsockets /#knowsockets defines a set of known attachment points, referred to as sockets, on a character motionstate /#motionstate class for managing character motion state and configuration characterstatemachine /#characterstatemachine class responsible for synchronizing the animator with the character state of a zepeto character statemachine /#statemachine statemachine manages the states , transitions , and events by updating states according to specified conditions and elapsed time, it enables the definition and control of diverse states for objects statestatus /#statestatus represents the possible statuses of a state within a state machine, indicating the current phase of the state's lifecycle custommotiondata /#custommotiondata represents the customized configuration for character motion charactershadow /#charactershadow class responsible for managing the shadows of zepeto characters camerastate /#camerastate represents the state of a zepetocamera zepetoscreenstick /#zepetoscreenstick class designed to handle stick interactions in the zepeto environment zepetoscreencontrol /#zepetoscreencontrol abstract class designed for creating ui controls in the zepeto environment zepetoscreenbutton /#zepetoscreenbutton class designed to handle button interactions in the zepeto environment zepetoscreentouchpad /#zepetoscreentouchpad class designed to handle touchpad interactions in the zepeto environment uizepetoplayercontrol /#uizepetoplayercontrol class provides ui based control for the local player's character inputhelper /#inputhelper utility class designed to assist with input handling eventreceiver /#eventreceiver class responsible for handling character related or general events within the zepeto world transitionbase /#transitionbase base class for defining transitions between states in a state machine state /#state represents a state within a state machine transition /#transition generic class for defining transitions between states in a state machine zepetocharacter loadingstatus /#zepetocharacterloadingstatus loading state of the zepeto character playercontrolmode /#playercontrolmode enum zepetoplayers class manager class designed for controlling both zepeto player and zepeto character properties name type description cameradata cameradata /#cameradata configuration for a zepetocamera characterdata characterdata /#characterdata configuration for a zepetocharacter controllerdata controllerdata /#controllerdata configuration for a zepetoplayercontrol floatinguidata floatinguidata /#floatinguidata character related ui settings instance (static) zepetoplayers /#zepetoplayers singleton instance of zepetoplayers localplayer localplayer /#localplayer local player zepetocamera zepetocamera /#zepetocamera zepeto camera events name type description onaddedlocalplayer unityevent event triggered when a local player instance is created onaddedplayer unityevent\<string> event triggered when a player instance is created onremovedplayer unityevent\<string> event triggered when a player instance is removed methods add oninitialized static add oninitialized(value action) → void adds handler function for the event invoked when the zepetoplayers is initialized parameter type value action remove oninitialized static remove oninitialized(value action) → void removes handler function for the event invoked when the zepetoplayers is initialized parameter type value action hasplayer hasplayer(id string) → boolean checks if a player instance associated with the specified session id exists parameter type description id string session id returns boolean getplayer getplayer(id string) → zepetoplayer retrieves the player instance associated with the specified session id parameter type description id string session id returns zepetoplayer /#zepetoplayer — player object associated with the specified id if a player with the given id does not exist, this will return null getplayerwithuserid getplayerwithuserid(userid string) → zepetoplayer retrieves the player instance associated with the specified user id parameter type description userid string user id returns zepetoplayer /#zepetoplayer — player object associated with the specified user id removeplayer removeplayer(id string) → void removes the player instance associated with the specified session id parameter type description id string session id deformdefaultcostume deformdefaultcostume() → void removes the body deformation items worn by every player's character reverts to the default body shape and applies the default zepeto outfit deformdefaultproperties deformdefaultproperties() → void removes the body deformation items worn by every player's character spawninfo class represents the spawning location of a zepeto character properties name type description default (static) spawninfo /#spawninfo default spawning location position vector3 location of zepeto character when spawned rotation quaternion rotation of zepeto character when spawned zepetocharacter class represents a zepeto character that can be loaded and controlled in a zepeto world properties name type description additionalwalkspeed number retrieves the additional walk speed additionalrunspeed number retrieves the additional run speed additionaljumppower number retrieves the additional jump power constraintrotation boolean determines whether the character's rotation is restricted zepetoanimator animator the animator for the zepeto character walkspeed number retrieves the total walking speed, which is the sum of the base speed and additional speed runspeed number retrieves the total running speed, which is the sum of the base speed and additional speed jumppower number retrieves the total jumping power, which is the sum of the base power and additional power basewalkspeed number retrieves the base walking speed baserunspeed number retrieves the base running speed basejumppower number retrieves the base jump power trymove boolean indicates whether the character is attempting to move tryjump boolean indicates whether the character is attempting to jump trydoublejump boolean indicates whether the character is attempting to double jump motionstate motionstate /#motionstate motion state and configuration of the character loadingstatus loadingstatus /#zepetocharacterloadingstatus loading status of the character context zepetocontext zepeto context of the character statemachine characterstatemachine /#characterstatemachine state machine of the character currentstate characterstate /#characterstate current state of the character defined in the state machine currentstatestatus statestatus /#statestatus status of the current state of the character, defined in the state machine elapsedtime number time elapsed in seconds since the character was initialized events name type description onchangedstate unityevent\<characterstate, characterstate> event triggered when the character state changes registered listeners receive two parameters the new character state (type characterstate ) the previous character state (type characterstate ) onupdatestate unityevent\<characterstate> event triggered when the character state is in the status of statestatus update registered listeners receive a single parameter the current character state (type characterstate ) methods syncstateanimation syncstateanimation() → void synchronizes the animator with the current character state of the zepeto character changestateanimation changestateanimation(state characterstate) → void plays the animation associated with the provided character state on the animator parameter type description state characterstate /#characterstate character state representing the animation to play changestateanimation changestateanimation(state characterstate, movestate charactermovestate) → void plays the animation associated with the provided character state on the animator parameter type description state characterstate /#characterstate character state representing the animation to play movestate charactermovestate /#charactermovestate optional movement state for the animation when state is characterstate move changestateanimation changestateanimation(state characterstate, jumpstate characterjumpstate) → void plays the animation associated with the provided character state on the animator parameter type description state characterstate /#characterstate character state representing the animation to play jumpstate characterjumpstate /#characterjumpstate optional jump state for the animation when state is characterstate jump changestateanimation changestateanimation(state characterstate, landingstate characterlandingstate) → void plays the animation associated with the provided character state on the animator parameter type description state characterstate /#characterstate character state representing the animation to play landingstate characterlandingstate /#characterlandingstate optional landing state for the animation when state is characterstate landing move move(dir vector2) → void moves the character in a specified direction parameter type description dir vector2 direction in which the character should move move move(dir vector3) → void moves the character in a specified direction parameter type description dir vector3 direction in which the character should move movecontinuously movecontinuously(dir vector2) → void continuously moves the character in a given direction based on the current orientation it is facing parameter type description dir vector2 direction in which the character should move, based on the current orientation it is facing movecontinuously movecontinuously(dir vector3) → void continuously moves the character in a given direction based on the current orientation it is facing parameter type description dir vector3 direction in which the character should move, based on the current orientation it is facing movetoposition movetoposition(pos vector3) → void moves the character to a specified position parameter type description pos vector3 destination the character should move to stopmoving stopmoving() → void stops the character's movement jump jump() → void makes the character jump doublejump doublejump() → void makes the character double jump teleport teleport(pos vector3, rot quaternion) → void instantly moves the character to the specified transform parameter type description pos vector3 position to which the character will be teleported rot quaternion rotation that the character will have after the teleportation setgesture setgesture(gesture animationclip) → void plays the character's motion for the specified gesture parameter type description gesture animationclip gesture that the character will perform cancelgesture cancelgesture() → void stops the playback of the gesture getsocket getsocket(socket knowsockets) → transform retrieves the transform of a socket of the character parameter type description socket knowsockets /#knowsockets socket (attachment point) returns transform — transform component associated with the specified socket getsocket getsocket(socket string) → transform retrieves the transform of a socket of the character parameter type description socket string name of the socket (attachment point) returns transform — transform component associated with the specified socket getbodymodifierproperties getbodymodifierproperties() → zepetopropertyflag\[] retrieves the character properties associated with any body deformation items worn by the character returns zepetopropertyflag\[] — character properties associated with the body deformation items worn by the character deformdefaultproperties deformdefaultproperties() → void removes the body deformation items worn by the character and reverts to the default body shape deformdefaultcostume deformdefaultcostume() → void removes the body deformation items worn by the character, reverts to the default body shape, and applies the default zepeto outfit add loadedcharacter add loadedcharacter(value action) → void adds a callback function to handle the completion of character loading parameter type value action remove loadedcharacter remove loadedcharacter(value action) → void removes a callback function to handle the completion of character loading parameter type value action cameradata class represents the initial configuration for a zepetocamera properties name type description cameraprefab gameobject prefab to initialize zepetocamera maxzoomdistance number default maximum distance the camera can zoom out from the target minzoomdistance number default minimum distance the camera can zoom in towards the target maxpitch number maximum vertical angle at which the camera rotates around the target minpitch number minimum vertical angle at which the camera rotates around the target offset vector3 default offset of the camera from its target lockxaxis boolean indicates whether the camera's x axis rotation is locked layer layermask defines the layers with which the camera can collide collisiontimethreshold number time threshold for camera collision detection, affecting how quickly the camera responds to collisions zoomspeed number speed of zooming in and out zoomdampspeed number interpolation speed for zooming in and out rotationspeed number speed of rotation rotationdampspeed number interpolation speed for rotation characterculling boolean indicates whether to enable character culling to prevent rendering issues at close camera distances targetscaleweight number weight applied to the target's scale to adjust the camera's position and behavior characterdata class represents the initial configuration for a zepetocharacter properties name type description slopelimit number steepest degree the character can ascend stepoffset number maximum vertical height difference the character can move over skinwidth number skin width for collision detection, preventing the character from entering into other colliders minmovedistance number smallest gap the character can move center vector3 center point of the character's collider radius number radius of the character's collider capsule height number height of the character's collider capsule layer layermask defines the layers with which the character can collide shadow gameobject visual representation of the character's shadow animatorcontroller runtimeanimatorcontroller animator controller for the character walkspeed number walking speed of the character runspeed number running speed of the character jumppower number jump power of the character custommotiondata custommotiondata /#custommotiondata customized configuration for character motion controllerdata class represents the configuration for a zepetoplayercontrol properties name type description inputasset inputactionasset container for input actions and bindings used to manage complex input setups eventsystem gameobject processes user inputs and conveys them to the ui components it handles interactions like button clicks, drags, drops, etc usedefaultvirtualcontroller boolean determines whether to use the default v pad usedefaultinputcontroller boolean determines whether to use the default input controller verticalcontroller gameobject v pad controller prefab for vertical screen orientation horizontalcontroller gameobject v pad controller prefab for horizontal screen orientation floatinguidata class class responsible for managing character related ui settings properties name type description shownicknamelocalplayer boolean determines whether to display the local player's character nickname ui shownicknameotherplayers boolean determines whether to display the character nickname ui for other players showbubblechatlocalplayer boolean determines whether to display the local player's character bubble chat ui showbubblechatotherplayers boolean determines whether to display the character bubble chat ui for other players useminiprofileonapp boolean determines whether to show the mini profile pop up ui when clicking on a character localplayer class class designed to manage the local player's actions, including movement, costume customization, and zepeto camera interactions properties name type description movingaxis transform movement central axis of the local player's zepeto character zepetocamera zepetocamera /#zepetocamera zepeto camera instance associated with the local player zepetoplayer zepetoplayer /#zepetoplayer zepeto player instance associated with the local player methods setcostume setcostume(itemcode string, complete? action) → void changes the costume of the local player's zepeto character throws a general exception parameter type description itemcode string item id of the costume complete (optional) action callback function to handle the completion jump jump() → void makes the local player's zepeto character jump doublejump doublejump() → void makes the local player's zepeto character double jump move move(dir vector2) → void moves the local player's zepeto character in a specified direction parameter type description dir vector2 direction in which the character should move move move(dir vector3) → void moves the local player's zepeto character in a specified direction parameter type description dir vector3 direction in which the character should move stopmoving stopmoving() → void stops the local player's zepeto character zepetocamera class camera control class designed for use within a zepeto character controller properties name type description additionalmaxzoomdistance number extra distance added to the default maximum zoom value additionalminzoomdistance number extra distance added to the default minimum zoom value additionaloffset vector3 additional offset applied to the camera's position relative to its target currentstate camerastate /#camerastate retrieves the current camera state currentstatestatus statestatus /#statestatus retrieves the status of the current camera state position vector3 retrieves the current camera position value rotation quaternion retrieves the current camera rotation value distance number distance from the target cameraparent transform transform of the camera parent object isfollow boolean retrieves the flag indicating whether the camera is following the target statemachine statemachine\<camerastate> /#statemachine retrieves the camera state machine followtarget transform retrieves the transform of the target by default, this is set to be the head upper of the local player's character maxzoomdistance number calculated maximum distance the camera can zoom out from the target minzoomdistance number calculated minimum distance the camera can zoom in towards the target lookoffset vector3 calculated offset of the camera from its target lockxaxis boolean indicates whether the camera's x axis rotation is locked collisionlayer layermask defines the layers with which the camera can collide targetscaleweight number weight applied to the target's scale to adjust the camera's position and behavior usecharacterculling boolean indicates whether to enable character culling to prevent rendering issues at close camera distances zoomspeed number speed of zooming in and out zoomdampspeed number interpolation speed for zooming in and out rotationspeed number speed of rotation rotationdampspeed number interpolation speed for rotation camera camera unity camera events name type description onchangedstate unityevent\<camerastate, camerastate> event triggered when the camera state changes registered listeners receive two parameters the new camera state (type camerastate ) the previous camera state (type camerastate ) onupdatestate unityevent\<camerastate> event triggered when the current camera state is in the status of statestatus update registered listeners receive a single parameter the current camera state (type camerastate ) methods create static create(camera camera, data cameradata) → zepetocamera creates a zepetocamera instance parameter type description camera camera unity camera object to be used as the basis for the zepetocamera data cameradata /#cameradata initial configuration for the zepetocamera returns zepetocamera /#zepetocamera — new instance of zepetocamera setfollowtarget setfollowtarget(target transform, scalereference? transform) → void sets the follow target for the camera parameter type description target transform transform representing the object that the camera should follow scalereference (optional) transform transform used as a reference for scaling the camera's follow behavior if provided, the camera will adjust its distance towards the target based on the scale of this reference rotate rotate(delta vector2) → void rotates the camera parameter type description delta vector2 roate amount dozoom dozoom(delta number) → void zooms the camera parameter type description delta number zoom amount zepetoplayer class represents a zepeto player properties name type description userid string player's user id, a unique randomized id assigned upon account creation name string player's user name, set by the user in the zepeto app character zepetocharacter /#zepetocharacter zepeto character of the player islocalplayer boolean indicates whether it is a local player methods getprofiletextureasync getprofiletextureasync(complete action\<texture2d>) → void retrieves the profile image of the player throws a general exception parameter type description complete action\<texture2d> callback function to handle the retrieved profile image release release() → void releases the zepeto player object zepetoplayercontrol class manages the input control for a zepeto player methods create static create(playeractions playeractions) → zepetoplayercontrol creates a zepetoplayercontrol instance parameter type description playeractions playeractions set of input actions to be associated with the zepetoplayercontrol returns zepetoplayercontrol /#zepetoplayercontrol — new instance of zepetoplayercontrol instance is attached to a new game object and ready to handle player input actions zepetocameracontrol class manages the camera controls in a zepeto environment, including input handling for camera movement and zoom methods create static create(cameraactions cameraactions) → zepetocameracontrol creates a zepetocameracontrol instance parameter type description cameraactions cameraactions set of camera actions to be associated with the zepetocameracontrol these actions define how the camera will respond to user input returns zepetocameracontrol /#zepetocameracontrol — new instance of zepetocameracontrol instance is attached to a new game object and ready to handle camera input actions characterstate enum represents the state of a zepeto character name value description invalid 0 uninitialized or invalid idle 1 character is not engaged in any movement or action walk 2 character is moving at a slow pace run 3 character is moving quickly jumpidle 4 character is jumping in place jumpmove 5 character is jumping in a direction, combining the vertical leap with horizontal motion teleport 20 character is moving from one location to another without traversing the space in between gesture 30 character is performing a gesture move 102 general moving state moveturn 103 character is changing the movement direction jump 104 general jumping state stamp 106 character is performing a stamp falling 108 character is in free fall landing 109 character is returning to the ground after falling charactermovestate enum represents the detailed moving state of a zepeto character name value description none 1 none movewalk 0 moving at a slow pace moverun 1 moving quickly characterjumpstate enum represents the detailed jumping state of a zepeto character name value description none 1 none jumpidle 0 jumping in place jumpmove 1 jumping in a direction, combining the vertical leap with horizontal motion jumpdash 2 jumping quickly jumpdouble 3 performing a second jump while already in a jump characterlandingstate enum represents the detailed landing state of a zepeto character name value description none 1 none landingslight 0 in a landing with minor impact landingdeep 1 in a landing with significant impact landingroll 2 in a landing roll knowsockets enum defines a set of known attachment points, referred to as sockets, on a character name value description head upper 0 represents the top part of the character's head motionstate class class for managing character motion state and configuration properties name type description usedoublejump boolean determines whether the character can perform a double jump doublejumppower number additional force applied during a double jump uselanding boolean determines whether to apply landing motion uselandingroll boolean determines whether the character performs a roll upon landing landingrollspeed number gets or sets the character's landing roll speed usemoveturn boolean determines whether to play a motion for changing the character's movement direction gravity number gravitational force applied to the character currentjumpstate characterjumpstate /#characterjumpstate retrieves the current jump state of the character currentlandingstate characterlandingstate /#characterlandingstate retrieves the current landing state of the character currentmovestate charactermovestate /#charactermovestate retrieves the current movement state of the character characterstatemachine class · extends statemachine\<characterstate> /#statemachine class responsible for synchronizing the animator with the character state of a zepeto character properties name type description constraintstateanimation boolean determines whether to synchronize the animator with the current character state of the zepeto character if set to true , the animator state will not be updated based on the current character state methods syncstateanimation syncstateanimation() → void synchronizes the animator with the current character state of the zepeto character changestateanimation changestateanimation(state characterstate) → void plays the animation associated with the provided character state on the animator parameter type description state characterstate /#characterstate character state representing the animation to play statemachine class statemachine manages the states , transitions , and events by updating states according to specified conditions and elapsed time, it enables the definition and control of diverse states for objects properties name type description onchangedstate action\<tenum, tenum> event triggered when the camera state changes registered listeners receive two parameters the new state the previous state events transitionbase\<tenum>\[] /#transitionbase provides an array of all the events defined in the state machine current state\<tenum> /#state retrieves the current state prev state\<tenum> /#state retrieves the previous state isrunning boolean indicates whether the state machine is actively processing states and transitions statecount number retrieves the count of states defined in the state machine transitioncount number retrieves the count of transitions defined in the state machine methods findstate findstate(state tenum, success action\<state\<tenum>>, failed action) → void finds a state within the state machine and executes a callback on success parameter type description state tenum state to find within the state machine success action\<state\<tenum>> callback function to handle the found state failed action callback function to handle the case when the state is not found findtransitions findtransitions(from tenum, success action\<transition\<tenum>\[]>, failed action) → void finds transitions within the state machine and executes a callback on success parameter type description from tenum state from which the transition starts success action\<transition\<tenum>\[]> callback function to handle the found array of transition failed action callback function to handle the case when transitions are not found findtransition findtransition(from tenum, to tenum, success action\<transition\<tenum>>, failed action) → void finds a transition within the state machine and executes a callback on success parameter type description from tenum state from which the transition starts to tenum state to which the transition will occur success action\<transition\<tenum>> callback function to handle the found transition failed action callback function to handle the case when the transition is not found start start(state tenum) → void initiates the processing of the state machine parameter type description state tenum state from which the state machine will start its processing update update(deltatime number) → void updates the current state and transition of the state machine parameter type description deltatime number time elapsed in seconds since the last update call stop stop() → void stops the processing of the state machine enterstate enterstate(state tenum) → void transitions the state machine into a specified state parameter type description state tenum the state to which the state machine will transition leavestate leavestate(nextstate tenum) → void the state machine exits the current state parameter type description nextstate tenum the next state to be handled by the current state's onleave statestatus enum represents the possible statuses of a state within a state machine, indicating the current phase of the state's lifecycle name value description wait 0 the state is inactive and waiting to be entered enter 1 the state is in the process of being entered update 2 the state is active and its logic is being executed end 3 the state has completed its active phase and is ready to end leave 4 the state is in the process of being exited custommotiondata class represents the customized configuration for character motion properties name type description usedoublejump boolean determines whether the character can perform a double jump doublejumppower number additional force applied during a double jump uselanding boolean determines whether to apply landing motion uselandingroll boolean determines whether the character performs a roll upon landing landingrollspeed number playback speed of landing roll motion usemoveturn boolean determines whether to play a motion for changing the character's movement direction gravity number gravitational force applied to the character walkthreshold number minimum input value required to trigger acceleration for walking motion runthreshold number minimum input value required to switch motion from walking to running fallingtimethreshold number minimum falling time duration to determine if the character has entered a falling state fallingspeedthreshold number mimum falling speed to determine if the character has entered a falling state landingtimethreshold number minimum landed time duration to determine if the character has landed landingspeedthreshold number minimum falling speed to determine if the character can perform additional actions upon landing landingimpactspeedthreshold number minimum falling speed to determine if the character experiences a greater impact upon landing landingrollspeedthreshold number maximum falling speed required to trigger a landing roll moveturnanglethreshold number minimum turning angle required to trigger a turning motion moveturnspeedthreshold number minimum moving speed required to trigger a turning motion moveturntimethreshold number time duration of the turning motion jumpdashspeedthreshold number minimum jump speed required to trigger a dash walkclipbasespeed number base speed of the walking motion stampclipnormalizedtime number time duration of the stamp motion landingclipnormalizedtime number time duration of the landing motion landingrollclipnormalizedtime number time duration of the landing roll motion moveturnclipnormalizedtime number time duration of the turning motion charactershadow class class responsible for managing the shadows of zepeto characters properties name type description target transform represents the object that serves as the transform reference autosynctransform boolean determines whether to synchronize the shadow position to the target camerastate enum represents the state of a zepetocamera name value description idle 0 camera is not following the target follow 1 camera is following the target zepetoscreenstick class · extends zepetoscreencontrol /#zepetoscreencontrol class designed to handle stick interactions in the zepeto environment events name type description onpointerdownevent unityevent event triggered when the stick is pressed down ondragevent unityevent\<vector2> event triggered when the stick is being dragged onpointerupevent unityevent event triggered when the stick is released methods ondrag ondrag(eventdata pointereventdata) → void manages the drag behavior, calculating the position delta and clamping it within the specified movement range triggers ondragevent with the normalized position value throws argumentnullexception parameter type description eventdata pointereventdata data related to the drag event zepetoscreencontrol class abstract class designed for creating ui controls in the zepeto environment methods onpointerdown onpointerdown(eventdata pointereventdata) → void handles events when the user presses a ui control parameter type description eventdata pointereventdata data related to the pointer down event onpointerup onpointerup(eventdata pointereventdata) → void handles events when the user releases a ui control parameter type description eventdata pointereventdata data related to the pointer up event zepetoscreenbutton class · extends zepetoscreencontrol /#zepetoscreencontrol class designed to handle button interactions in the zepeto environment events name type description onpointdownevent unityevent event triggered when the button is pressed down onpointupevent unityevent event triggered when the button is released zepetoscreentouchpad class · extends zepetoscreencontrol /#zepetoscreencontrol class designed to handle touchpad interactions in the zepeto environment properties name type description canvasgrouptouchpadbackground canvasgroup canvas group component used to manage the opacity and interaction of the touchpad's background touchpadbackgroundcurve animationcurve animation curve for the touchpad's background fade in and out effect touchhandle recttransform recttransform component representing the touch handle touchhandleanimator animator animator component used to animate the touch handle touchhandleorigin recttransform recttransform for the original position of the touch handle touchhandleoriginanimator animator animator component for the touch handle's origin point events name type description onpointerdownevent unityevent event triggered when the touchpad is pressed down ondragevent unityevent\<vector2> event triggered when the touchpad is being dragged onpointerupevent unityevent event triggered when the touchpad is released methods onpointerclick onpointerclick(eventdata pointereventdata) → void handles click events on the touchpad throws argumentnullexception parameter type description eventdata pointereventdata data related to the drag event ondrag ondrag(eventdata pointereventdata) → void manages the drag behavior, calculating the position delta and clamping it within the specified movement range triggers ondragevent with the normalized position value throws argumentnullexception parameter type description eventdata pointereventdata data related to the drag event uizepetoplayercontrol class class provides ui based control for the local player's character methods startmoving startmoving() → void sets the moving flag of the local player's character to true move move(delta vector2) → void sets the moving direction of local player's zepeto character parameter type delta vector2 stopmoving stopmoving() → void stops the local player's zepeto character jump jump() → void makes the local player's zepeto character jump doublejump doublejump() → void makes the local player's zepeto character double jump update update() → void updates the moving direction of local player's zepeto character inputhelper class utility class designed to assist with input handling methods ispointeroveruiobjectcurrentposition static ispointeroveruiobjectcurrentposition() → boolean determines if the pointer is currently over a ui object returns boolean — returns true if the pointer is over a ui object ispointeroveruiobject static ispointeroveruiobject(position vector2) → boolean checks if the specified position on the screen is over a ui element parameter type description position vector2 position on the screen returns boolean — returns true if the position is over a ui object eventreceiver class class responsible for handling character related or general events within the zepeto world events name type description oncharacterclick (static) unityevent\<string, zepetocontext> event triggered when the character is clicked oncharacterprofileclick (static) unityevent\<string, zepetocontext> event triggered when the character's profile is clicked onclick (static) unityevent\<number> general purpose click event that can be used for various interactive elements transitionbase class base class for defining transitions between states in a state machine properties name type description to tenum state to which the transition will occur duration number time duration the transition should take from start to end (in seconds) status statestatus /#statestatus status of the transition isrunning boolean indicates whether the transition is currently in the status of statestatus enter or statestatus update methods check check() → boolean checks if the conditions for invoking a transition are met returns boolean — true if the transition's conditions are met state class represents a state within a state machine properties name type description onupdatestate action\<tenum> callback function to handle the state update statetype tenum type of the state status statestatus /#statestatus status of the state transition class · extends transitionbase\<tenum> /#transitionbase generic class for defining transitions between states in a state machine properties name type description from tenum state from which the transition starts zepetocharacter loadingstatus enum loading state of the zepeto character name value description notloaded 0 character has not yet begun the loading process loading 1 character is currently in the loading process loaded 2 character has fully loaded error 3 error occured during the loading process playercontrolmode enum name value default 0 walkonly 1 runonly 2