Modding: Versioning - Revision history

Tinkerer: /* Dialogs */ Added extra remarks

2018-04-23T12:50:39Z

Dialogs: Added extra remarks

← Older revision		Revision as of 12:50, 23 April 2018
Line 92:		Line 92:

	== Dialogs ==		== Dialogs ==
	~~You can add and change~~ nodes ~~and~~ node connections ~~in dialogs, but~~ never ~~remove~~ nodes~~. The reason is that~~ a ~~game~~ could have ~~been~~ saved while a player ~~was~~ in ~~this~~ node.		Safe changes
			* Adding new nodes
			* Adding new node connections
			* Setting extra flags

			Changes that are never safe:
			* Removing nodes (a player could have saved while they were in this node)

			Other things to be careful about:
			* Changing flag checks on nodes. A player could have saved right before the node(s) you're changing and might not have valid nodes anymore after your changes (because the checked flags are set in earlier nodes only in the new version of the dialog). This will force close the dialog for the player in such cases.
			* Changing dialog structure (remove/change existing node connections). Always make sure that a user that saved during the dialog has a way out.

	== Behaviour scripts ==		== Behaviour scripts ==

Tinkerer: /* Changes that are never safe */

2018-04-18T11:38:40Z

Changes that are never safe

← Older revision		Revision as of 11:38, 18 April 2018
Line 70:		Line 70:

	= Changes that are never safe =		= Changes that are never safe =
	* Anything that makes previously accessible AI-grid non-accessible (a player may have been standing in that place)		* Regenerating the AI-grid: this might change the size of AI-grid, which will break savegames.
			** Anything that makes previously accessible AI-grid non-accessible (a player may have been standing in that place)
	* Changing a root template of an object from a dynamic item (orange cube icon) to a static item (blue cube item)		* Changing a root template of an object from a dynamic item (orange cube icon) to a static item (blue cube item)
	* Do not turn off: CanBeMoved (player may have put this item in a way that now blocks a passage, or have it in their inventory)		* Do not turn off: CanBeMoved (player may have put this item in a way that now blocks a passage, or have it in their inventory)

Tinkerer: /* Changes that are never safe */ Mention that deleting a story file is never safe.

2018-04-16T14:33:21Z

Changes that are never safe: Mention that deleting a story file is never safe.

