mw

mw Namespace ​

Table of contents ​

Enumerations ​

Classes ​

Interfaces ​

Type Aliases ​

Variables ​

Functions ​

Type Aliases ​

BoolCallback ​

Ƭ BoolCallback: (value: boolean) => void

Type declaration ​

• (value): void

Return the callback of Bool

Parameters ​

Returns ​

void

BoolResponse ​

Ƭ BoolResponse: (success: boolean) => void

Type declaration ​

• (success): void

Return boolean callback

Parameters ​

Returns ​

void

BroadcastMessageResult ​

Ƭ BroadcastMessageResult: Object

The result of sending a message

Type declaration ​

ChatEvent ​

Ƭ ChatEvent: (jsonData: string) => void

Type declaration ​

• (jsonData): void

Received MGS event call

Parameters ​

Returns ​

void

CustomPropertyType ​

Ƭ CustomPropertyType: number boolean string Vector2 Vector Vector4 Rotation LinearColor

Custom attribute type

DelegateFuncType ​

Ƭ DelegateFuncType: (...arg: unknown[]) => unknown other

Type declaration ​

• (...arg): unknown

Proxy callback function signature

DownloadDataResponse ​

Ƭ DownloadDataResponse: () => void

Type declaration ​

• (): void

Download callback of character appearance, no parameters

Returns ​

void

EmptyCallback ​

Ƭ EmptyCallback: () => void

Type declaration ​

• (): void

Empty callback function type

Returns ​

void

HttpResponse ​

Ƭ HttpResponse: (result: boolean, content: string, responseCode: number) => void

Type declaration ​

• (result, content, responseCode): void

The callback message format for HTTP requests

Parameters ​

Returns ​

void

LoadAppearanceDataAllCompletedCallback ​

Ƭ LoadAppearanceDataAllCompletedCallback: () => void

Type declaration ​

• (): void

Callback after character editor data loading

Returns ​

void

LocalUGCGameInfo ​

Ƭ LocalUGCGameInfo: Object

Local engineering information. If the project has released games in UGC consumption mode, the gameId is not empty.

Type declaration ​

MGSEvent ​

Ƭ MGSEvent: (jsonData: string) => void

Type declaration ​

• (jsonData): void

Received MGS event call

Parameters ​

Returns ​

void

MGSResponse ​

Ƭ MGSResponse: (isSuccess: boolean, jsonData: string) => void

Type declaration ​

• (isSuccess, jsonData): void

Received app replies

Parameters ​

Returns ​

void

OnDescriptionChange ​

Ƭ OnDescriptionChange: (operationCode: number, index: number, value: unknown) => void

Type declaration ​

• (operationCode, index, value): void

Commissioned changes in appearance loading details

Parameters ​

Returns ​

void

OnDescriptionComplete ​

Ƭ OnDescriptionComplete: (character: Character) => void

Type declaration ​

• (character): void

Appearance loading completion delegate

Parameters ​

Returns ​

void

OnKeyConsume ​

Ƭ OnKeyConsume: (player: Player, orderId: string, boxId: string, amount: number, confirmOrder: (bReceived: boolean) => void) => void

Type declaration ​

• (player, orderId, boxId, amount, confirmOrder): void

Message format for receiving shipping notifications on the deduction server for major member keys

Parameters ​

Returns ​

void

OnMovementModeChange ​

Ƭ OnMovementModeChange: (mode: MovementMode) => void

Type declaration ​

• (mode): void

Mobile status switching delegate

Parameters ​

Returns ​

void

OnOrderDelivered ​

Ƭ OnOrderDelivered: (playerId: number, orderId: string, commodityId: string, amount: number, confirmOrder: (bReceived: boolean, message?: string) => void) => void

Type declaration ​

• (playerId, orderId, commodityId, amount, confirmOrder): void

Message format for receiving shipping notifications on the server

Parameters ​

Returns ​

void

OnViewLayoutSwitched ​

Ƭ OnViewLayoutSwitched: (newState: number) => void

Type declaration ​

• (newState): void

Message format for switching window display modes in app

Parameters ​

Returns ​

void

OnViewRefreshed ​

Ƭ OnViewRefreshed: () => void

Type declaration ​

• (): void

Message format for window refresh in app

Returns ​

void

PublishedUGCGameInfo ​

Ƭ PublishedUGCGameInfo: Object

Successfully released UGC consumer game information

Type declaration ​

RedeemResponse ​

Ƭ RedeemResponse: Object

status : Exchange status.

200 ： Redemption successful

