Natives (Settings) RU - samp-incognito/samp-streamer-plugin GitHub Wiki

Главная ▸ Функции ▸ Настройки

Страница находится в стадии перевода.

Streamer_GetTickRate()

  • Параметры:
    • Нет.
  • Возвращаемые значения:
    • Частота обновления.

Получает текущую частоту обновления.

Streamer_SetTickRate(rate)

  • Параметры:
    • rate: Частота обновления.
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Изменяет частоту обновления.

  • Стандартное значение: 50.
  • Частота обновления не является какой-то конкретной единицей измерения времени и меняется в зависимости от мощности процессора сервера.

Streamer_GetMaxItems(type)

  • Параметры:
  • Возвращаемые значения:
    • Максимальное количество (лимит) элементов данного типа.

Получает максимальное количество элементов указанного типа, которое может быть создано с использованием функций плагина.

Streamer_SetMaxItems(type, items)

  • Параметры:
    • type: Тип элемента.
    • items: Лимит элементов (-1 для неограниченного количества).
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Изменяет максимальное количество элементов указанного типа, которое может быть создано с использованием функций плагина.

  • По умолчанию, ограничения нет (-1).

Streamer_GetVisibleItems(type, playerid = -1)

  • Параметры:
  • Возвращаемые значения:
    • Количество видимых элементов.

Получает текущее количество видимых элементов указанного типа и игрока.

Streamer_SetVisibleItems(type, items, playerid = -1)

  • Параметры:
    • type: Тип элемента.
    • items: Количество видимых элементов.
    • playerid: ID игрока.
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Изменяет количество видимых элементов указанного типа для игрока

  • Стандартные значения:
    • Объекты: 500;
    • Пикапы: 4096;
    • Иконки карты: 100;
    • Текстовые 3D лейблы: 1024.
  • Эта функция не может быть использована с чекпоинтами, гоночными чекпоинтами, или зонами.

Streamer_GetRadiusMultiplier(type, &Float:multiplier, playerid = -1)

  • Параметры:
  • Возвращаемые значения:
    • 0 on failure, 1 on success.

Получает текущий коэффициент радиуса прорисовки для элементов указанного типа и игрока.

Streamer_SetRadiusMultiplier(type, Float:multiplier, playerid = -1)

  • Параметры:
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Изменяет коэффициент радиуса прорисовки для указанного типа элементов и игрока.

  • По умолчанию, коэффициент равен 1.0 для всех игроков.
  • К примеру, коэффициент 0.5 уменьшит радиус прорисовки всех объектов в два раза.

При установке радиуса 0.5 будет необходимо, чтобы игрок находился на расстоянии в два раза ближе, чем обычно, для того чтобы объект был прорисован.

Streamer_GetTypePriority(types[], maxtypes = sizeof types)

  • Параметры:
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Получает приоритет для указанных типов элементов (порядок, согласно которому элементы будут появляться).

Streamer_SetTypePriority(const types[], maxtypes = sizeof types)

  • Параметры:
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Изменяет приоритет для указанных типов элементов (порядок, согласно которому элементы будут появляться).

  • По умолчанию, порядок следующий: зоны, объекты, чекпоинты, гоночные чекпоинты, иконки карты, текстовые 3D лейблы, пикапы.

Streamer_GetCellDistance(&Float:distance)

  • Параметры:
    • distance: Дистанция ячейки.
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Получает текущую дистанцию ячейки.

Streamer_SetCellDistance(Float:distance)

  • Параметры:
    • distance: Дистанция ячейки.
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Изменяет текущую дистанцию ячейки.

  • Значение по умолчанию: 600.0.
  • Это значение используется для того, чтобы определить, необходимо ли помещать элемент в ячейку для пространственного индексирования. Если дистанция видимости элемента (в случае с зонами, это - размер зоны) превышает дистанцию ячейки, то элемент будет виден и доступен из любой точки игровой карты.
  • Например, если дистанция отображения иконки на карте равна 100.0, то она будет отображена игроку только если он находится в той же ячейке, в которой находится иконка, или же в соседней ячейке (при условии, что для дистанции ячейки используется стандартное значение 600.0). Однако, если дистанция отображения иконки карты была изменена на 1000.0, то иконка будет видна всегда, в независимости от того, где находится игрок.
  • В большинстве случаев это значение не изменяется. Оно может быть увеличено, например, если у вас много объектов с большой дистанцией видимости (превышающей стандартный размер ячейки 600.0), но при этом, вы всё же хотите использовать пространственную индексацию.
  • Размер ячейки (не дистанция) может быть изменён как угодно. Смотрите документацию к функции 'Streamer_SetCellSize'.
  • Данная функция перестраивает сетку, так что используйте её только при возникновении необходимости.

