Документация Melonity

NetMessages ​

NetMessages пространство имен предоставляет помощники для отправки, получения и перехвата сетевых сообщений.

Введите псевдонимы ​

Callback<T>(obj: T) => boolean | void ​

Определяет изменяемую подпись обратного вызова, используемую API регистрации NetMessages.

CallbackReadOnly<T>(obj: T) => void ​

Определяет подпись обратного вызова только для чтения, используемую API регистрации NetMessages.

Функции ​

Send<T>(obj: T, msgName: string, reliable?: boolean)пустота ​

Заставить клиента отправить переданное сообщение.

  • objТ - Объект для получения сообщения.
  • msgNameнить - Имя сообщения, которое нужно получить.
  • reliableлогическое значение (необязательный) - Должно ли сообщение быть отправлено надежно. По умолчанию верно.

Recv<T>(obj: T, msgName: string, reliable?: boolean)пустота ​

Заставить клиента получить переданное сообщение.

  • objТ - Объект для получения сообщения.
  • msgNameнить - Имя сообщения, которое нужно получить.
  • reliableлогическое значение (необязательный) - Должно ли сообщение быть отправлено надежно. По умолчанию верно.

RegisterRecv<T>(msgName: string, callback: Callback<T>)пустота ​

Зарегистрируйте обратный вызов, который будет вызываться при получении сообщения. Сообщение будет получено при следующем обновлении основного цикла.

  • msgNameнить - Имя сетевого сообщения.
  • callbackCallback<T> - Функция обратного вызова для регистрации.

RegisterRecvReadOnly<T>(msgName: string, callback: CallbackReadOnly<T>)пустота ​

Зарегистрируйте обратный вызов, который будет вызываться при получении сообщения. Сообщение может быть уже получено.

  • msgNameнить - Имя сетевого сообщения.
  • callbackCallbackReadOnly<T> - Функция обратного вызова для регистрации.

UnregisterRecv<T>(callback: Callback<T>)пустота ​

Отменяет регистрацию ранее зарегистрированного обратного вызова для получения.

  • callbackCallback<T> - Функция обратного вызова для регистрации.

UnregisterRecvReadOnly<T>(callback: Callback<T>)пустота ​

Отменяет регистрацию ранее зарегистрированного обратного вызова приема только для чтения.

  • callbackCallback<T> - Функция обратного вызова для регистрации.

RegisterSend<T>(msgName: string, callback: Callback<T>)пустота ​

Зарегистрируйте обратный вызов, который будет вызываться при отправке сообщения. Сообщение будет отправлено при следующем обновлении основного цикла.

  • msgNameнить - Имя сетевого сообщения.
  • callbackCallback<T> - Функция обратного вызова для регистрации.

RegisterSendReadOnly<T>(msgName: string, callback: CallbackReadOnly<T>)пустота ​

Зарегистрируйте обратный вызов, который будет вызываться при отправке сообщения. Сообщение может быть уже отправлено.

  • msgNameнить - Имя сетевого сообщения.
  • callbackCallbackReadOnly<T> - Функция обратного вызова для регистрации.

UnregisterSend<T>(callback: Callback<T>)пустота ​

Отменяет регистрацию ранее зарегистрированного обратного вызова отправки.

  • callbackCallback<T> - Функция обратного вызова для регистрации.

UnregisterSendReadOnly<T>(callback: Callback<T>)пустота ​

Отменяет регистрацию ранее зарегистрированного обратного вызова отправки только для чтения.

  • callbackCallback<T> - Функция обратного вызова для регистрации.

ToDataView(data: string)DataView ​

Преобразует строковую полезную нагрузку в DataView который можно использовать с API NetMessages.

  • dataнить - Необработанные данные полезной нагрузки.

Вернулся:

  • DataView - Результат звонка.

FromDataView(data: DataView)нить ​

Преобразует DataView полезная нагрузка обратно в ее строковое представление.

  • dataDataView - Необработанные данные полезной нагрузки.

Вернулся:

  • нить - Результат звонка.