400 ： Exchange failed (exchange code does not exist)

423 ： Exchange failed (frequent requests)

1002 Exchange failed (exchange code is not within its expiration date)

1010 Exchange failed (exchange code already used)

1011 Exchange failed (exchange timeout)

1012 Exchange failed (gift package inventory insufficient)

1013 Exchange failed (exceeding the number of exchanges)

1014 Exchange failed (database failure)

1015 Exchange failed (non game item)

message : Exchange information

When the redemption status is successful: the redemption information is the details of the gift package content and props.

When the exchange status is failed: the exchange information is the failure details, for example: the exchange code does not exist.

Type declaration ​

SetAppearanceDataCallback ​

Ƭ SetAppearanceDataCallback: (APIName: string) => void

Type declaration ​

• (APIName): void

Set callback for data editing completion

Parameters ​

Returns ​

void

StringCallback ​

Ƭ StringCallback: (str: string) => void

Type declaration ​

• (str): void

Return callback for String

Parameters ​

Returns ​

void

StringResponse ​

Ƭ StringResponse: (dataString: string) => void

Type declaration ​

• (dataString): void

Return string callback

Parameters ​

Returns ​

void

TabGroupOnClickedProps ​

Ƭ TabGroupOnClickedProps: Object

Tab group - click event type

TeamMatchFailureInfo ​

Ƭ TeamMatchFailureInfo: Object

Team jumping game request failed callback

Type declaration ​

TeleportData ​

Ƭ TeleportData: string string[] Record<string, any> Record<string, any>[]

Types of data that can be carried during transmission

TransactionType ​

Ƭ TransactionType: (isSuccess: boolean, content: string) => void

Type declaration ​

• (isSuccess, content): void

Mall communication callback message format

Parameters ​

Returns ​

void

TweenEasingFunction ​

Ƭ TweenEasingFunction: (amount: number) => number

Type declaration ​

• (amount): number

Definition of Types for Slow Functions

Parameters ​

Returns ​

number

TweenInterpolationFunction ​

Ƭ TweenInterpolationFunction: (v: number[], k: number) => number

Type declaration ​

• (v, k): number

Definition of interpolation function types

Parameters ​

Returns ​

number

TweenUnknownProps ​

Ƭ TweenUnknownProps: Record<string, any>

The user can freely expand the definition of the supplementary property

UGCTemplateInfo ​

Ƭ UGCTemplateInfo: Object

UGC Template Information

Type declaration ​

UploadDataResponse ​

Ƭ UploadDataResponse: (success: boolean) => void

Type declaration ​

• (success): void

Download callback message format for character image

Parameters ​

Returns ​

void

VehicleGearDataNew ​

Ƭ VehicleGearDataNew: Object

Four wheel vehicle gear attributes

Type declaration ​

VehicleWheelDataNew ​

Ƭ VehicleWheelDataNew: Object

Four Wheel Vehicle Wheel property

Type declaration ​

VoidResponse ​

Ƭ VoidResponse: () => void

Type declaration ​

• (): void

Return a callback without parameters

Returns ​

void

downloadCharacterDataStringCallback ​

Ƭ downloadCharacterDataStringCallback: (dataString: string) => void

Type declaration ​

• (dataString): void

Download platform data callback

Parameters ​

Returns ​

void

keyUsageInfo ​

Ƭ keyUsageInfo: Object

Large member consumption key order. OrderId: Order ID, boxId: Treasure Box ID, number: Quantity of Treasure Boxes Purchased, shipTime: Shipping Time, Millisecond Timestamp

Type declaration ​

maskWordCheckResult ​

Ƭ maskWordCheckResult: Object

Masked word detect result

Type declaration ​

onAppearanceDataChanged ​

Ƭ onAppearanceDataChanged: (GUID: string) => void

Type declaration ​

• (GUID): void

Character GUID switch success callback

Parameters ​

Returns ​

void

Variables ​

Client ​

• Const Client: FunctionOption other

client

Multicast ​

• Const Multicast: FunctionOption other

Multicast

Result ​

• Const Result: FunctionOption other

Implementing RPC function return values in conjunction with Client Server

Server ​

• Const Server: FunctionOption other

Server side

UILayerBottom ​

• Const UILayerBottom: 1

The bottom level zOrder starts at 100000

UILayerDialog ​

• Const UILayerDialog: 5

Dialogue zOrder starts at 500000

UILayerError ​

• Const UILayerError: 7

Error This layer cannot be used. If you need to add a layer, you can use addUILayerMap zOrder from 700000

UILayerMiddle ​

