ActionE - Revision history

Planetmaker: /* Notes */ Iconize also information that force-activation is not supported by OpenTTD

2011-10-08T05:11:37Z

Notes: Iconize also information that force-activation is not supported by OpenTTD

← Older revision		Revision as of 05:11, 8 October 2011
Line 60:		Line 60:
	To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.		To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.

	If the given GRFID is identical to the GRFID of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.		{{ottdp\|no\| }} If the given GRFID is identical to the GRFID of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely. It is best to limit this forced activation to as few actions as possible for maximum compatibility. Forced activation is not supported by OpenTTD.

	It is best to limit this forced activation to as few actions as possible for maximum compatibility. Forced activation is not supported by OpenTTD.

	In principle, there can be four cases and your .grf file must be able to handle all of them properly:		In principle, there can be four cases and your .grf file must be able to handle all of them properly:

Yexo: /* Notes */

2011-10-07T23:11:30Z

Notes

← Older revision		Revision as of 23:11, 7 October 2011
Line 62:		Line 62:
	If the given GRFID is identical to the GRFID of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.		If the given GRFID is identical to the GRFID of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.

	It is best to limit this forced activation to as few actions as possible for maximum compatibility.		It is best to limit this forced activation to as few actions as possible for maximum compatibility. Forced activation is not supported by OpenTTD.

	In principle, there can be four cases and your .grf file must be able to handle all of them properly:		In principle, there can be four cases and your .grf file must be able to handle all of them properly:

Frosch: fix conversion and remove redundant duplication

2011-06-18T12:55:00Z

fix conversion and remove redundant duplication

← Older revision		Revision as of 12:55, 18 June 2011
Line 66:		Line 66:
	In principle, there can be four cases and your .grf file must be able to handle all of them properly:		In principle, there can be four cases and your .grf file must be able to handle all of them properly:
	* The .grf file is active and can not be deactivated.		* The .grf file is active and can not be deactivated.
		⚫	: You cannot use action E in this case.

⚫	+ You cannot use action E in this case.
	* The .grf file is inactive but will be activated.		* The .grf file is inactive but will be activated.
		⚫	: This is the only case in which action E is useful, the .grf file coming below the current one in newgrf(w).cfg but being set to be activated. Action E will set it to not be activated when it is processed.

⚫	+ This is the only case in which action E is useful, the .grf file coming below the current one in newgrf(w).cfg but being set to be activated. Action E will set it to not be activated when it is processed.
	* The .grf file is inactive and will not be activated.		* The .grf file is inactive and will not be activated.
		⚫	: This can happen because it has been processed already (it comes earlier in newgrf(w).cfg) and was deactivated, either by default or manually.

⚫	+ This can happen because it has been processed already (it comes earlier in newgrf(w).cfg) and was deactivated, ~~either by default or manually. Another possibility is that the file is disabled~~ either by default or manually.

	== Example ==		== Example ==

Pm-bot: grf id to GRFID

2011-06-15T16:10:12Z

grf id to GRFID

← Older revision		Revision as of 16:10, 15 June 2011
Line 31:		Line 31:

	\|-		\|-
	\|<GRFIDs...>\|\|4*B\|\|~~GRF IDs~~ of the sets to deactivate		\|<GRFIDs...>\|\|4*B\|\|GRFIDs of the sets to deactivate
	\|}		\|}

Line 50:		Line 50:
	=== GRFIDs ===		=== GRFIDs ===

	Here you give the list of ~~GRF IDs~~, in the same format as in [[Action8]], which should be deactivated.		Here you give the list of GRFIDs, in the same format as in [[Action8]], which should be deactivated.

	=== Notes ===		=== Notes ===

	Note that it is invalid to attempt the deactivation of already active graphics files. You can only prevent files lower down the newgrf(w).cfg from becoming active later. Therefore, you must check that none of the ~~GRF IDs~~ in this list are active already using the appropriate action 7. If the deactivation of an already active set is attempted, the current set is considered invalid and will be disabled.		Note that it is invalid to attempt the deactivation of already active graphics files. You can only prevent files lower down the newgrf(w).cfg from becoming active later. Therefore, you must check that none of the GRFIDs in this list are active already using the appropriate action 7. If the deactivation of an already active set is attempted, the current set is considered invalid and will be disabled.

	If you attempt to deactivate a set that isn't loaded, nothing happens.		If you attempt to deactivate a set that isn't loaded, nothing happens.