Streamer_GetCellSize(&Float:size)

  • Параметры:
    • size: Размер ячейки.
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Получает текущий размер ячейки.

Streamer_SetCellSize(Float:size)

  • Параметры:
    • size: Размер ячейки.
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Устанавливает размер ячейки.

  • Стандартное значение: 300.0.
  • Данное значение определяет размер каждой ячейки в сетке.
  • В большинстве случаев изменять данное значение не рекомендуется. Причиной увеличения размера ячейки может стать изменение дистанции ячейки. Смотрите документацию к функции Streamer_SetCellDistance.
  • Хорошим размером ячейки является половина дистанции ячейки. Например, стандартное значение дистанции ячейки равно 600.0, значит будет лучше всего, если размер ячейки будет равен 300.0.
  • Чем больше размер ячейки, тем менее эффективна сетка при пространственном индексировании.
  • Данная функция перестраивает сетку, так что используйте её только при возникновении необходимости.

Streamer_ToggleItemStatic(type, id, toggle)

  • Параметры:
    • type: Тип элемента.
    • id: ID элемента.
    • toggle: 0 чтобы сделать элемент динамическим, 1 чтобы сделать элемент статическим.
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Делает элемент статическим или динамическим.

  • Если элемент статический, то все проверки на расстояние для него пропускаются, и данный элемент получает приоритет над всеми динамическими элементами.
  • Эффект от использования функции схож с тем, когда значение дистанции видимости элемента изменяется на отрицательное. При отключении данной функции для какого-либо элемента, значение дистанции видимости будет изменено на стандартное.

Streamer_IsToggleItemStatic(type, id)

  • Параметры:
  • Возвращаемые значения:
    • 0 или 1.

Данная функция вернёт 1, если элемент id является статическим, или 0, если динамическим. Смотрите документацию к функции Streamer_ToggleItemStatic.

Streamer_ToggleItemAntiAreas(type, id, toggle)

  • Параметры:
  • Возвращаемые значения:
    • 0 on failure, 1 on success.

Toggles whether the per-item area functionality (used via the areaid or areas parameters) is used to exclude items from being streamed if they are within the areas specified.

Streamer_IsToggleItemAntiAreas(type, id)

  • Параметры:
    • type: The item type.
    • id: ID элемента.
  • Возвращаемые значения:
    • 0 или 1.

Returns whether Streamer_ToggleItemAntiAreas is turned on.

Streamer_ToggleItemCallbacks(type, id, toggle)

  • Parameters:
    • type: The item type.
    • id: The item ID.
    • toggle: 0 to turn off, 1 to turn on.
  • Returns:
    • 0 on failure, 1 on success.

Toggles the callbacks (Streamer_OnItemStreamIn and Streamer_OnItemStreamOut) for the specified item.

  • By default, this is turned off for each item.

Streamer_IsToggleItemCallbacks(type, id)

  • Parameters:
  • Returns:
    • 0 or 1.

Returns whether Streamer_ToggleItemCallbacks is enabled for the specified item.

Streamer_ToggleErrorCallback(toggle)

  • Параметры:
    • toggle: 0 для выключения, 1 для отключения.
  • Возвращаемые значения:
    • 0 в случае неудачи, 1 в случае успеха.

Включает или отключает автовызываемую функцию (коллбэк), с помощью которой можно отловить ошибки плагина (Streamer_OnPluginError).

  • Если коллбэк ошибок включён, ваш скрипт может обрабатывать сообщения об ошибках при их возникновении.
  • Данная функция особенно полезна в сочетании с функцией PrintAmxBacktrace плагина CrashDetect, так как станет возможным узнать точное место, где возникла ошибка.
  • Когда коллбэк ошибок включён, плагин не будет выводить сообщения в консоль сервера, а вместо этого будет направлять сообщения в данный коллбэк.

Streamer_IsToggleErrorCallback()

  • Параметры:
    • Нет.
  • Возвращаемые значения:
    • 0 или 1.

Returns whether Streamer_ToggleErrorCallback is enabled.