• Const UILayerMiddle: 2

Mid level zOrder starts at 200000

UILayerOwn ​

• Const UILayerOwn: 3

Exclusive layer (calling this layer will automatically hide the Bottom and Middle layers) zOrder starts at 300000

UILayerScene ​

• Const UILayerScene: 0

Scene zOrder starts at 0

UILayerSystem ​

• Const UILayerSystem: 6

System zOrder started at 600000

UILayerTop ​

• Const UILayerTop: 4

Top level zOrder starts at 400000

Unreliable ​

• Const Unreliable: FunctionOption other

Unreliable RPC

Functions ​

Component ​

• Component<T>(component): T other

Declare the class as mwclass

Type parameters ​

Parameters ​

Returns ​

Property ​

• Property(option?): (target: object, key: string) => void other

Attribute supports synchronization

Parameters ​

Returns ​

RemoteFunction ​

• RemoteFunction(...options): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => void other

Function supports Rpc calling

Parameters ​

Returns ​

Serializable ​

• Serializable<T>(type): T other

Type support replicated

Type parameters ​

Parameters ​

Returns ​

absoluteToLocal ​

• absoluteToLocal(geometry, absolutePosition): Vector2 other

Convert absolute coordinates to relative coordinates

Parameters ​

Returns ​

absoluteToViewport ​

• absoluteToViewport(absoluteDesktopPosition, outPixelPosition, outViewportPosition): void other

Convert the absolute coordinates of geometric shapes in desktop space to local viewport coordinates

Parameters ​

asyncCreateUI ​

• asyncCreateUI<T>(UIPrefabName, panelClass): Promise<T> other

Asynchronous create UI

Type parameters ​

Parameters ​

Returns ​

asyncCreateUIByName ​

• asyncCreateUIByName(UIPath): Promise<UserWidget> other

Asynchronous create UI, null if failed

Parameters ​

Returns ​

cancelDragDrop ​

• cancelDragDrop(): void other

Interrupt all DragDrop operations

createUI ​

• createUI<T>(UIPrefabName, panelClass): T other

Create UIPrefab

Type parameters ​

Parameters ​

Returns ​

createUIByName ​

• createUIByName(UIPrefabName): UserWidget other

Create UIPrefab

Parameters ​

Returns ​

createUIByPath ​

• createUIByPath(UIPath): UserWidget other

Create UIPrefab

Parameters ​

Returns ​

createUIOnlyClass ​

• createUIOnlyClass<T>(panelClass): T other

Create an empty UI

Type parameters ​

Parameters ​

Returns ​

endDragDrop ​

• endDragDrop(InReply): void other

Interrupt a drag event and pass in an action event

Parameters ​

fetch ​

• fetch(url, init?): Promise<Response> other

HTTP request

Parameters ​

Returns ​

findUIScript ​

• findUIScript(UI): UIScript other

Get UI script

Parameters ​

Returns ​

generalHttpRequest ​

• generalHttpRequest(response, requestUrl, param, jsonContent, requestType): boolean other

Universal HTTP Request

Usage example: Send Http request

generalHttpRequest(Response,Url,Param,JsonContent)

generalHttpRequest(Response,Url,Param,JsonContent)

Parameters ​

Returns ​

getAbsoluteSize ​

• getAbsoluteSize(geometry): Vector2 other

Return the size of geometric shapes in absolute space

Parameters ​

Returns ​

getAssetIconDataByAssetID ​

• getAssetIconDataByAssetID(asset, size?): AssetIconData other

Get ICON information of asset

Parameters ​

Returns ​

getCurrentMousePosition ​

• getCurrentMousePosition(): Vector2 other

Get the absolute position of the current mouse

Returns ​

getDragDroppingContent ​

• getDragDroppingContent(): DragDropOperation other

Get the current DragDrop event

Returns ​

getLastMousePosition ​

• getLastMousePosition(): Vector2 other

Get the absolute position of the last mouse

Returns ​

getLocalSize ​

• getLocalSize(geometry): Vector2 other

Return the size of geometric shapes in local space

Parameters ​

Returns ​

getLocalTopLeft ​

• getLocalTopLeft(geometry): Vector2 other

Return the local top/left side of geometric shapes in local space

Parameters ​

Returns ​

getMousePositionOnPlatform ​

• getMousePositionOnPlatform(): Vector2 other

Get the mouse cursor position of the platform. This is the absolute desktop position of the mouse.

Returns ​

getMousePositionOnViewport ​

• getMousePositionOnViewport(): Vector2 other

Retrieve the position of the platform's mouse cursor in the local space of the viewport control.

Returns ​

getPlayerScreenWidgetGeometry ​

• getPlayerScreenWidgetGeometry(player): Geometry other

Gets the geometry of all widget that are added to the "player screen", including widget. You can use this geometric shape to convert controls between absolute and local space.

Parameters ​

Returns ​

getResolutionChanged ​

• getResolutionChanged(Delegate): void other

Callback when resolution change

Parameters ​

getUrlParameter ​

• getUrlParameter(url, parameterName): string other

Get URL parameters

Parameters ​

Returns ​

getViewportScale ​

• getViewportScale(): number other

Gets the current DPI Scale applied to the viewport and all widgets.

Returns ​

getViewportSize ​

• getViewportSize(): Vector2 other

Get the size of the game viewport.

Returns ​

getViewportWidgetGeometry ​

• getViewportWidgetGeometry(): Geometry other

Get the geometric shape of the control that contains all the controls added to the viewport. You can use this geometry to convert widget between absolute and local widget.

Returns ​

httpRequestTransmitData ​

• httpRequestTransmitData(response, paramUrl, jsonContent, requestType): boolean other

Http request API

Parameters ​

Returns ​

isDragDropping ​

• isDragDropping(): boolean other

Determine if there is currently a DragDrop event

Returns ​

isUnderLocation ​

• isUnderLocation(geometry, absolutePosition): boolean other

Determine whether the given coordinates are in geometry

Parameters ​

Returns ​

localToAbsolute ​

• localToAbsolute(geometry, localPosition): Vector2 other

Convert local coordinates to absolute coordinates, which can be desktop space or window space, depending on the space where the root of the widget hierarchy is located.

Parameters ​

Returns ​

localToViewport ​

• localToViewport(geometry, localPosition, outPixelPosition, outViewportPosition): void other

Convert the local coordinates of the geometry to local viewport coordinates.

Parameters ​

releaseAssetIconTextureFromCache ​

• releaseAssetIconTextureFromCache(asset): void other

Try to mark the ICON graph of asset as waiting for release and waiting for release

Parameters ​

screenToViewport ​

• screenToViewport(screenPosition): Vector2 other

Converts the screen position (in pixels) to the local space of the viewport widget.

Parameters ​

Returns ​

screenToWidgetAbsolute ​

• screenToWidgetAbsolute(screenPosition, isIncludeWindowPosition?): Vector2 other

Converts the screen position (pixels) to absolute desktop program coordinates. If bIncludeWindowPosition is true, then this method will also remove the position of the game window (useful in window mode).

Parameters ​

Returns ​

screenToWidgetLocal ​

• screenToWidgetLocal(geometry, screenPosition, isIncludeWindowPosition?): Vector2 other

Convert the screen position (in pixels) to the local space of a widget with a given geometric shape. If bIncludeWindowPosition is true, this method will also remove the position of the game window (useful in window mode).

Parameters ​

Returns ​

setFocusToGameViewport ​

• setFocusToGameViewport(): void other

Set up follow game window

setInputModeGameAndUI ​

• setInputModeGameAndUI(InWidgetToFocus?, InMouseLockMode?, hideCursorDuringCapture?): void other

Set an input mode that only allows the UI to respond to user input. If the UI does not handle it, Player input/Player controller will have a chance

Parameters ​

setInputModeGameOnly ​

• setInputModeGameOnly(): void other

Set an input mode, allowing only Player input/Player controller to respond to user input

setInputModeUIOnly ​

• setInputModeUIOnly(InWidgetToFocus?, InMouseLockMode?): void other

Set the input mode that only allows the UI to respond to user input.

Parameters ​

startRecord ​

• startRecord(screenX, screenY, screenW, screenH): string other

Screen recording

Parameters ​

Returns ​

stopRecord ​

• stopRecord(): void other

Stop screen recording

transformVectorAbsoluteToLocal ​

• transformVectorAbsoluteToLocal(geometry, absoluteVector): Vector2 other

Convert vectors from absolute space to local space

Parameters ​

Returns ​

transformVectorLocalToAbsolute ​

• transformVectorLocalToAbsolute(geometry, localVector): Vector2 other

Convert vectors from local space to absolute space

Parameters ​

Returns ​

urlDecode ​

• urlDecode(str): string other

URL decoding

Parameters ​

Returns ​

urlEncode ​

• urlEncode(str): string other

URL transcoding

Parameters ​

Returns ​

vibrate ​

• vibrate(enable): void other

Vibration switch

Parameters ​