Pm-bot: use GRFID consistently

2011-06-15T16:05:49Z

use GRFID consistently

← Older revision		Revision as of 16:05, 15 June 2011
Line 13:		Line 13:
	The data looks as follows:		The data looks as follows:

	<Sprite-number> * <Length> 0E <num> <~~grfIDs~~...>		<Sprite-number> * <Length> 0E <num> <GRFIDs...>

	{\|		{\|
Line 31:		Line 31:

	\|-		\|-
	\|<~~grfIDs~~...>\|\|4*B\|\|GRF IDs of the sets to deactivate		\|<GRFIDs...>\|\|4*B\|\|GRF IDs of the sets to deactivate
	\|}		\|}

Line 48:		Line 48:
	This is the number of sets you want to deactivate.		This is the number of sets you want to deactivate.

	=== ~~grfIDs~~ ===		=== GRFIDs ===

	Here you give the list of GRF IDs, in the same format as in [[Action8]], which should be deactivated.		Here you give the list of GRF IDs, in the same format as in [[Action8]], which should be deactivated.
Line 60:		Line 60:
	To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.		To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.

	If the given ~~grfID~~ is identical to the ~~grfID~~ of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.		If the given GRFID is identical to the GRFID of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.

	It is best to limit this forced activation to as few actions as possible for maximum compatibility.		It is best to limit this forced activation to as few actions as possible for maximum compatibility.
Line 77:		Line 77:
	== Example ==		== Example ==

	The following is an example to deactivate ~~grfID~~ 54570105 if possible, and deactivate the current file instead if not.		The following is an example to deactivate GRFID 54570105 if possible, and deactivate the current file instead if not.

	47 * 9 07 88 04 06 54 57 01 05 02		47 * 9 07 88 04 06 54 57 01 05 02
Line 84:		Line 84:
	50 * x 0B 01 1F FF ... (e.g. "This file is deactivated because incompatible graphics are active.")		50 * x 0B 01 1F FF ... (e.g. "This file is deactivated because incompatible graphics are active.")
	51 * 6 07 83 01 03 7F 00		51 * 6 07 83 01 03 7F 00
	52 * x 0B 01 1F FF ... (e.g. "Deactivating ~~grfID~~ 54570105.")		52 * x 0B 01 1F FF ... (e.g. "Deactivating GRFID 54570105.")
	53 * 6 0E 01 54 57 01 05		53 * 6 0E 01 54 57 01 05

	This carries out the following instructions:		This carries out the following instructions:

	<pre>47: if (~~grfID~~ 54570105 is active) goto 50		<pre>47: if (GRFID 54570105 is active) goto 50

	48: if (~~grfID~~ 54570105 is inactive but will be activated) goto 52		48: if (GRFID 54570105 is inactive but will be activated) goto 52

	49: goto 54		49: goto 54
Line 99:		Line 99:
	51: deactivate_current_file		51: deactivate_current_file

	52: showmessage("Deactivating ~~grfID~~ 54570105.")		52: showmessage("Deactivating GRFID 54570105.")

	53: deactivate(54570105);		53: deactivate(54570105);
