--- title: event_object_docked summary: X4 interface reference. Types are established only within the stated scope. section: reference kind: api status: reference updated: 2026-10-26 tags: ["API","X4"] sources: ["https://wiki.egosoft.com/X4%20Foundations%20Wiki/Modding%20Support/","https://www.lua.org/manual/5.1/manual.html","https://luajit.org/ext_ffi_api.html"] --- ## Return value | Type | Meaning | | --- | --- | | event data | Types describe the declared interface, not proof of a successful game effect. | [Types and methods](wiki:types) ## XML attributes [How schema types work](wiki:schema-types) `libraries/common.xsd` | Attribute | Schema type | Required | Default / fixed | | --- | --- | --- | --- | | `chance` | [`expression`](wiki:schema-expression-b8bc0e4f) | no | not declared | | `comment` | [`comment`](wiki:schema-comment-c44bb2fd) | no | not declared | | `object` | [`expression`](wiki:schema-expression-b8bc0e4f) | no | not declared | | `group` | [`groupeventsource`](wiki:schema-groupeventsource-6492ab7b) | no | not declared | | `check` | [`checkeventsource`](wiki:schema-checkeventsource-7c8f079b) | no | not declared | | `dock` | [`container`](wiki:schema-container-a42d5197) | no | not declared | | `zone` | [`zone`](wiki:schema-zone-543e33c4) | no | not declared | Filter attributes are not the event payload. The types of event.param, event.param2 and subsequent fields must be established for this exact event; the filter schema alone does not declare them. ## Example and context See [language basics](wiki:x4-code-basics), [types and methods](wiki:types) and [Lua / MD events](wiki:md-lua-bridge). Examples there are independent learning examples. No project source files or private implementation fragments are distributed with this reference.