Readables - Revision history

Geep: Change category tag to {{GUI}}, that includes Editing

2022-11-04T18:11:14Z

Change category tag to {{GUI}}, that includes Editing

2021-12-27T21:05:16Z

Add new intro, revise headings

2021-12-22T22:58:21Z

Create your custom text: Add mention of Readable Editor

← Older revision		Revision as of 22:58, 22 December 2021
Line 52:		Line 52:

	== Create your custom text ==		== Create your custom text ==
	Create your xdata file containing your readable text. ~~This is explained here~~: [[XData File Creation]]. You can of course skip that step and use the '''readables_test.xd''' file, which is already prefabricated in the darkmod repository. Alternatively, you can also define the text data on the entity itself (see below).		Create your xdata file containing your readable text. Ways to do this are discussed in:
			* [[XData File Creation]]
			* Method 2 of [[Readables Prefabs]]
			* [[Readable Editor]]

			You can of course skip that step and use the '''readables_test.xd''' file, which is already prefabricated in the darkmod repository. Alternatively, you can also define the text data on the entity itself (see below).

	== Entity Keys/Values ==		== Entity Keys/Values ==

2021-06-27T21:31:58Z

Triggering Something After Being Read

← Older revision		Revision as of 21:31, 27 June 2021
Line 158:		Line 158:

	== Triggering Something After Being Read ==		== Triggering Something After Being Read ==
	''From forum discussion [https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=462151 here]''		''From 2021 forum discussion [https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=462151 here]''
	There are two methods.		There are two methods.

2021-06-27T21:31:17Z

Add Triggering Something After Being Read

@@ Line 157: / Line 157: @@
 It is likely all the variables you see in an xd file could be used this way so eg, num_pages etc.
 [[Category:Tutorial]]
 [[Category:Editing]]

2010-08-12T06:00:06Z

Non_existant xdata declaration

← Older revision		Revision as of 06:00, 12 August 2010
Line 103:		Line 103:
	* The xd file isn't loaded (reload Doom/TDM - see previous section.)		* The xd file isn't loaded (reload Doom/TDM - see previous section.)
	* The xd file is wrongly named or in the wrong path. The file can be any legal prefix but must be suffixed .xd and it must be in either darkmod/xdata folder or mymap/xdata folder (if you have a current game folder.)		* The xd file is wrongly named or in the wrong path. The file can be any legal prefix but must be suffixed .xd and it must be in either darkmod/xdata folder or mymap/xdata folder (if you have a current game folder.)
			* There may be an error in another xdata declaration earlier in the same file which prevents the code reading this one.

	===num_pages not defined===		===num_pages not defined===

2010-08-12T05:57:36Z

Non_existant xdata declaration

← Older revision		Revision as of 05:57, 12 August 2010
Line 102:		Line 102:
	* The xdata name was put in the wrong place eg, below the first curly bracket.		* The xdata name was put in the wrong place eg, below the first curly bracket.
	* The xd file isn't loaded (reload Doom/TDM - see previous section.)		* The xd file isn't loaded (reload Doom/TDM - see previous section.)
			* The xd file is wrongly named or in the wrong path. The file can be any legal prefix but must be suffixed .xd and it must be in either darkmod/xdata folder or mymap/xdata folder (if you have a current game folder.)

	===num_pages not defined===		===num_pages not defined===

2010-03-10T16:45:02Z

Link to Readable Editor added

← Older revision		Revision as of 16:45, 10 March 2010
Line 15:		Line 15:
	"xdata_contents" "[readable text shader name]"		"xdata_contents" "[readable text shader name]"

	This key holds the name of the readable text as defined in your .xd File. See [[XData File Creation]].		This key holds the name of the readable text as defined in your .xd File. See [[XData File Creation]]. This last step is not necessary if you use the [[Readable Editor]] for creating your texts.

	That's it. Later you will be able to select skins to match the parchment of your model to your gui, but that's another day.		That's it. Later you will be able to select skins to match the parchment of your model to your gui, but that's another day.

2010-02-06T21:25:16Z

Reloading xdata

← Older revision		Revision as of 21:25, 6 February 2010
Line 87:		Line 87:
	===Reloading xdata===		===Reloading xdata===

	When testing readable text you ~~may not have found a way~~ to reload a changed xdata ~~file without exiting TDM completely. Just using gameError or reloadDecls on their own does not reload the xdata~~ - ~~but together they work. In the console enter one after the other...~~		When testing readable text you can use reloadXData in the console to reload changed xdata definitions in-game. A small test map with the player start right in front of the readable and you can review changes in seconds just by pressing the up key and Enter in the console to repeat the command or even faster, bind reloadXData to a key so you just hit a key to refresh the readable.

	~~gameError~~

	~~reloadDecls~~

	~~map <name>~~

	~~A bit tedious but faster than exiting TDM and reloading everything. And you can use [[Console batch macro commands\|batch commands]] to make it even easier~~. A small test map with the player start right in front of the readable and you can review changes in seconds just by pressing the up key and Enter in the console to repeat the ~~exec~~ command.

	~~'''NOTE:''' the above does not seem~~ to ~~load~~ a ~~new xd file created while Doom/TDM is still running - it only reloads~~ a ~~changed file that already existed when it was launched!~~

	==Troubleshooting==		==Troubleshooting==

2010-01-22T10:41:02Z

Readables values in entity without xdata file

← Older revision		Revision as of 10:41, 22 January 2010
Line 155:		Line 155:


	This is just to emphasise this possibility and make this easier to find [[page1_title & page1_body\|see above]]		This is just to emphasise this possibility and make this easier to find [[#page1_title & page1_body\|see above]]

	It is possible to directly include text in the readable entity but this is rarely used and I include it here for reference:		It is possible to directly include text in the readable entity but this is rarely used and I include it here for reference: