Changes for page Breaking Changes

Summary

• Page properties (2 modified, 0 added, 0 removed)
• Objects (1 modified, 0 added, 0 removed)
  • Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-xwiki:XWiki.klaus
	1	+xwiki:XWiki.nick

Content

...	...	@@ -25,209 +25,19 @@
25	25	)))|=(((
26	26	Summary
27	27	)))
28		-|(% colspan="3" %)(% colspan="3" %)
29		-(((
30		-== 3.20 ==
31		-)))
32		-|(((
33		-Scripts
34		-)))|(((
35		-3.20 Beta 1
36		-)))|(((
37		-Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
38		-)))
39		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
40		-(((
41		-//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
42		-//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
43		-Note that this also means the component attribute to the events is no longer available, so scripts checking the attacked component need to use event.param3.{1} instead//
44		-)))
45	45	|(% colspan="1" %)(% colspan="1" %)
46	46	(((
47	47	Scripts
48	48	)))|(% colspan="1" %)(% colspan="1" %)
49	49	(((
50		-3.20 Beta 1
51		-)))|(% colspan="1" %)(% colspan="1" %)
52		-(((
53		-Removed script property $trade.**restriction.faction**
54		-)))
55		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
56		-(((
57		-//$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.//
58		-)))
59		-|(((
60		-UI extensions
61		-)))|(((
62		-3.20 Beta 1
63		-)))|(((
64		-**Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
65		-)))
66		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
67		-(((
68		-//With the addition of the Trade Rule feature the given functions are obsolete and do not function anymore. This set of functions will return dummy values to avoid breaking scripts. Use GetAllTradeRules(), GetContainerTradeRuleID(), SetContainerTradeRule() and similar trade rule functions as replacement.//
69		-)))
70		-|(% colspan="3" %)(% colspan="3" %)
71		-(((
72		-== 3.10 ==
73		-)))
74		-|(% colspan="1" %)(% colspan="1" %)
75		-(((
76		-Scripts
77		-)))|(% colspan="1" %)(% colspan="1" %)
78		-(((
79		-3.10 Beta 1
80		-)))|(% colspan="1" %)(% colspan="1" %)
81		-(((
82		-Removed script action **<add_build/>**
83		-)))
84		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
85		-(((
86		-//Removed <add_build/> action which was no longer needed and would result in builds being added in unsupported ways. Use other <add_build_xxx/> actions.//
87		-)))
88		-|(% colspan="3" %)(% colspan="3" %)
89		-(((
90		-== 3.00 ==
91		-)))
92		-|(% colspan="1" %)(% colspan="1" %)
93		-(((
94		-Scripts
95		-)))|(% colspan="1" %)(% colspan="1" %)
96		-(((
97		-3.0 Beta 6
98		-)))|(% colspan="1" %)(% colspan="1" %)
99		-(((
100		-Changed behaviour of script action **<get_suitable_job/>**
101		-)))
102		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
103		-(((
104		-//<get_suitable_job/> previously did not respect job quotas or the current number of job ships. It now does, only returning job IDs which are not exceeding the maxgalaxy quota. Using 'exceedquota' allows the action to behave as before.//
105		-)))
106		-|(% colspan="1" %)(% colspan="1" %)
107		-(((
108		-Scripts
109		-)))|(% colspan="1" %)(% colspan="1" %)
110		-(((
111		-3.0 Beta 6
112		-)))|(% colspan="1" %)(% colspan="1" %)
113		-(((
114		-Changed behaviour of script action **<get_ware_definition/>**
115		-)))
116		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
117		-(((
118		-//<get_ware_definition/> previously filtered for equipment wares by default. This is now not the case and existing cases now use flags="equipment". Additional filter attributes for group and tags has also been added.//
119		-)))
120		-|(% colspan="1" %)(% colspan="1" %)
121		-(((
122		-Global
123		-)))|(% colspan="1" %)(% colspan="1" %)
124		-(((
125		-3.0 Beta 5
126		-)))|(% colspan="1" %)(% colspan="1" %)
127		-(((
128		-Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
129		-)))
130		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
131		-(((
132		-//All MD, UI, and cutscene files have been renamed as lower-case. For most users this should have no effect since files packed in catalogs are essentially case-insensitive. However, this change can affect users on Linux systems when running a mod that contains single files instead of a catalog, and/or when playing with unpacked base game files//. If your mod has XML patch files that are not packed in a catalog, the filenames must be lower-case to match the filenames in the base game. (For info on using mod catalogs, see the Readme of the X Catalog Tool.)\\
133		-
134		-//Note that this change has no effect on the actual content of scripts or cutscenes. The MD script/cutscene names are stored in the files, regardless of the filenames, so that references to them remain unchanged (e.g., "md.Setup.Start" references a cue in setup.xml).//
135		-)))
136		-|(% colspan="1" %)(% colspan="1" %)
137		-(((
138		-Scripts
139		-)))|(% colspan="1" %)(% colspan="1" %)
140		-(((
141		-3.0 Beta 5
142		-)))|(% colspan="1" %)(% colspan="1" %)
143		-(((
144		-Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
145		-)))
146		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
147		-(((
148		-//Some MD library cues in the base game that were previously used with <include_actions> have been adjusted, so they must now be used with the new MD action <run_actions> instead. Mods that use such a library with <include_actions> will have to switch to <run_actions> as well. A list of affected libraries is not provided here. Note: Additional library cues may be adjusted in future builds without further warning.//
149		-)))
150		-|(% colspan="1" %)(% colspan="1" %)
151		-(((
152		-Scripts
153		-)))|(% colspan="1" %)(% colspan="1" %)
154		-(((
155		-3.0 Beta 5
156		-)))|(% colspan="1" %)(% colspan="1" %)
157		-(((
158		-Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
159		-)))
160		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
161		-(((
162		-//Before the change, positions are relative to $dockingbay.parent.
163		-After the change, positions are relative to $dockingbay as specified in the documentation.//
164		-)))
165		-|(% colspan="1" %)(% colspan="1" %)
166		-(((
167		-Global
168		-)))|(% colspan="1" %)(% colspan="1" %)
169		-(((
170		-3.0 Beta 2
171		-)))|(% colspan="1" %)(% colspan="1" %)
172		-(((
173		-Support for entity flag "**skillsvisible**" dropped
174		-)))
175		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
176		-(((
177		-//Entity skills are always visible; that flag was a leftover from XR. We removed support for the script property .skillsvisible, the attribute "skillsvisible" of <set_entity_traits> and <set_npc_template_traits>, and the parameter "skillsvisible" of Lua function GetComponentData().//
178		-)))
179		-|(((
180		-Scripts
181		-)))|(((
182		-3.0 Beta 2
183		-)))|(((
184		-Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
185		-)))
186		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
187		-(((
188		-//Before 3.0 Beta 2 there was just a single <event_object//_changed_owner> condition. This condition was triggered in multiple cases when an owner change occurred. However, the exact cases were inconsistent and also the event could have been triggered w/o an effective owner change having been applied.
189		-3.0 Beta 2 fixes these inconsistencies and ensures that the event is only fired, if the "effective" component owner of the object changed. To handle cases where the script actually needs to be informed if the "true" owner of a component was changed (i.e. not taking the cover faction into account) a new <event_object_changed_true_owner> was introduced.
190		-If in your scripts you make use of the <event_object_changed_owner> condition you need to verify that you indeed want to work with the "effective" component owner or whether your script code actually should work with the true owner of an object and update your code accordingly.
191		-On top of that the 3rd parameter of <event_object_changed_owner> (trueprevious) was dropped as the event is no longer triggered upon a change of the true owner alone (i.e. only if the change of the true owner has also an effect on the "effective" component owner).
192		-)))
193		-|(% colspan="1" %)(% colspan="1" %)
194		-(((
195		-Global
196		-)))|(% colspan="1" %)(% colspan="1" %)
197		-(((
198	198	3.0 Beta 1
199	199	)))|(% colspan="1" %)(% colspan="1" %)
200	200	(((
201		-**MissionBoard** support dropped
202		-)))
203		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
204		-(((
205		-//MissionBoards was a dummy asset type which was only used during early development and never meant to be shipped in the released version. If any mod tried to make use of this asset type, undefined behaviour would occur. Therefore we cleaned things up in 3.0 Beta 1 including deprecating/removing any related UI/script function.//
206		-)))
207		-|(((
208		-Job/God
209		-)))|(((
210		-3.0 Beta 1
211		-)))|(((
212		-By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
213		-)))
214		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
215		-(((
216		-//To better support extensions which add to the base game map, a job/god entry now defaults to only spawning objects in areas of the map that are added by the extension in which that entry is defined. You can override this behaviour by adding a matchextension="false" attribute to the job/god entry definition. This allows the entry to spawn objects anywhere that matches the entry's other criteria.//
217		-)))
218		-|(% colspan="1" %)(% colspan="1" %)
219		-(((
220		-Scripts
221		-)))|(% colspan="1" %)(% colspan="1" %)
222		-(((
223		-3.0 Beta 1
224		-)))|(% colspan="1" %)(% colspan="1" %)
225		-(((
226	226	Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
227	227	)))
228	228	|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
229	229	(((
230		-//Due to engine changes, script action <add_actor_to_room/> has had the attribute 'room' changed to 'object', which is more accurate. Most likely requires a 'position' if a slot is not provided.//
	40	+Due to engine changes, script action <add_actor_to_room/> has had the attribute 'room' changed to 'object', which is more accurate. Most likely requires a 'position' if a slot is not provided.
231	231	)))
232	232	|(% colspan="1" %)(% colspan="1" %)
233	233	(((
...	...	@@ -327,33 +327,8 @@
327	327	(((
328	328	//GetMiniGameCursorPosition() was a left over from the XR era and never supposed to be shipped with X4. The function practically always returned 0 and hence we don't expect the removal of this obsolete function causing any actual mod to break.//
329	329	)))
330		-|(((
331		-UI core
332		-)))|(((
333		-3.0 Beta 1
334		-)))|(((
335		-**FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
336		-)))
337		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
338		-(((
339		-//In 3.0 Beta 1 we added support to display icons for keyboard bindings, if an icon is available for the specified keys. This results in GetLocalizedInteractiveNotificationKey() potentially returning a different text now if such an icon is assigned to the mapped key/button.//
340		-)))
341	341	|(% colspan="1" %)(% colspan="1" %)
342	342	(((
343		-UI extensions
344		-)))|(% colspan="1" %)(% colspan="1" %)
345		-(((
346		-3.0 Beta 1
347		-)))|(% colspan="1" %)(% colspan="1" %)
348		-(((
349		-**FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
350		-)))
351		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
352		-(((
353		-//In 3.0 Beta 1 we added support for a new weapon mod property "SurfaceElementFactor" to allow weapons to deal increased damage to surface elements such as Shield Generators, Turrets or Engines.//
354		-)))
355		-|(% colspan="1" %)(% colspan="1" %)
356		-(((
357	357	Scripts
358	358	)))|(% colspan="1" %)(% colspan="1" %)
359	359	(((
...	...	@@ -365,7 +365,7 @@
365	365	|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
366	366	(((
367	367	//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
368		-//It now returns true if $ware is illegal to any faction in the game.//
	153	+\\//It now returns true if $ware is illegal to any faction in the game.//
369	369	)))
370	370	|(% colspan="1" %)(% colspan="1" %)
371	371	(((
...	...	@@ -375,11 +375,13 @@
375	375	3.0 Beta 1
376	376	)))|(% colspan="1" %)(% colspan="1" %)
377	377	(((
378		-MD script **RML_Flight_Along_Path** removed
	163	+'**checkoperational**' filter behaviour changed
379	379	)))
380	380	|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
381	381	(((
382		-//The MD script RML_Flight_Along_Path was not referened and was removed.//
	167	+//Actions and conditions which use the 'checkoperational' filter now behave differently. Instead of changing how 'class' and 'exactclass' behave, checkoperational == true adds an additional filter for the components being of state operational, equivalent to state="componentstate.operational". This is implicitly enabled in action elements (e.g. <find_.../>) or condition elements (e.g. <count_...>), meaning that find_ship will only find operational ships. Using such actions/conditions with checkoperational="false" will include non-operational components such as wrecked and constructions. Existing uses may find that results now exclude non-operational components.//
	168	+
	169	+//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
383	383	)))
384	384	|(% colspan="1" %)(% colspan="1" %)
385	385	(((
...	...	@@ -389,69 +389,23 @@
389	389	3.0 Beta 1
390	390	)))|(% colspan="1" %)(% colspan="1" %)
391	391	(((
392		-parameters of **<event_venture_mission_completed/>** changed
	179	+MD script **RML_Flight_Along_Path** removed
393	393	)))
394	394	|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
395	395	(((
396		-//old params: param = venture details, param2 = ships involved, param3 = duration//
397		-//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
	183	+//The MD script RML_Flight_Along_Path was not referened and was removed.//
398	398	)))
399	399	|(((
400	400	Scripts
401	401	)))|(((
402		-3.0 Beta 1
403		-)))|(((
404		-**<set_object_wing_name/>** removed,
405		-**<set_object_fleet_name/>** added
406		-)))
407		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
408		-(((
409		-//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
410		-)))
411		-|(((
412		-Scripts
413		-)))|(((
414		-3.0 Beta 1
415		-)))|(((
416		-**$controllable.wing.*** removed,
417		-**$controllable.fleet.*** added
418		-)))
419		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
420		-(((
421		-$controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
422		-)))
423		-|(% colspan="3" %)(% colspan="3" %)
424		-(((
425		-== 2.60 ==
426		-)))
427		-|(((
428		-Scripts
429		-)))|(((
430	430	2.60 Beta 1
431	431	)))|(((
432		-'**checkoperational**' filter behaviour changed
	190	+$container.supplyresources behavior changed
433	433	)))
434	434	|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
435	435	(((
436		-//Actions and conditions which use the 'checkoperational' filter now behave differently. Instead of changing how 'class' and 'exactclass' behave, checkoperational == true adds an additional filter for the components being of state operational, equivalent to state="componentstate.operational". This is implicitly enabled in action elements (e.g. <find_.../>) or condition elements (e.g. <count_...>), meaning that find_ship will only find operational ships. Using such actions/conditions with checkoperational="false" will include non-operational components such as wrecked and constructions. Existing uses may find that results now exclude non-operational components.//
437		-
438		-//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
439		-)))
440		-|(((
441		-Scripts
442		-)))|(((
443		-2.60 Beta 1
444		-)))|(((
445		-$container.**supplyresources** behavior changed
446		-)))
447		-|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
448		-(((
449	449	//The script keyword $container.supplyresources now includes reserved wares.//
450	450	)))
451		-|(% colspan="3" %)(% colspan="3" %)
452		-(((
453		-== 2.20 ==
454		-)))
455	455	|(% colspan="1" %)(% colspan="1" %)
456	456	(((
457	457	UI core
...	...	@@ -484,10 +484,6 @@
484	484	(((
485	485	//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
486	486	)))
487		-|(% colspan="3" %)(% colspan="3" %)
488		-(((
489		-== 2.00 ==
490		-)))
491	491	|(% colspan="1" %)(% colspan="1" %)
492	492	(((
493	493	Scripts
...	...	@@ -634,10 +634,6 @@
634	634	(((
635	635	//Changed return value type to const char* to better identify failure reasons in Lua script.//
636	636	)))
637		-|(% colspan="3" %)(% colspan="3" %)
638		-(((
639		-== 1.50 ==
640		-)))
641	641	|(((
642	642	UI extensions
643	643	)))|(((
...	...	@@ -703,10 +703,6 @@
703	703	(((
704	704	(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
705	705	)))
706		-|(% colspan="3" %)(% colspan="3" %)
707		-(((
708		-== 1.32 ==
709		-)))
710	710	|(((
711	711	UI extensions
712	712	)))|(((
...	...	@@ -718,10 +718,6 @@
718	718	(((
719	719	//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
720	720	)))
721		-|(% colspan="3" %)(% colspan="3" %)
722		-(((
723		-== 1.20 ==
724		-)))
725	725	|(((
726	726	UI extensions
727	727	)))|(((

Confluence.Code.ConfluencePageClass[0]

id

...	...	@@ -1,1 +1,1 @@
1		-93553268
	1	+85132000

url

...	...	@@ -1,1 +1,1 @@
1		-https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/93553268/Breaking Changes
	1	+https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/85132000/Breaking Changes