XmlTools/Full documentation - Revision history

Iritscen: link fix

2021-04-05T12:20:52Z

link fix

← Older revision		Revision as of 12:20, 5 April 2021
Line 619:		Line 619:
	===@CUSTOM_CODE===		===@CUSTOM_CODE===
	====Description====		====Description====
	This operation allows you to use [[wikipedia:JavaScript\|JavaScript]] to edit XML. You can use this for complex logic and mathematical tasks which aren't supported by XmlTools' basic operations. <u>You should only use this option as a '''last resort'''</u> if you are using it for a [[~~Anniversary_Edition/Framework#XML_patching~~\|patch mod]], because it is '''MUCH slower''' than all the other native options. Try to <u>optimize your code as much as possible</u>, as the complexity of the code has a large effect on the overall speed of XmlTools in running JavaScript.		This operation allows you to use [[wikipedia:JavaScript\|JavaScript]] to edit XML. You can use this for complex logic and mathematical tasks which aren't supported by XmlTools' basic operations. <u>You should only use this option as a '''last resort'''</u> if you are using it for a [[Making a patch mod\|patch mod]], because it is '''MUCH slower''' than all the other native options. Try to <u>optimize your code as much as possible</u>, as the complexity of the code has a large effect on the overall speed of XmlTools in running JavaScript.

	Usage:		Usage:

Iritscen: JSXML website is dead

2020-08-20T14:22:27Z

JSXML website is dead

← Older revision		Revision as of 14:22, 20 August 2020
Line 635:		Line 635:
	The <tt>$xmlData</tt> global variable contains the contents of the XML file on disk. After you modify the XML, update this variable again with the new XML in order for XmlTools to update the file on disk, otherwise your changes will not take effect.		The <tt>$xmlData</tt> global variable contains the contents of the XML file on disk. After you modify the XML, update this variable again with the new XML in order for XmlTools to update the file on disk, otherwise your changes will not take effect.

	XmlTools uses the [http://www.petetracey.com/jsxml/index.html ~~JSXML XML Tools]~~ JavaScript libraries to allow you to operate upon the XML. You can read its documentation on its [http://www.petetracey.com/jsxml/documentation.html ~~website]~~ or [http://script10k.oni2.net/documentation/xmltools/jsxml-documentation.htm here].		XmlTools uses the JSXML XML Tools (<nowiki>http://www.petetracey.com/jsxml/index.html</nowiki>, dead link) JavaScript libraries to allow you to operate upon the XML. You can read its documentation on its website (<nowiki>http://www.petetracey.com/jsxml/documentation.html</nowiki>, dead link) or [http://script10k.oni2.net/documentation/xmltools/jsxml-documentation.htm here].

	====Example====		====Example====

Script 10k: typo

2017-12-03T13:03:17Z

typo

← Older revision		Revision as of 13:03, 3 December 2017
Line 555:		Line 555:

	'''XmlTools patch command:'''		'''XmlTools patch command:'''
	@REMOVE_NODES XPathExpression "/Oni/ONCP/Particles/ONCPParticle[Name = 'glass_break']" Files "ONCCgriffin_swat.xml"		@REMOVE_NODES XPathExpression "/Oni/ONCP/Particles/ONCPParticle[@Name = 'glass_break']" Files "ONCCgriffin_swat.xml"

	{\| style="margin: 1em auto 1em auto;" <!-- Centers table -->		{\| style="margin: 1em auto 1em auto;" <!-- Centers table -->

Script 10k: changed javascript example to multiplication of the items instead of sum. Sum was a bad example since it can be achieved easily with a combination of XPath and --update-elements command which is a faster native approach

2016-08-31T15:52:25Z

changed javascript example to multiplication of the items instead of sum. Sum was a bad example since it can be achieved easily with a combination of XPath and --update-elements command which is a faster native approach

← Older revision		Revision as of 15:52, 31 August 2016
Line 638:		Line 638:

	====Example====		====Example====
	Let's say you want to ~~add one additional~~ ammo ~~clip~~ and energy ~~cell~~ to all characters that are on the TCTF team.		Let's say you want to double the ammo clips and energy cells to all characters that are on the TCTF team.

	'''XmlTools patch command:'''		'''XmlTools patch command:'''
Line 664:		Line 664:
	currCellsElement=currChar.childElement("OSD").childElement("Inventory").childElement("EnergyCell").childElement("Use");		currCellsElement=currChar.childElement("OSD").childElement("Inventory").childElement("EnergyCell").childElement("Use");

	<span style="color:green">// ~~Add 1 to~~ the current amount of ammo and cells to use</span>		<span style="color:green">// Double the current amount of ammo and cells that the character can use</span>
	currAmmoElement.text=parseInt(currAmmoElement.text)+1;		currAmmoElement.text=parseInt(currAmmoElement.text)*2;
	currCellsElement.text=parseInt(currCellsElement.text)+1;		currCellsElement.text=parseInt(currCellsElement.text)*2;
	}		}
	}		}
Line 689:		Line 689:
	<Inventory>		<Inventory>
	<Ammo>		<Ammo>
	<Use><span style="color:blue">'''0'''</span></Use>		<Use><span style="color:blue">'''2'''</span></Use>
	...		...
	</Ammo>		</Ammo>
Line 733:		Line 733:
	</Ammo>		</Ammo>
	<EnergyCell>		<EnergyCell>
	<Use>'''0'''</Use>		<Use>'''2'''</Use>
	...		...
	</EnergyCell>		</EnergyCell>
Line 757:		Line 757:
	<Inventory>		<Inventory>
	<Ammo>		<Ammo>
	<Use><span style="color:red">'''1'''</span></Use>		<Use><span style="color:red">'''4'''</span></Use>
	...		...
	</Ammo>		</Ammo>
	<EnergyCell>		<EnergyCell>
	<Use><span style="color:red">'''1'''</span></Use>		<Use><span style="color:red">'''0'''</span></Use>
	...		...
	</EnergyCell>		</EnergyCell>
Line 777:		Line 777:
	<Inventory>		<Inventory>
	<Ammo>		<Ammo>
	<Use><span style="color:red">'''4'''</span></Use>		<Use><span style="color:red">'''6'''</span></Use>
	...		...
	</Ammo>		</Ammo>
Line 801:		Line 801:
	</Ammo>		</Ammo>
	<EnergyCell>		<EnergyCell>
	<Use>'''0'''</Use>		<Use>'''2'''</Use>
	...		...
	</EnergyCell>		</EnergyCell>

Iritscen: /* Description */ forgot bold tags

2016-03-16T02:15:48Z

Description: forgot bold tags

← Older revision		Revision as of 02:15, 16 March 2016
Line 72:		Line 72:
	This operation allows you to remove XML values from an existing XML element that contains a list of values. The values should be space-separated and contained within quotes.		This operation allows you to remove XML values from an existing XML element that contains a list of values. The values should be space-separated and contained within quotes.

	Oni's game data contains various bitsets that are used to indicate the on/off status of attributes that can pertain to that object. For instance, characters in the game can have various flags such as Unkillable turned on for them. In OniSplit's XML output of this data, the flags are given names and listed within quotes as a single string. --add-values and --remove-values were designed to edit these XML representations of bitsets.		Oni's game data contains various bitsets that are used to indicate the on/off status of attributes that can pertain to that object. For instance, characters in the game can have various flags such as Unkillable turned on for them. In OniSplit's XML output of this data, the flags are given names and listed within quotes as a single string. '''--add-values''' and '''--remove-values''' were designed to edit these XML representations of bitsets.

	<tt>Usage: XmlTools --remove-values --current-val "current values to remove"</tt>		<tt>Usage: XmlTools --remove-values --current-val "current values to remove"</tt>

Iritscen: grammar edit to rest of article

2016-03-15T04:34:35Z

grammar edit to rest of article

Show changes

Iritscen: overall copy-edit; lowered all headers one level so that level 1 isn't being used (that is reserved for the article title); grammar edit to first half of article

2016-03-14T16:41:29Z

overall copy-edit; lowered all headers one level so that level 1 isn't being used (that is reserved for the article title); grammar edit to first half of article

Show changes

Iritscen: Iritscen moved page XmlTools/Full Documentation to XmlTools/Full documentation without leaving a redirect: Unneeded capitalization.

2014-03-20T20:33:43Z

Iritscen moved page XmlTools/Full Documentation to XmlTools/Full documentation without leaving a redirect: Unneeded capitalization.

← Older revision	Revision as of 20:33, 20 March 2014
(No difference)

Iritscen: +cats; link fixes

2014-03-20T20:33:23Z

+cats; link fixes

← Older revision		Revision as of 20:33, 20 March 2014
Line 634:		Line 634:
	===Example===		===Example===

	Let's say your want to perform the same operation in [[~~XmlTools/Full_Documentation~~#Example\|--add-values example]]. This operation adds the Unkillable and the NonCombatant flag to A_L18 character.		Let's say your want to perform the same operation in [[#Example\|--add-values example]]. This operation adds the Unkillable and the NonCombatant flag to A_L18 character.

	'''XmlTools patch command:'''		'''XmlTools patch command:'''
Line 641:		Line 641:
	Note that in the XPath expression we replace each single quote by two single quotes (allows XmlTools differentiate from the other single quotes around command line options).		Note that in the XPath expression we replace each single quote by two single quotes (allows XmlTools differentiate from the other single quotes around command line options).

	The resulting XML file is exactly the same of [[~~XmlTools/Full_Documentation~~#Example\|--add-values example]].		The resulting XML file is exactly the same of [[#Example\|--add-values example]].

	==@CUSTOM_CODE==		==@CUSTOM_CODE==
Line 847:		Line 847:
	</Oni>		</Oni>
	\|}		\|}

			[[Category:Bi-platform modding tools]][[Category:Completed modding tools]][[Category:Modding tutorials]]

Script 10k: /* @CUSTOM_CODE */

2014-02-23T22:48:29Z

@CUSTOM_CODE

← Older revision		Revision as of 22:48, 23 February 2014
Line 647:		Line 647:
	===Description===		===Description===

	This operation allows you to use [[wikipedia:JavaScript\|JavaScript]] to edit XML~~. <u>You should use this option only as '''last resort'''</u>, because it is '''MUCH slower''' than all the other native options~~.		This operation allows you to use [[wikipedia:JavaScript\|JavaScript]] to edit XML.

	You can use this for complex logics and mathematical operations which aren't supported in other native operations.		You can use this for complex logics and mathematical operations which aren't supported in other native operations.

			<u>You should only use this option as '''last resort'''</u> if you are using it for [[Anniversary_Edition/Framework#XML_patching\|AE Patches]], because it is '''MUCH slower''' than all the other native options. Try <u>maintain your code as optimized as possible</u>, as the user code also highly affects the XmlTools performance while applying the patch.

	Usage:		Usage:
Line 665:		Line 667:
	The <tt>$xmlData</tt> global variable contains the XML of the current file. After you modify the XML, update this variable again with the new XML in order to XmlTools update correctly the file.		The <tt>$xmlData</tt> global variable contains the XML of the current file. After you modify the XML, update this variable again with the new XML in order to XmlTools update correctly the file.

	XmlTools uses the [http://www.petetracey.com/jsxml/index.html JSXML XML Tools] JavaScript libraries~~, specifically~~ you ~~will use the JSXMLBuilder class~~ to edit the XML. You can read it documentation in its [http://www.petetracey.com/jsxml/documentation.html website] or [http://script10k.oni2.net/documentation/xmltools/jsxml-documentation.htm here].		XmlTools uses the [http://www.petetracey.com/jsxml/index.html JSXML XML Tools] JavaScript libraries to allow you to edit the XML. You can read it documentation in its [http://www.petetracey.com/jsxml/documentation.html website] or [http://script10k.oni2.net/documentation/xmltools/jsxml-documentation.htm here].

	===Example===		===Example===
Line 684:		Line 686:

	<span style="color:green">// Loop over all characters</span>		<span style="color:green">// Loop over all characters</span>
	for (var i=0; i<(charactersNode.childElement(i)); i++){ <span style="color:green">// the condition checks if the ith element exists (!= undefined)</span>		for (var i=0; (charactersNode.childElement(i)); i++){ <span style="color:green">// the condition checks if the ith element exists (!= undefined)</span>

	var currChar=charactersNode.childElement(i);		var currChar=charactersNode.childElement(i);