Functions - Revision history

Jeremy: /* Examples */

2023-06-21T02:14:34Z

Examples

← Older revision		Revision as of 02:14, 21 June 2023
Line 76:		Line 76:

	==== Examples ====		==== Examples ====
	For some examples of functions, read the [[examples]] page.		For some examples of functions, read the [[3.0_Examples\|examples]] page.
	</div>		</div>
	<div class="large-4 columns">		<div class="large-4 columns">

Jeremy: /* Variables */

2023-06-20T02:25:36Z

Variables

← Older revision		Revision as of 02:25, 20 June 2023
Line 14:		Line 14:

	==== Variables ====		==== Variables ====
	Scripts and functions are generally self-contained, variables are local to the code block and are cleared when the script or function finishes. To interact with variables used in the [~~SimplifiedScripting~~] system, you'll want to use the built-in modules: get_variable, set_variable etc.		Scripts and functions are generally self-contained, variables are local to the code block and are cleared when the script or function finishes. To interact with variables used in the [[3.0_Simplified_Scripting\|Simplified Scripting]] system, you'll want to use the built-in modules: get_variable, set_variable etc.
	* Functions called in a trigger receive information about the match: '''args.text, args.match, args.prefix, args.suffix, args.backrefs[1] ...'''		* Functions called in a trigger receive information about the match: '''args.text, args.match, args.prefix, args.suffix, args.backrefs[1] ...'''
	* Scripts receive the backrefs ('''args[0]., args[1],. args[2], ...''') and the current_package variable indicating the active package.		* Scripts receive the backrefs ('''args[0]., args[1],. args[2], ...''') and the current_package variable indicating the active package.

Jeremy at 02:24, 20 June 2023

2023-06-20T02:24:09Z

← Older revision		Revision as of 02:24, 20 June 2023
Line 2:		Line 2:
	<div class="row">		<div class="row">
	<div class="large-8 columns">		<div class="large-8 columns">
	Functions and scripts represent the pinnacle of what the Nexus client can provide in terms of power and customization, albeit with higher complexity. These functionalities are programmed using [[~~JavaScript~~]], a versatile and widely-used language.		Functions and scripts represent the pinnacle of what the Nexus client can provide in terms of power and customization, albeit with higher complexity. These functionalities are programmed using [[Javascript]], a versatile and widely-used language.

	In this section, we will not delve into the details of coding in [[~~JavaScript~~]]. However, we will introduce you to some of the built-in functions and guide you through creating your own custom code. This will empower you to enhance and refine your skill set for more intricate and responsive interactions.		In this section, we will not delve into the details of coding in [[Javascript]]. However, we will introduce you to some of the built-in functions and guide you through creating your own custom code. This will empower you to enhance and refine your skill set for more intricate and responsive interactions.

	==== Scripts vs. Functions ====		==== Scripts vs. Functions ====
	* Scripts are specific code blocks that are fired as a result of a reflex being fired. This can be a trigger, alias, or keybind.		* Scripts are specific code blocks that are fired as a result of a reflex being fired. This can be a trigger, alias, or keybind.
	* Functions are ~~re-usable~~ code blocks that can be called from scripts or directly from the client's input.		* Functions are reusable code blocks that can be called from scripts or directly from the client's input.

	==== Calling functions ====		==== Calling functions ====

Jeremy at 02:23, 20 June 2023

2023-06-20T02:23:48Z

← Older revision		Revision as of 02:23, 20 June 2023
Line 2:		Line 2:
	<div class="row">		<div class="row">
	<div class="large-8 columns">		<div class="large-8 columns">
	Functions and scripts ~~are~~ the ~~most powerful option that~~ the client ~~has to offer~~, ~~but also one that is most difficult to use~~. ~~Functions and scripts~~ are programmed ~~in the~~ [[~~Javascript~~]] language.		Functions and scripts represent the pinnacle of what the Nexus client can provide in terms of power and customization, albeit with higher complexity. These functionalities are programmed using [[JavaScript]], a versatile and widely-used language.

	~~While~~ we ~~won't be covering how to code~~ in JavaScript ~~in this section~~, we~~'ll cover~~ some of the built-in functions and ~~how to build~~ your own custom code to ~~further expand~~ your ~~reflexes~~.		In this section, we will not delve into the details of coding in [[JavaScript]]. However, we will introduce you to some of the built-in functions and guide you through creating your own custom code. This will empower you to enhance and refine your skill set for more intricate and responsive interactions.

	==== Scripts vs. Functions ====		==== Scripts vs. Functions ====

Jeremy: /* Built-in modules */

2023-06-20T02:21:24Z

Built-in modules

