Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 23.1
edited by stefan
on 2019/02/08 12:15
Change comment: finished going through list
To version 13.1
edited by stefan
on 2019/02/01 12:52
Change comment: slightly rephrasing reorganizing paragraphs

Summary

Details

Page properties
Content
... ... @@ -16,7 +16,7 @@
16 16  Please note that UI modding must be considered **unstable** in the current version. While we are working hard to get the UI modding integration into a stable state, we might have to introduce larger backwards incompatibilities in the following patches. This means that you might have to modify any mod using UI modding capabilities to a larger extend to keep it compatible with certain patches. Still, we are doing our best not to unnecessarily break things for modders and certainly will announce such changes on this page here.
17 17  {{/warning}}
18 18  
19 -= Breaking Changes =
19 += Breaking Changes (since 2.0 Beta 1) =
20 20  
21 21  |=(((
22 22  Type
... ... @@ -28,7 +28,7 @@
28 28  |(((
29 29  UI extensions
30 30  )))|(((
31 -2.00 Beta 1
31 +2.0 Beta 1
32 32  )))|(((
33 33  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
34 34  )))
... ... @@ -39,7 +39,7 @@
39 39  |(((
40 40  UI extensions
41 41  )))|(((
42 -2.00 Beta 1
42 +2.0 Beta 1
43 43  )))|(((
44 44  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
45 45  )))
... ... @@ -48,171 +48,3 @@
48 48  //Before 2.0 Beta 1 a call to SetFormationShape() indicated an error state to the caller in certain cases where setting a formation shape (potentially) failed. Due to a design flaw in the handling of formations, this however doesn't do any good, since the function by itself doesn't really set the formation shape in all cases. On top of that the call can fail at random. Hence, at the moment an indication of an error case that setting a formation potentially fails is no good to the caller and he has no means to distinguish that case from a real error case.//
49 49  //Therefore, in 2.0 Beta 1 we drop the error indication in case of an attempt to set the formation fails. We are currently working on a better solution to the underlying problem and hope to have it ready as part of a following beta.//
50 50  )))
51 -|(((
52 -Scripts
53 -)))|(((
54 -2.00 Beta 1
55 -)))|(((
56 -**<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
57 -)))
58 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
59 -(((
60 -//This now enforces a leader and at least one follower in order to create or change a formation.  Former implementation made it possible to create formations without any followers which led to issues.//
61 -)))
62 -|(((
63 -Scripts
64 -)))|(((
65 -2.00 Beta 1
66 -)))|(((
67 -**<event_player_changed_target/>** now fires and returns null if the player deselects a target.
68 -)))
69 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
70 -(((
71 -//For prior behavior, check for event.param being non-null.//
72 -)))
73 -|(((
74 -AI Scripts
75 -)))|(((
76 -2.00 Beta 1
77 -)))|(((
78 -**<shoot/>/<shoot_at/>** attribute changes.
79 -)))
80 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
81 -(((
82 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
83 -//New attribute: "secondary" is an optional attribute that defines whether weapons from the ship's active secondary weapon group will be fired. Defaults to true.//
84 -//New attribute: "missiles" is an optional attribute that defines whether only missile launchers will be used. If false, only guns will be fired. Defaults to false.//
85 -
86 -//Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
87 -)))
88 -|(((
89 -UI extensions
90 -)))|(((
91 -2.00 Beta 1
92 -)))|(((
93 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
94 -)))
95 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
96 -(((
97 -//Added possibility to query build tasks of a certain buildmodule.//
98 -)))
99 -|(((
100 -UI extensions
101 -)))|(((
102 -2.00 Beta 1
103 -)))|(((
104 -**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
105 -)))
106 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
107 -(((
108 -//Added list of resources a buildmodule needs to build.//
109 -)))
110 -|(((
111 -UI extensions
112 -)))|(((
113 -2.00 Beta 1
114 -)))|(((
115 -(% style="color: rgb(0,0,0);" %)**Lua:**(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)** CalculateTotalHullFraction()**(% style="color: rgb(0,0,0);" %)** **(%%)was removed.(% style="color: rgb(0,0,0);" %)
116 -)))
117 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
118 -(((
119 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
120 -)))
121 -|(((
122 -UI extensions
123 -)))|(((
124 -2.00 Beta 1
125 -)))|(((
126 -**FFI: (% style="color: rgb(0,0,0);" %)RequestDockAtReason()/(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)UndockPlayerShip()(%%) **changed their return values.(% style="color: rgb(0,0,0);" class="confluenceTd" %)
127 -)))
128 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
129 -(((
130 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
131 -)))
132 -|(((
133 -UI extensions
134 -)))|(((
135 -1.50 Beta 3
136 -)))|(((
137 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
138 -)))
139 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
140 -(((
141 -//The "docksizes" property no longer includes internal ship storage docks.//
142 -)))
143 -|(((
144 -All
145 -)))|(((
146 -1.50 Beta 2
147 -)))|(((
148 -**Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
149 -)))
150 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
151 -(((
152 -//Shipyards (formerly also known as Capital Shipyards) can build capital ships, while Wharfs only build non-capital ships. To check whether a station is a Shipyard or a Wharf, check whether the station "can build ships".//
153 -
154 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
155 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
156 -//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
157 -)))
158 -|(((
159 -UI extensions
160 -)))|(((
161 -1.50 Beta 2
162 -)))|(((
163 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
164 -)))
165 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
166 -(((
167 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
168 -)))
169 -|(% colspan="1" %)(% colspan="1" %)
170 -(((
171 -UI extensions
172 -)))|(% colspan="1" %)(% colspan="1" %)
173 -(((
174 -1.50 Beta 1
175 -)))|(% colspan="1" %)(% colspan="1" %)
176 -(((
177 -**FFI: SetGuidance()** removed useinfopoint argument.
178 -)))
179 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
180 -(((
181 -//In X Rebirth "info points" existed (which were mainly used as interaction points to scan stations/access information about modules). These were removed in X4 but this left-over property here was missed to be removed in-time for release. It was therefore removed now in order to move towards a stable/clean UI API.
182 -//
183 -
184 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
185 -)))
186 -|(((
187 -UI extensions
188 -)))|(((
189 -1.50 Beta 1
190 -)))|(((
191 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
192 -)))
193 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
194 -(((
195 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
196 -)))
197 -|(((
198 -UI extensions
199 -)))|(((
200 -1.32
201 -)))|(((
202 -**Lua: GetComponentData() **removed the "nextdestname" property.
203 -)))
204 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
205 -(((
206 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
207 -)))
208 -|(((
209 -UI extensions
210 -)))|(((
211 -1.20
212 -)))|(((
213 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
214 -)))
215 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
216 -(((
217 -//The AA setting was changed to check the new setting with the user. In order to restore the old setting (% style="color: rgb(0,0,0);" %)GetAAOption() gets the option to retrieve the config settings.//
218 -)))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -79265840
1 +78577892
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/79265840/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/78577892/Breaking Changes