Line 105:		Line 105:
	continue_with_current_file;</pre>		continue_with_current_file;</pre>

	The reason for this particular order of pseudo-sprites is that action 7 will not take a branch if the queried ~~grfID~~ is not present at all. In that case, both sprites 47 and 48 fall through, which means the jump in 49 is carried out and the file resumes processing. The unconditional gotos in 49 and 51 are actually conditional on the climate not being 7F, which it never can be.		The reason for this particular order of pseudo-sprites is that action 7 will not take a branch if the queried GRFID is not present at all. In that case, both sprites 47 and 48 fall through, which means the jump in 49 is carried out and the file resumes processing. The unconditional gotos in 49 and 51 are actually conditional on the climate not being 7F, which it never can be.

	Conceptually, without goto-logic, the code could be described by		Conceptually, without goto-logic, the code could be described by

	<pre>if (~~grfID~~ 54570105 is active) {		<pre>if (GRFID 54570105 is active) {

	showerror("This file is deactivated because incompatible graphics are active.")		showerror("This file is deactivated because incompatible graphics are active.")
Line 115:		Line 115:
	deactivate_current_file		deactivate_current_file

	} else if (~~grfID~~ 54570105 is inactive but will be activated) {		} else if (GRFID 54570105 is inactive but will be activated) {

	showmessage("Deactivating ~~grfID~~ 54570105.")		showmessage("Deactivating GRFID 54570105.")

	deactivate(54570105);		deactivate(54570105);

Pm-bot: use grfID consistently

2011-06-15T16:04:12Z

use grfID consistently

← Older revision		Revision as of 16:04, 15 June 2011
Line 13:		Line 13:
	The data looks as follows:		The data looks as follows:

	<Sprite-number> * <Length> 0E <num> <~~grfids~~...>		<Sprite-number> * <Length> 0E <num> <grfIDs...>

	{\|		{\|
Line 31:		Line 31:

	\|-		\|-
	\|<~~grfids~~...>\|\|4*B\|\|GRF IDs of the sets to deactivate		\|<grfIDs...>\|\|4*B\|\|GRF IDs of the sets to deactivate
	\|}		\|}

Line 48:		Line 48:
	This is the number of sets you want to deactivate.		This is the number of sets you want to deactivate.

	=== ~~grfids~~ ===		=== grfIDs ===

	Here you give the list of GRF IDs, in the same format as in [[Action8]], which should be deactivated.		Here you give the list of GRF IDs, in the same format as in [[Action8]], which should be deactivated.
Line 60:		Line 60:
	To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.		To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.

	If the given ~~GRFID~~ is identical to the ~~GRFID~~ of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.		If the given grfID is identical to the grfID of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.

	It is best to limit this forced activation to as few actions as possible for maximum compatibility.		It is best to limit this forced activation to as few actions as possible for maximum compatibility.
Line 77:		Line 77:
	== Example ==		== Example ==

	The following is an example to deactivate ~~GRFID~~ 54570105 if possible, and deactivate the current file instead if not.		The following is an example to deactivate grfID 54570105 if possible, and deactivate the current file instead if not.

	47 * 9 07 88 04 06 54 57 01 05 02		47 * 9 07 88 04 06 54 57 01 05 02
Line 84:		Line 84:
	50 * x 0B 01 1F FF ... (e.g. "This file is deactivated because incompatible graphics are active.")		50 * x 0B 01 1F FF ... (e.g. "This file is deactivated because incompatible graphics are active.")
	51 * 6 07 83 01 03 7F 00		51 * 6 07 83 01 03 7F 00
	52 * x 0B 01 1F FF ... (e.g. "Deactivating ~~GRFID~~ 54570105.")		52 * x 0B 01 1F FF ... (e.g. "Deactivating grfID 54570105.")
	53 * 6 0E 01 54 57 01 05		53 * 6 0E 01 54 57 01 05

	This carries out the following instructions:		This carries out the following instructions:

	<pre>47: if (~~GRFID~~ 54570105 is active) goto 50		<pre>47: if (grfID 54570105 is active) goto 50

	48: if (~~GRFID~~ 54570105 is inactive but will be activated) goto 52		48: if (grfID 54570105 is inactive but will be activated) goto 52

	49: goto 54		49: goto 54
Line 99:		Line 99:
	51: deactivate_current_file		51: deactivate_current_file

	52: showmessage("Deactivating ~~GRFID~~ 54570105.")		52: showmessage("Deactivating grfID 54570105.")

	53: deactivate(54570105);		53: deactivate(54570105);
Line 105:		Line 105:
	continue_with_current_file;</pre>		continue_with_current_file;</pre>

	The reason for this particular order of pseudo-sprites is that action 7 will not take a branch if the queried ~~GRFID~~ is not present at all. In that case, both sprites 47 and 48 fall through, which means the jump in 49 is carried out and the file resumes processing. The unconditional gotos in 49 and 51 are actually conditional on the climate not being 7F, which it never can be.		The reason for this particular order of pseudo-sprites is that action 7 will not take a branch if the queried grfID is not present at all. In that case, both sprites 47 and 48 fall through, which means the jump in 49 is carried out and the file resumes processing. The unconditional gotos in 49 and 51 are actually conditional on the climate not being 7F, which it never can be.

	Conceptually, without goto-logic, the code could be described by		Conceptually, without goto-logic, the code could be described by

	<pre>if (~~GRFID~~ 54570105 is active) {		<pre>if (grfID 54570105 is active) {

	showerror("This file is deactivated because incompatible graphics are active.")		showerror("This file is deactivated because incompatible graphics are active.")
Line 115:		Line 115:
	deactivate_current_file		deactivate_current_file

	} else if (~~GRFID~~ 54570105 is inactive but will be activated) {		} else if (grfID 54570105 is inactive but will be activated) {

	showmessage("Deactivating ~~GRFID~~ 54570105.")		showmessage("Deactivating grfID 54570105.")

	deactivate(54570105);		deactivate(54570105);

Pm-bot: Beautify wiki markup

2011-06-15T14:48:41Z

Beautify wiki markup

← Older revision		Revision as of 14:48, 15 June 2011
Line 1:		Line 1:

	== Introduction ==		== Introduction ==

Line 10:		Line 9:
	However, when new sets come out, it is often not feasible to change all existing sets so that they can detect the new set. This action therefore allows the new graphics set to deactivate older sets with which it is incompatible.		However, when new sets come out, it is often not feasible to change all existing sets so that they can detect the new set. This action therefore allows the new graphics set to deactivate older sets with which it is incompatible.

	==Syntax==		== Syntax ==

	The data looks as follows:		The data looks as follows:
Line 35:		Line 34:
	\|}		\|}

	==Description==		== Description ==

	===Sprite-number===		=== Sprite-number ===

	This is just the number you are at.		This is just the number you are at.

	===Length===		=== Length ===

	Count the number of bytes in this action.		Count the number of bytes in this action.

	===num===		=== num ===

	This is the number of sets you want to deactivate.		This is the number of sets you want to deactivate.

	===grfids===		=== grfids ===

	Here you give the list of GRF IDs, in the same format as in [[Action8]], which should be deactivated.		Here you give the list of GRF IDs, in the same format as in [[Action8]], which should be deactivated.

	===Notes===		=== Notes ===

	Note that it is invalid to attempt the deactivation of already active graphics files. You can only prevent files lower down the newgrf(w).cfg from becoming active later. Therefore, you must check that none of the GRF IDs in this list are active already using the appropriate action 7. If the deactivation of an already active set is attempted, the current set is considered invalid and will be disabled.		Note that it is invalid to attempt the deactivation of already active graphics files. You can only prevent files lower down the newgrf(w).cfg from becoming active later. Therefore, you must check that none of the GRF IDs in this list are active already using the appropriate action 7. If the deactivation of an already active set is attempted, the current set is considered invalid and will be disabled.

	If you attempt to deactivate a set that isn't loaded, nothing happens.		If you attempt to deactivate a set that isn't loaded, nothing happens.
Line 61:		Line 60:
	To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.		To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.

	If the given GRFID is identical to the GRFID of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.		If the given GRFID is identical to the GRFID of the file currently being processed, the current file is force-activated. This is most useful for making changes to the title screen menu, which would otherwise not be possible. It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen. Otherwise the GRF Status Windows (de)activation is bypassed entirely.

	It is best to limit this forced activation to as few actions as possible for maximum compatibility.		It is best to limit this forced activation to as few actions as possible for maximum compatibility.
Line 76:		Line 75:
	+ This can happen because it has been processed already (it comes earlier in newgrf(w).cfg) and was deactivated, either by default or manually. Another possibility is that the file is disabled either by default or manually.		+ This can happen because it has been processed already (it comes earlier in newgrf(w).cfg) and was deactivated, either by default or manually. Another possibility is that the file is disabled either by default or manually.

	==Example==		== Example ==

	The following is an example to deactivate GRFID 54570105 if possible, and deactivate the current file instead if not.		The following is an example to deactivate GRFID 54570105 if possible, and deactivate the current file instead if not.
Line 106:		Line 105:
	continue_with_current_file;</pre>		continue_with_current_file;</pre>

	The reason for this particular order of pseudo-sprites is that action 7 will not take a branch if the queried GRFID is not present at all. In that case, both sprites 47 and 48 fall through, which means the jump in 49 is carried out and the file resumes processing. The unconditional gotos in 49 and 51 are actually conditional on the climate not being 7F, which it never can be.		The reason for this particular order of pseudo-sprites is that action 7 will not take a branch if the queried GRFID is not present at all. In that case, both sprites 47 and 48 fall through, which means the jump in 49 is carried out and the file resumes processing. The unconditional gotos in 49 and 51 are actually conditional on the climate not being 7F, which it never can be.

	Conceptually, without goto-logic, the code could be described by		Conceptually, without goto-logic, the code could be described by

Pm-bot: /* Example */ remove stray tiki wiki syntax

2011-06-14T23:21:42Z

Example: remove stray tiki wiki syntax

← Older revision		Revision as of 23:21, 14 June 2011
Line 80:		Line 80:
	The following is an example to deactivate GRFID 54570105 if possible, and deactivate the current file instead if not.		The following is an example to deactivate GRFID 54570105 if possible, and deactivate the current file instead if not.

	47 * 9 07 88 04 06 54 57 01 05 02+-		47 * 9 07 88 04 06 54 57 01 05 02
		⚫	48 * 9 07 88 04 08 54 57 01 05 03

	~~-+ 48~~ * 9 07 88 04 08 54 ~~57 01 05 03+-~~		49 * 6 07 83 01 03 7F 04
		⚫	50 * x 0B 01 1F FF ... (e.g. "This file is deactivated because incompatible graphics are active.")

	~~-+ 49~~ * 6 07 83 01 03 7F ~~04+-~~		51 * 6 07 83 01 03 7F 00
		⚫	52 * x 0B 01 1F FF ... (e.g. "Deactivating GRFID 54570105.")

			53 * 6 0E 01 54 57 01 05
⚫	-+ 50 * x 0B 01 1F FF +-... (e.g. "This file is deactivated because incompatible graphics are active.")

	-+ 51 * 6 07 83 01 03 7F 00+-

⚫	-+ 52 * x 0B 01 1F FF +-... (e.g. "Deactivating GRFID 54570105.")

⚫	~~-+ 53~~ * 6 0E 01 54 57 01 05

	This carries out the following instructions:		This carries out the following instructions:

Pm-bot: Bot: Automated text replacement (--= +==)

2011-06-14T23:20:07Z

Bot: Automated text replacement (--= +==)

Show changes

Orudge: 7 revisions

2011-06-12T19:22:44Z

7 revisions

← Older revision	Revision as of 19:22, 12 June 2011
(No difference)