← Older revision		Revision as of 02:21, 20 June 2023
Line 51:		Line 51:
	===== UI Manipulation =====		===== UI Manipulation =====
	* '''client.register_custom_tab(tab,container_id)''' - Make a custom UI tab. ''Please note, this is unsupported.''		* '''client.register_custom_tab(tab,container_id)''' - Make a custom UI tab. ''Please note, this is unsupported.''

			===== Tab Display =====
			* '''set_custom_tab_html("tab_name", "html")''' - Display output in a tab.
			* '''append_custom_tab_html("tab_name", "html")''' - Display output in a tab.

	===== Buttons =====		===== Buttons =====
Line 60:		Line 64:
	===== Misc. =====		===== Misc. =====
	* '''to_number(val)''' - Convert a string number to a value.		* '''to_number(val)''' - Convert a string number to a value.
	* '''send_GMCP(message, arguments)''' - Sends a GMCP message to the game. Arguments are an object or string, depending on the GMCP call used - see the GMCP documentation for more information.		* '''send_GMCP(message, arguments)''' - Sends a GMCP message to the game. Arguments are an object or string, depending on the GMCP call used - see the GMCP documentation for more information.

	==== Default functions ====		==== Default functions ====

Jeremy at 02:12, 20 June 2023

2023-06-20T02:12:19Z

@@ Line 1: / Line 1: @@
 Functions and scripts are the most powerful option that the client has to offer, but also one that is most difficult to use. Functions and scripts are programmed in the [[Javascript]] language.
@@ Line 70: / Line 73: @@
 ==== Examples ====
 For some examples of functions, read the [[examples]] page.

Argwin at 02:00, 29 March 2023

2023-03-29T02:00:34Z

← Older revision		Revision as of 02:00, 29 March 2023
Line 66:		Line 66:

	The onBlock function can make use of the current_block variable, which holds the individual lines (current_block[0] is the first one, current_block[1] is the second one, and so on). The manipulation methods described with triggers are all applicable on these as well.		The onBlock function can make use of the current_block variable, which holds the individual lines (current_block[0] is the first one, current_block[1] is the second one, and so on). The manipulation methods described with triggers are all applicable on these as well.
			*Nexus 3 uses nexusclient.current_block instead of current_block

	==== Examples ====		==== Examples ====
	For some examples of functions, read the [[examples]] page.		For some examples of functions, read the [[examples]] page.

Justin at 16:45, 18 March 2018

2018-03-18T16:45:02Z

← Older revision		Revision as of 16:45, 18 March 2018
Line 48:		Line 48:
	===== UI Manipulation =====		===== UI Manipulation =====
	* '''client.register_custom_tab(tab,container_id)''' - Make a custom UI tab. ''Please note, this is unsupported.''		* '''client.register_custom_tab(tab,container_id)''' - Make a custom UI tab. ''Please note, this is unsupported.''
	===== Buttons. =====
			===== Buttons =====
	* '''buttons_set_label(id, text)''' - Set the text label on a button.		* '''buttons_set_label(id, text)''' - Set the text label on a button.
	* '''buttons_set_commands(id, cmds)''' - Sets the command sent to the game when the button is pressed.		* '''buttons_set_commands(id, cmds)''' - Sets the command sent to the game when the button is pressed.

Justin at 16:44, 18 March 2018

2018-03-18T16:44:39Z

← Older revision		Revision as of 16:44, 18 March 2018
Line 48:		Line 48:
	===== UI Manipulation =====		===== UI Manipulation =====
	* '''client.register_custom_tab(tab,container_id)''' - Make a custom UI tab. ''Please note, this is unsupported.''		* '''client.register_custom_tab(tab,container_id)''' - Make a custom UI tab. ''Please note, this is unsupported.''
			===== Buttons. =====
			* '''buttons_set_label(id, text)''' - Set the text label on a button.
			* '''buttons_set_commands(id, cmds)''' - Sets the command sent to the game when the button is pressed.
			* '''buttons_set_highlight(id, on_off)''' - Set whether the button is highlighted or not.
			* '''buttons_set_default(id)''' - Reset a button to the default value.

	===== Misc. =====		===== Misc. =====
	* '''to_number(val)''' - Convert a string number to a value.		* '''to_number(val)''' - Convert a string number to a value.

Tomas at 15:15, 19 August 2016

2016-08-19T15:15:41Z

← Older revision		Revision as of 15:15, 19 August 2016
Line 50:		Line 50:
	===== Misc. =====		===== Misc. =====
	* '''to_number(val)''' - Convert a string number to a value.		* '''to_number(val)''' - Convert a string number to a value.
			* '''send_GMCP(message, arguments)''' - Sends a GMCP message to the game. Arguments are an object or string, depending on the GMCP call used - see the GMCP documentation for more information.

	==== Default functions ====		==== Default functions ====