← Older revision		Revision as of 14:33, 16 April 2018
Line 76:		Line 76:
	* Do not change: Local/Global property.		* Do not change: Local/Global property.
	* Do not remove: Scripts and script vars that have already been assigned		* Do not remove: Scripts and script vars that have already been assigned
			* Do not delete Osiris/story files: story patching does not support removing files. You can however remove all rules from an existing story file by keeping it, but removing all of its contents. See also [[#Story/Osiris\|Story Patching]].

	= Issues related to specific resources =		= Issues related to specific resources =

Tinkerer: /* Second version of your mod */

2017-11-26T15:19:08Z

Second version of your mod

← Older revision		Revision as of 15:19, 26 November 2017
Line 160:		Line 160:

	==== Second version of your mod ====		==== Second version of your mod ====
	You realise that the skeleton is currently allied to all players, and you would rather have it neutral. So you change the alignment in the sidebar to ''Neutral NPC''. Unfortunately, that won't change its alignment in existing ~~savegame~~. Additionally, you forgot to add the dialog for a second skeleton that was also already in the game. Similarly as with the alignment, defining another [[Osiris/Shared/DB_Dialogs\|DB_Dialogs]] in the init section of the goal will only define that dialog for new games.		You realise that the skeleton is currently allied to all players, and you would rather have it neutral. So you change the alignment in the sidebar to ''Neutral NPC''. Unfortunately, that won't change its alignment in existing savegames. Additionally, you forgot to add the dialog for a second skeleton that was also already in the game. Similarly as with the alignment, defining another [[Osiris/Shared/DB_Dialogs\|DB_Dialogs]] in the init section of the goal will only define that dialog for new games.

	Luckily, you can take advantage of story patching to ensure your changes also become available to existing savegames:		Luckily, you can take advantage of story patching to ensure your changes also become available to existing savegames:

Tinkerer: /* First golden rule */

2017-11-26T13:36:45Z

First golden rule

← Older revision		Revision as of 13:36, 26 November 2017
Line 5:		Line 5:
	Never remove anything from your mod: root template, material, script, locals, lsb files, entries in lsb files, stats, etc. You can only add or modify certain things.		Never remove anything from your mod: root template, material, script, locals, lsb files, entries in lsb files, stats, etc. You can only add or modify certain things.

	You can, however, use tricks to "remove" objects: set items/characters [[Osiris/API/SetOnStage\|off-stage]], or move them to inaccessible locations. Keep in mind that if the items can be be picked up, they may already be in a player's inventory and they most likely will not appreciate suddenly losing it.		You can, however, use tricks to "remove" objects: set items/characters [[Osiris/API/SetOnStage\|off-stage]], or move them to inaccessible locations. Keep in mind that if the items can be be picked up, they may already be in a player's inventory and they most likely will not appreciate suddenly losing them.

	= Second golden rule =		= Second golden rule =

Tinkerer: Mention how changes made in the alignment editor affect savegames

2017-11-16T20:00:27Z

Mention how changes made in the alignment editor affect savegames

← Older revision		Revision as of 20:00, 16 November 2017
Line 46:		Line 46:
	* Crime reactions can be changed or modified, but not the properties of the crime itself.		* Crime reactions can be changed or modified, but not the properties of the crime itself.
	* You can add a new tag in the tag editor, but you cannot remove tags there		* You can add a new tag in the tag editor, but you cannot remove tags there
			* Newly defined alignments and alignment entities in the alignment editor (never delete any!)

	= Changes only visible in new games =		= Changes only visible in new games =
Line 66:		Line 67:
	* Most crime properties (lifetime, continuous, audible, etc)		* Most crime properties (lifetime, continuous, audible, etc)
	* You can add/remove a skill to a creature and change the conditions on it.		* You can add/remove a skill to a creature and change the conditions on it.
			* Changes to alignment relations in the alignment editor

	= Changes that are never safe =		= Changes that are never safe =

Tinkerer: /* What is story patching */

2017-11-14T21:39:06Z

What is story patching

← Older revision		Revision as of 21:39, 14 November 2017
Line 121:		Line 121:
	# The story rules of the savegame story are replaced with the story rules of the new version of the mod(s)		# The story rules of the savegame story are replaced with the story rules of the new version of the mod(s)
	# The previously dumped database fact are reimported (without triggering any rules that depend on them)		# The previously dumped database fact are reimported (without triggering any rules that depend on them)
	# All goals that were [[Osiris_Overview#Goal_Initialisation_and_Completion\|active/initialised]] in the savegame story, are again marked as active (based on goal name, regardless of their location in the hierarchy). ~~The same holds for~~ completed goals.		# All goals that were [[Osiris_Overview#Goal_Initialisation_and_Completion\|active/initialised]] in the savegame story, are again marked as active (based on goal name, regardless of their location in the hierarchy). Similarly, completed goals are again marked as completed.
	# If new goals were added to the mod and these new goals are either top-level goals or subgoals of goals that were completed in the savegame, then these new goals will be initialised at this point.		# If new goals were added to the mod and these new goals are either top-level goals or subgoals of goals that were completed in the savegame, then these new goals will be initialised at this point.
	#* Other newly added goals will not be initialised unless their (potentially also new) parent goal completes		#* Other newly added goals will not be initialised unless their (potentially also new) parent goal completes

Tinkerer: /* Second version of your mod */

2017-11-14T18:00:52Z

Second version of your mod

← Older revision		Revision as of 18:00, 14 November 2017
Line 183:		Line 183:
	_Version < 2		_Version < 2
	THEN		THEN
	''// Update version number this patching does not happen every time''		''// Update version number so this patching does not happen every time''
	NOT '''DB_MyPrefix_ModVersion'''(_Version);		NOT '''DB_MyPrefix_ModVersion'''(_Version);
	'''DB_MyPrefix_ModVersion'''(2);		'''DB_MyPrefix_ModVersion'''(2);

Tinkerer: /* Hooking into story patching */

2017-11-14T17:59:00Z

Hooking into story patching

← Older revision		Revision as of 17:59, 14 November 2017
Line 129:		Line 129:

	=== Hooking into story patching ===		=== Hooking into story patching ===
	In most cases, you will also want to manually fix-up certain things in savegames apart from what gets done automatically by the story patching. The most common one is if you change the INIT section of a goal: since that INIT section will not be executed again if the goal was already active in a savegame, you need a way to perform those actions for existing savegames. Another common case is setting certain flags that should have been set under certain conditions, but were not for one reason or another.		In most cases, you will also want to manually fix up certain things in savegames apart from what gets done automatically by the story patching. The most common one is if you change the INIT section of a goal: since that INIT section will not be executed again if the goal was already active in a savegame, you need a way to perform those actions for existing savegames. Another common case is setting certain flags that should have been set under certain conditions, but were not for one reason or another.

	In order to perform such changes, you need two things:		In order to perform such changes, you need two things:

Tinkerer: /* What is story patching */

2017-11-14T17:58:32Z

What is story patching

← Older revision		Revision as of 17:58, 14 November 2017
Line 123:		Line 123:
	# All goals that were [[Osiris_Overview#Goal_Initialisation_and_Completion\|active/initialised]] in the savegame story, are again marked as active (based on goal name, regardless of their location in the hierarchy). The same holds for completed goals.		# All goals that were [[Osiris_Overview#Goal_Initialisation_and_Completion\|active/initialised]] in the savegame story, are again marked as active (based on goal name, regardless of their location in the hierarchy). The same holds for completed goals.
	# If new goals were added to the mod and these new goals are either top-level goals or subgoals of goals that were completed in the savegame, then these new goals will be initialised at this point.		# If new goals were added to the mod and these new goals are either top-level goals or subgoals of goals that were completed in the savegame, then these new goals will be initialised at this point.
	#* Other newly added goals will not be initialised ~~at this point~~		#* Other newly added goals will not be initialised unless their (potentially also new) parent goal completes

	=== When does story patching activate ===		=== When does story patching activate ===