Документация
Docs/ru/reference/script-api/events.md
События движка
Сгенерированный справочник. Не редактируйте эту страницу вручную. Обновите metadata движка, перегенерируйте
Docs/generated/api.json, затем запуститеpython BuildTools/docs_reference.py --write.
Прочерк в столбце описания означает, что владеющая source metadata не содержит документационного комментария. Каждая ячейка контракта указывает точную классификацию исходника, закреплённый инвентарём контракт области либо неклассифицированное значение по умолчанию; одна лишь доступность символа из скрипта не делает его стабильным.
| Индекс справочника | Каноническая JSON-модель | Контракт генерации |
Эта страница содержит 122 экспортированных событий движка.
Game (client)
| Сигнатура | ID символа | Runtime | Контракт | Флаги | Исходник | Описание |
|---|---|---|---|---|---|---|
event Game.OnConnected() |
script.event.client.Game.OnConnected |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:173 | Выполняется при установлении транспортного соединения клиента. |
event Game.OnConnecting() |
script.event.client.Game.OnConnecting |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:167 | Выполняется непосредственно перед началом запрошенной попытки сетевого соединения. |
event Game.OnConnectingFailed() |
script.event.client.Game.OnConnectingFailed |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:170 | Выполняется при неудаче попытки сетевого соединения. |
event Game.OnCritterAction(bool localCall, Critter cr, CritterAction action, int32 actionData, AbstractItem? contextItem) |
script.event.client.Game.OnCritterAction |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:320 | Выполняется до применения клиентом действия криттера; localCall отличает локальную инициацию от доставки сервером. |
event Game.OnCritterAnimationFallout(hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim, int32& fStateAnim, int32& fActionAnim, int32& fStateAnimEx, int32& fActionAnimEx, uint32& flags) |
script.event.client.Game.OnCritterAnimationFallout |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:335 | Разрешает номера и флаги устаревшей Fallout-анимации; обработчики могут заменить все выходные значения, а StopChain сообщает о неудаче разрешения. |
event Game.OnCritterAnimationFrames(hstring modelName, CritterStateAnim stateAnim, CritterActionAnim actionAnim, int32& pass, uint32& flags, int32& ox, int32& oy, string& animName) |
script.event.client.Game.OnCritterAnimationFrames |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:329 | Разрешает кортеж кадров 2D-анимации; обработчики могут заменить pass, flags, смещения и animName, а StopChain сообщает о неудаче разрешения. |
event Game.OnCritterAnimationInit(Critter cr, CritterStateAnim& stateAnim, CritterActionAnim& actionAnim, AbstractItem? contextItem) |
script.event.client.Game.OnCritterAnimationInit |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:323 | Выполняется до поиска анимации криттера; обработчики могут заменить stateAnim и actionAnim. |
event Game.OnCritterAnimationProcess(Critter cr, CritterStateAnim stateAnim, CritterActionAnim actionAnim, AbstractItem? contextItem, bool refreshAnim) |
script.event.client.Game.OnCritterAnimationProcess |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:326 | Выполняется после выбора анимации и до воспроизведения; refreshAnim отличает обновление вида от действия в очереди. |
event Game.OnCritterAnimationSubstitute(hstring baseModelName, CritterStateAnim baseStateAnim, CritterActionAnim baseActionAnim, hstring& modelName, CritterStateAnim& stateAnim, CritterActionAnim& actionAnim) |
script.event.client.Game.OnCritterAnimationSubstitute |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:332 | Разрешает подстановку анимации; обработчики могут заменить модель и пару анимаций, а StopChain сообщает о неудаче разрешения. |
event Game.OnCritterIn(Critter cr) |
script.event.client.Game.OnCritterIn |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:278 | Выполняется при входе криттера в текущий набор видимых сущностей клиента. |
event Game.OnCritterOut(Critter cr) |
script.event.client.Game.OnCritterOut |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:281 | Выполняется до выхода криттера из текущего набора видимых сущностей клиента. |
event Game.OnCritterVisibilityModeChanged(Critter cr, CritterVisibilityMode mode) |
script.event.client.Game.OnCritterVisibilityModeChanged |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:284 | Выполняется, когда всё ещё видимый криттер меняет режим видимости. |
event Game.OnCustomEntityIn(Entity entity) |
script.event.client.Game.OnCustomEntityIn |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:299 | Выполняется при входе пользовательской сущности в реплицируемый набор сущностей клиента. |
event Game.OnCustomEntityOut(Entity entity) |
script.event.client.Game.OnCustomEntityOut |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:302 | Выполняется до выхода пользовательской сущности из реплицируемого набора сущностей клиента. |
event Game.OnDisconnected() |
script.event.client.Game.OnDisconnected |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:176 | Выполняется после закрытия транспортного соединения клиента. |
event Game.OnFinish() |
script.event.client.Game.OnFinish |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:164 | Выполняется при завершении работы клиента до финализации модулей скриптов. |
event Game.OnInfoMessage(EngineInfoMessage infoMessage, string extraText) |
script.event.client.Game.OnInfoMessage |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:182 | Выполняется для информационного сообщения, полученного от сервера. |
event Game.OnInputLost() |
script.event.client.Game.OnInputLost |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:275 | Выполняется в кадрах, когда окно приложения не в фокусе и опрос ввода пропущен. |
event Game.OnItemInvIn(Item item) |
script.event.client.Game.OnItemInvIn |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:293 | Выполняется при входе предмета в инвентарь выбранного криттера. |
event Game.OnItemInvOut(Item item) |
script.event.client.Game.OnItemInvOut |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:296 | Выполняется при выходе предмета из инвентаря выбранного криттера с использованием отдельного снимка удалённого предмета. |
event Game.OnItemMapIn(Item item) |
script.event.client.Game.OnItemMapIn |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:287 | Выполняется при входе предмета в текущий набор предметов карты клиента. |
event Game.OnItemMapOut(Item item) |
script.event.client.Game.OnItemMapOut |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:290 | Выполняется до выхода предмета из текущего набора предметов карты клиента. |
event Game.OnKeyDown(KeyCode key, string text) |
script.event.client.Game.OnKeyDown |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:269 | Выполняется при нажатии клавиши и включает связанный текстовый ввод, когда он доступен. |
event Game.OnKeyUp(KeyCode key) |
script.event.client.Game.OnKeyUp |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:272 | Выполняется при отпускании клавиши. |
event Game.OnLoginSuccess() |
script.event.client.Game.OnLoginSuccess |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:179 | Выполняется, когда сервер принимает вход и клиент получает сообщение об успешном входе. |
event Game.OnLoop() |
script.event.client.Game.OnLoop |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:188 | Выполняется один раз за клиентский кадр после сети, ввода, запланированных callback и временных событий, но до обработки карты. |
event Game.OnMapLoad() |
script.event.client.Game.OnMapLoad |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:308 | Выполняется после того, как сообщение загрузки локальной или глобальной карты установило новый клиентский контекст карты. |
event Game.OnMapLoaded() |
script.event.client.Game.OnMapLoaded |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:311 | Выполняется, когда сервер подтверждает размещение на карте и клиент помечает карту полностью загруженной. |
event Game.OnMapUnload() |
script.event.client.Game.OnMapUnload |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:314 | Выполняется во время выгрузки текущего контекста карты. |
event Game.OnMapView(mpos hex) |
script.event.client.Game.OnMapView |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:341 | Выполняется, когда сервер запрашивает у клиента просмотр карты вокруг hex. |
event Game.OnMouseDown(MouseButton button) |
script.event.client.Game.OnMouseDown |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:239 | Выполняется при нажатии кнопки мыши; шаги колеса представлены парными нажатиями и отпусканиями виртуальных кнопок. |
event Game.OnMouseMove(ipos offsetPos) |
script.event.client.Game.OnMouseMove |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:245 | Выполняется при перемещении мыши и сообщает покадровое смещение в offsetPos. |
event Game.OnMouseUp(MouseButton button) |
script.event.client.Game.OnMouseUp |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:242 | Выполняется при отпускании кнопки мыши; шаги колеса представлены парными нажатиями и отпусканиями виртуальных кнопок. |
event Game.OnPreLoadMap(hstring locPid, hstring mapPid, isize& screenSize) |
script.event.client.Game.OnPreLoadMap |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:305 | Выполняется до создания представления локальной карты; обработчики могут заменить screenSize для этой карты. |
event Game.OnReceiveItems(Item[] items, any contextParam) |
script.event.client.Game.OnReceiveItems |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:317 | Выполняется для доставленного сервером набора предметов, восстановленного как отдельные клиентские представления предметов с определяемым проектом контекстом. |
event Game.OnRenderIface() |
script.event.client.Game.OnRenderIface |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:194 | Выполняется в области скриптовой отрисовки каждого клиентского кадра до обработки видео в очереди. |
event Game.OnRenderMap_AfterFlatSprites(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_AfterFlatSprites |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:209 | Выполняется сразу после прохода плоских спрайтов для drawArea. |
event Game.OnRenderMap_AfterFlushMap(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_AfterFlushMap |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:236 | Выполняется после переноса render target карты в основную сцену для drawArea. |
event Game.OnRenderMap_AfterFog(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_AfterFog |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:227 | Выполняется сразу после прохода тумана для drawArea, когда отрисовка тумана включена. |
event Game.OnRenderMap_AfterLighting(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_AfterLighting |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:215 | Выполняется сразу после прохода освещения карты для drawArea, когда освещение включено. |
event Game.OnRenderMap_AfterSprites(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_AfterSprites |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:221 | Выполняется сразу после прохода обычных спрайтов карты для drawArea. |
event Game.OnRenderMap_AfterSpritesAndFog(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_AfterSpritesAndFog |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:230 | Выполняется после обычных спрайтов и необязательного прохода тумана для drawArea. |
event Game.OnRenderMap_AfterTiles(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_AfterTiles |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:203 | Выполняется сразу после прохода тайлов карты для drawArea. |
event Game.OnRenderMap_BeforeFlatSprites(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_BeforeFlatSprites |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:206 | Выполняется непосредственно перед проходом плоских спрайтов для drawArea. |
event Game.OnRenderMap_BeforeFlushMap(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_BeforeFlushMap |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:233 | Выполняется до переноса render target карты в основную сцену для drawArea. |
event Game.OnRenderMap_BeforeFog(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_BeforeFog |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:224 | Выполняется непосредственно перед проходом тумана для drawArea, когда отрисовка тумана включена. |
event Game.OnRenderMap_BeforeLighting(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_BeforeLighting |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:212 | Выполняется непосредственно перед проходом освещения карты для drawArea, когда освещение включено. |
event Game.OnRenderMap_BeforeSprites(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_BeforeSprites |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:218 | Выполняется непосредственно перед проходом обычных спрайтов карты для drawArea. |
event Game.OnRenderMap_BeforeTiles(Map map, irect drawArea) |
script.event.client.Game.OnRenderMap_BeforeTiles |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:200 | Выполняется непосредственно перед проходом тайлов карты для drawArea. |
event Game.OnRenderMap_Rebuild(Map map) |
script.event.client.Game.OnRenderMap_Rebuild |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:197 | Выполняется при перестроении кэша отрисовки карты. |
event Game.OnScreenScroll() |
script.event.client.Game.OnScreenScroll |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:191 | Выполняется при изменении экранного смещения представления карты. |
event Game.OnScreenSizeChanged() |
script.event.client.Game.OnScreenSizeChanged |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:338 | Выполняется после сообщения приложения об изменении размера экрана. |
event Game.OnScriptOverrun(string entry, timespan execution, timespan lockWait, int32 count) |
script.event.client.Game.OnScriptOverrun |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:185 | Перед следующим OnLoop сообщает ограниченную сводку превышений времени выполнения скрипта. |
event Game.OnStart() |
script.event.client.Game.OnStart |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:161 | Однократно выполняется после завершения инициализации клиента. |
event Game.OnTouchDoubleTap(ipos screenPos) |
script.event.client.Game.OnTouchDoubleTap |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:260 | Выполняется при распознанном двойном касании в screenPos. |
event Game.OnTouchDown(int64 fingerId, ipos screenPos) |
script.event.client.Game.OnTouchDown |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:248 | Выполняется, когда контакт касания начинается в screenPos. |
event Game.OnTouchMove(int64 fingerId, ipos screenPos, ipos offsetPos) |
script.event.client.Game.OnTouchMove |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:251 | Выполняется при движении контакта касания с текущей экранной позицией и смещением движения. |
event Game.OnTouchScroll(ipos screenPos, ipos offsetPos) |
script.event.client.Game.OnTouchScroll |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:263 | Выполняется для жеста прокрутки касанием с текущей экранной позицией и смещением прокрутки. |
event Game.OnTouchTap(ipos screenPos) |
script.event.client.Game.OnTouchTap |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:257 | Выполняется при распознанном одиночном касании в screenPos. |
event Game.OnTouchUp(int64 fingerId, ipos screenPos) |
script.event.client.Game.OnTouchUp |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:254 | Выполняется, когда контакт касания заканчивается в screenPos. |
event Game.OnTouchZoom(ipos screenPos, float32 factor) |
script.event.client.Game.OnTouchZoom |
client, mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Client/Client.h:266 | Выполняется для жеста масштабирования касанием с его центром и множителем factor. |
Game (mapper)
| Сигнатура | ID символа | Runtime | Контракт | Флаги | Исходник | Описание |
|---|---|---|---|---|---|---|
event Game.OnEditMapLoad(Map map) |
script.event.mapper.Game.OnEditMapLoad |
mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Tools/Mapper.h:328 | Выполняется после загрузки и нормализации карты, но до добавления в список загруженных карт Mapper. |
event Game.OnEditMapSave(Map map) |
script.event.mapper.Game.OnEditMapSave |
mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Tools/Mapper.h:331 | Выполняется после успешной записи карты Mapper и до пометки состояния undo как чистого. |
event Game.OnInspectorProperties(Entity entity, int32[]& properties) |
script.event.mapper.Game.OnInspectorProperties |
mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Tools/Mapper.h:334 | Выполняется при выборе entity в Inspector; обработчики заполняют или переупорядочивают изменяемый список индексов свойств. |
event Game.OnMapperMessage(string& text) |
script.event.mapper.Game.OnMapperMessage |
mapper | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Tools/Mapper.h:325 | Выполняется для отправленного текста консоли Mapper; обработчики могут заменить text, а StopChain подавляет встроенный разбор команды. |
Critter (server)
| Сигнатура | ID символа | Runtime | Контракт | Флаги | Исходник | Описание |
|---|---|---|---|---|---|---|
event Critter.OnBarter(Critter playerCr, bool begin, int32 barterCount) |
script.event.server.Critter.OnBarter |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:212 | Предоставляет определяемое проектом событие жизненного цикла бартера; Engine напрямую его не вызывает. |
event Critter.OnCritterAppeared(Critter appearedCr) |
script.event.server.Critter.OnCritterAppeared |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:173 | Выполняется при входе другого криттера в текущий набор видимости этого криттера. |
event Critter.OnCritterAppearedDist1(Critter appearedCr) |
script.event.server.Critter.OnCritterAppearedDist1 |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:176 | Срабатывает, когда другой видимый криттер входит в дистанционную группу ShowCritterDist1. |
event Critter.OnCritterAppearedDist2(Critter appearedCr) |
script.event.server.Critter.OnCritterAppearedDist2 |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:179 | Срабатывает, когда другой видимый криттер входит в дистанционную группу ShowCritterDist2. |
event Critter.OnCritterAppearedDist3(Critter appearedCr) |
script.event.server.Critter.OnCritterAppearedDist3 |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:182 | Срабатывает, когда другой видимый криттер входит в дистанционную группу ShowCritterDist3. |
event Critter.OnCritterDisappeared(Critter disappearedCr) |
script.event.server.Critter.OnCritterDisappeared |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:185 | Выполняется при выходе другого криттера из текущего набора видимости этого криттера. |
event Critter.OnCritterDisappearedDist1(Critter disappearedCr) |
script.event.server.Critter.OnCritterDisappearedDist1 |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:188 | Срабатывает, когда другой криттер выходит из дистанционной группы ShowCritterDist1 или перестаёт быть видимым. |
event Critter.OnCritterDisappearedDist2(Critter disappearedCr) |
script.event.server.Critter.OnCritterDisappearedDist2 |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:191 | Срабатывает, когда другой криттер выходит из дистанционной группы ShowCritterDist2 или перестаёт быть видимым. |
event Critter.OnCritterDisappearedDist3(Critter disappearedCr) |
script.event.server.Critter.OnCritterDisappearedDist3 |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:194 | Срабатывает, когда другой криттер выходит из дистанционной группы ShowCritterDist3 или перестаёт быть видимым. |
event Critter.OnCritterVisibilityModeChanged(Critter targetCr, CritterVisibilityMode mode) |
script.event.server.Critter.OnCritterVisibilityModeChanged |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:197 | Выполняется, когда targetCr остаётся видимым, но меняет режим видимости для этого криттера. |
event Critter.OnFinish() |
script.event.server.Critter.OnFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:170 | Выполняется во время завершения этого криттера. |
event Critter.OnItemOnMapAppeared(Item item, Critter? dropper) |
script.event.server.Critter.OnItemOnMapAppeared |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:200 | Выполняется при входе предмета карты в набор видимости этого криттера; dropper присутствует при непосредственном выбрасывании криттером. |
event Critter.OnItemOnMapChanged(Item item) |
script.event.server.Critter.OnItemOnMapChanged |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:206 | Выполняется, когда меняется влияющее на представление состояние всё ещё видимого предмета карты. |
event Critter.OnItemOnMapDisappeared(Item item, Critter? picker) |
script.event.server.Critter.OnItemOnMapDisappeared |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:203 | Выполняется при выходе предмета карты из набора видимости этого криттера; picker присутствует, когда предмет подбирает криттер. |
event Critter.OnTalk(Critter playerCr, bool begin, int32 talkers) |
script.event.server.Critter.OnTalk |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Critter.h:209 | Предоставляет определяемое проектом событие жизненного цикла разговора; Engine напрямую его не вызывает. |
Game (server)
| Сигнатура | ID символа | Runtime | Контракт | Флаги | Исходник | Описание |
|---|---|---|---|---|---|---|
event Game.OnCritterFinish(Critter cr) |
script.event.server.Game.OnCritterFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:270 | Выполняется при завершении криттера до снятия его с регистрации. |
event Game.OnCritterInit(Critter cr, bool firstTime) |
script.event.server.Game.OnCritterInit |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:267 | Однократно выполняется перед собственным скриптом инициализации криттера; firstTime отличает создание от восстановления. |
event Game.OnCritterItemMoved(Critter cr, Item item, CritterItemSlot fromSlot) |
script.event.server.Game.OnCritterItemMoved |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:282 | Выполняется после входа предмета в инвентарь криттера, выхода из него или смены слота; fromSlot сообщает предыдущий слот. |
event Game.OnCritterLoad(Critter cr) |
script.event.server.Game.OnCritterLoad |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:273 | Выполняется после загрузки постоянного криттера и перехода под владение сервера. |
event Game.OnCritterMoved(Critter cr, mpos oldHex) |
script.event.server.Game.OnCritterMoved |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:228 | Выполняется после перехода криттера на другой гекс карты и передаёт предыдущий гекс в oldHex. |
event Game.OnCritterPreLoad(Critter cr) |
script.event.server.Game.OnCritterPreLoad |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:264 | Выполняется после восстановления постоянного криттера и принадлежащих ему сущностей, но до входа в мир; StopChain отклоняет загрузку. |
event Game.OnCritterSendInitialInfo(Critter cr) |
script.event.server.Game.OnCritterSendInitialInfo |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:279 | Выполняется, пока сервер готовит исходное состояние управляемого криттера для его игрока. |
event Game.OnCritterStartMoving(Critter cr, bool wasMoving) |
script.event.server.Game.OnCritterStartMoving |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:231 | Выполняется после активации и рассылки контекста перемещения; wasMoving сообщает, заменил ли он активное перемещение. |
event Game.OnCritterStopMoving(Critter cr) |
script.event.server.Game.OnCritterStopMoving |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:234 | Выполняется после остановки активного перемещения криттера и рассылки итогового состояния. |
event Game.OnCritterTransfer(Critter cr, Map? prevMap) |
script.event.server.Game.OnCritterTransfer |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:237 | Выполняется после завершения переноса криттера; prevMap отсутствует, если криттер пришёл не с локальной карты. |
event Game.OnCritterUnload(Critter cr) |
script.event.server.Game.OnCritterUnload |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:276 | Выполняется перед выходом постоянного криттера из владения сервера без уничтожения. |
event Game.OnFinish() |
script.event.server.Game.OnFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:210 | Выполняется при завершении работы сервера до финализации модулей скриптов. |
event Game.OnGenerateWorld() |
script.event.server.Game.OnGenerateWorld |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:204 | Выполняется только для пустой базы данных при создании исходного мира; StopChain прерывает инициализацию сервера. |
event Game.OnGlobalMapCritterIn(Critter cr) |
script.event.server.Game.OnGlobalMapCritterIn |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:240 | Выполняется, когда криттер входит в контейнер глобальной карты. |
event Game.OnGlobalMapCritterOut(Critter cr) |
script.event.server.Game.OnGlobalMapCritterOut |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:243 | Выполняется, когда криттер покидает контейнер глобальной карты. |
event Game.OnInit() |
script.event.server.Game.OnInit |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:201 | Выполняется после инициализации модулей скриптов и до создания или восстановления мира; StopChain прерывает инициализацию сервера. |
event Game.OnItemFinish(Item item) |
script.event.server.Game.OnItemFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:288 | Выполняется при завершении предмета до снятия его с регистрации. |
event Game.OnItemInit(Item item, bool firstTime) |
script.event.server.Game.OnItemInit |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:285 | Однократно выполняется перед собственным скриптом инициализации предмета; firstTime отличает создание от восстановления. |
event Game.OnLocationFinish(Location location) |
script.event.server.Game.OnLocationFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:249 | Выполняется при завершении локации до уничтожения её карт. |
event Game.OnLocationInit(Location location, bool firstTime) |
script.event.server.Game.OnLocationInit |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:246 | Однократно выполняется перед собственным скриптом инициализации локации; firstTime отличает создание от восстановления. |
event Game.OnMapCritterIn(Map map, Critter cr) |
script.event.server.Game.OnMapCritterIn |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:258 | Выполняется после присоединения криттера к локальной карте. |
event Game.OnMapCritterOut(Map map, Critter cr) |
script.event.server.Game.OnMapCritterOut |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:261 | Выполняется перед отсоединением криттера от локальной карты. |
event Game.OnMapFinish(Map map) |
script.event.server.Game.OnMapFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:255 | Выполняется при завершении карты до снятия её с регистрации. |
event Game.OnMapInit(Map map, bool firstTime) |
script.event.server.Game.OnMapInit |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:252 | Однократно выполняется перед собственным скриптом инициализации карты; firstTime отличает создание от восстановления. |
event Game.OnPlayerCritterSwitched(Player player, Critter cr, Critter prevCr) |
script.event.server.Game.OnPlayerCritterSwitched |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:219 | Выполняется после переключения игрока с prevCr на cr и отправки исходной информации о криттере. |
event Game.OnPlayerDirCritter(Player player, Critter cr, mdir& dir) |
script.event.server.Game.OnPlayerDirCritter |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:225 | Проверяет запрос игрока на смену направления; обработчики могут заменить dir, а StopChain отклоняет запрос. |
event Game.OnPlayerLogin(Player player, Player? notLoggedInPlayer) |
script.event.server.Game.OnPlayerLogin |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:213 | Выполняется после отправки успешного входа и до настройки после входа; notLoggedInPlayer присутствует только при переподключении, а StopChain отклоняет вход. |
event Game.OnPlayerLogout(Player player) |
script.event.server.Game.OnPlayerLogout |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:216 | Выполняется после обнаружения жёсткого разрыва соединения и до отсоединения и снятия игрока с регистрации. |
event Game.OnPlayerMoveCritter(Player player, Critter cr, int32& speed) |
script.event.server.Game.OnPlayerMoveCritter |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:222 | Проверяет запрос игрока на перемещение; обработчики могут заменить speed, а StopChain отклоняет запрос. |
event Game.OnStart() |
script.event.server.Game.OnStart |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:207 | Выполняется после создания или восстановления мира и до начала штатной работы сервера; StopChain прерывает запуск. |
event Game.OnStaticItemWalk(StaticItem item, Critter cr, bool isIn, mdir dir) |
script.event.server.Game.OnStaticItemWalk |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Server.h:291 | Выполняется, когда криттер пересекает область триггера статического предмета; isIn отличает вход от выхода. |
Item (server)
| Сигнатура | ID символа | Runtime | Контракт | Флаги | Исходник | Описание |
|---|---|---|---|---|---|---|
event Item.OnCritterWalk(Critter critter, bool isIn, mdir dir) |
script.event.server.Item.OnCritterWalk |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Item.h:87 | Выполняется, когда криттер пересекает область триггера этого статического предмета; isIn отличает вход от выхода. |
event Item.OnFinish() |
script.event.server.Item.OnFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Item.h:84 | Выполняется во время завершения этого предмета. |
Location (server)
| Сигнатура | ID символа | Runtime | Контракт | Флаги | Исходник | Описание |
|---|---|---|---|---|---|---|
event Location.OnFinish() |
script.event.server.Location.OnFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Location.h:76 | Выполняется во время завершения этой локации. |
event Location.OnMapAdded(Map map) |
script.event.server.Location.OnMapAdded |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Location.h:79 | Выполняется после добавления карты в эту локацию. |
event Location.OnMapRemoved(Map map) |
script.event.server.Location.OnMapRemoved |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Location.h:82 | Выполняется при удалении карты из этой локации. |
Map (server)
| Сигнатура | ID символа | Runtime | Контракт | Флаги | Исходник | Описание |
|---|---|---|---|---|---|---|
event Map.OnCheckLook(Critter cr, Critter target) |
script.event.server.Map.OnCheckLook |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Map.h:146 | Предоставляет определяемую проектом проверку видимости криттера; Engine напрямую её не вызывает. |
event Map.OnCheckTrapLook(Critter cr, Item item) |
script.event.server.Map.OnCheckTrapLook |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Map.h:149 | Предоставляет определяемую проектом проверку видимости ловушки; Engine напрямую её не вызывает. |
event Map.OnFinish() |
script.event.server.Map.OnFinish |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Map.h:143 | Выполняется во время завершения этой карты. |
Player (server)
| Сигнатура | ID символа | Runtime | Контракт | Флаги | Исходник | Описание |
|---|---|---|---|---|---|---|
event Player.OnAllowCommand(string arg1, uint8 arg2) |
script.event.server.Player.OnAllowCommand |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Player.h:125 | Предоставляет определяемый проектом callback авторизации команд; Engine напрямую его не вызывает. |
event Player.OnGetAccess(int32 arg1, string& arg2) |
script.event.server.Player.OnGetAccess |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Player.h:122 | Предоставляет определяемый проектом callback доступа игрока с целочисленным входом и изменяемым текстовым аргументом; Engine напрямую его не вызывает. |
event Player.OnLogout() |
script.event.server.Player.OnLogout |
server | experimental (область)с версии 2022.1.0.wipисходник контракта: Source/Common/Common.h:47 |
- | Source/Server/Player.h:128 | Предоставляет определяемый проектом callback выхода игрока; Engine напрямую его не вызывает. |