Denizen/Commands/Flag - Revision history

Mcmonkey at 19:03, 3 September 2021

2021-09-03T19:03:03Z

← Older revision		Revision as of 19:03, 3 September 2021
Line 1:		Line 1:

			For more up-to-date information and full details on specific features (individual commands or tags, for example), check the [https://meta.denizenscript.com/ Meta Documentation].

			If you want a full tutorial to help get you set up, check out the [https://guide.denizenscript.com/ Beginner's Guide] text website.

			If you need quick help, visit our [https://discord.gg/Q6pZGSR Discord group].

			<br><br><br>

			<span style="font-family:natalya-alternate-one; font-size:300%; margin-right:-7px; margin-left:-10px;">This wiki is outdated, please view the tutorial videos/guide, meta documentation, or Discord group (all linked above) for up-to-date information!</span>

			<br><br><br>









	== Introduction ==		== Introduction ==
	Flags are variables that can be checked anywhere in a script and in other scripts by using flag replaceable tags or the flagged requirement.		Flags are variables that can be checked anywhere in a script and in other scripts by using flag replaceable tags or the flagged requirement.

Morphan1 at 05:33, 25 October 2013

2013-10-25T05:33:52Z

← Older revision		Revision as of 05:33, 25 October 2013
Line 61:		Line 61:

	=== With Requirements ===		=== With Requirements ===
			'''Note: Requirements have been deprecated in favor of the If command.'''

	To do this with Requirements, you can use any of the following:		To do this with Requirements, you can use any of the following:
	<pre>### To check if the flag EXISTS (Whether or not it has no value doesn't matter.)		<pre>### To check if the flag EXISTS (Whether or not it has no value doesn't matter.)

Morphan1 at 05:32, 25 October 2013

2013-10-25T05:32:26Z

@@ Line 6: / Line 6: @@
 = The flag command =
 To begin, you need to actually set a flag. You can do this by using
 {| class="wikitable" border="1"
@@ Line 39: / Line 38: @@
 <pre>- flag "IntegerFlag:3"
 - flag "DoubleFlag:5.2"</pre>
 = Usage inside scripts =
 == Mathematical calculations ==
@@ Line 69: / Line 96: @@
 Example:
 <pre><player.flag[money].mod[3]></pre>

Morphan1: /* Integer/Doubles */

2013-10-25T05:07:14Z

Integer/Doubles

← Older revision		Revision as of 05:07, 25 October 2013
Line 34:		Line 34:
	==== Integer/Doubles ====		==== Integer/Doubles ====

	Onto the next step... Integers and doubles! If you know a little about math, you probably already know that integers are just a fancy way of saying 'whole numbers'. In that sense, ~~all~~ doubles are ~~are~~ numbers with decimals. (Non-whole numbers.)		Onto the next step... Integers and doubles! If you know a little about math, you probably already know that integers are just a fancy way of saying 'whole numbers'. In that sense, doubles are simply just numbers with decimals. (Non-whole numbers.)

			Flags can hold numbers such as these by using something along the lines of...
			<pre>- flag "IntegerFlag:3"
			- flag "DoubleFlag:5.2"</pre>

	= Usage inside scripts =		= Usage inside scripts =

Morphan1: /* Usage */

2013-07-08T01:34:56Z

Usage

← Older revision		Revision as of 01:34, 8 July 2013
Line 16:		Line 16:
	=== The Basics ===		=== The Basics ===

	To start using flags, you must first understand the basics. This means learning the 4 types of flags you can use: booleans, strings, integers, and lists.		To start using flags, you must first understand the basics. This means learning the 4 types of flags you can use: booleans, strings, integers/doubles, and lists.

	==== Boolean ====		==== Boolean ====
Line 32:		Line 32:
	Remember, you can also attach the flag to the NPC that the script is being run by, or the server itself by specifying 'npc' or 'global'. That will be covered in the advanced section.		Remember, you can also attach the flag to the NPC that the script is being run by, or the server itself by specifying 'npc' or 'global'. That will be covered in the advanced section.

	==== Integer ====		==== Integer/Doubles ====

			Onto the next step... Integers and doubles! If you know a little about math, you probably already know that integers are just a fancy way of saying 'whole numbers'. In that sense, all doubles are are numbers with decimals. (Non-whole numbers.)

	= Usage inside scripts =		= Usage inside scripts =

Morphan1: /* Checking if a flag exists */

2013-07-07T22:37:51Z

Checking if a flag exists

← Older revision		Revision as of 22:37, 7 July 2013
Line 69:		Line 69:
	With the new 0.9 Development release you can now check if a flag exists. Just check a flag against null like in the following example:		With the new 0.9 Development release you can now check if a flag exists. Just check a flag against null like in the following example:

	<pre>- if <player.flag[flag_to_check]> == null		<pre>- if <player.flag[flag_to_check]> == null narrate 'flag is null!'
	narrate 'flag is null!'
	else narrate "<player.flag[flag_to_check]>"</pre>		else narrate "<player.flag[flag_to_check]>"</pre>

SpaceEmotion: Added mathematical operations and advanced usage

2013-07-07T17:28:09Z

Added mathematical operations and advanced usage

@@ Line 5: / Line 5: @@
 Once you set a flag, you can call it back at any time with one of the [[Denizen/Replaceable_Tags#Flags|replaceable tags]].
 == Usage ==
 To begin, you need to actually set a flag. You can do this by using
@@ Line 32: / Line 33: @@
 ==== Integer ====

Morphan1 at 16:57, 7 July 2013

2013-07-07T16:57:40Z

← Older revision		Revision as of 16:57, 7 July 2013
Line 3:		Line 3:
	A flag can be placed on the player, the NPC or globally. Flags placed on a player only apply to that player, and flags placed on an NPC only apply to that individual NPC based on its ID, so NPCs with the same name have different flags because they have different IDs. However, a global flag applies to the entire server and can easily be read from any script.		A flag can be placed on the player, the NPC or globally. Flags placed on a player only apply to that player, and flags placed on an NPC only apply to that individual NPC based on its ID, so NPCs with the same name have different flags because they have different IDs. However, a global flag applies to the entire server and can easily be read from any script.

	If a flag~~'s type (player, npc or global) is not specified, the flag is placed on the player by default, and if a value for the flag is not specified~~, the ~~value is "true" by default~~.		Once you set a flag, you can call it back at any time with one of the [[Denizen/Replaceable_Tags#Flags\|replaceable tags]].

	== Usage ==		== Usage ==
	To ~~start off~~, you ~~should~~ set a flag. You can do this by using		To begin, you need to actually set a flag. You can do this by using
	{\| class="wikitable" border="1"		{\| class="wikitable" border="1"
	\|\|- flag ({player}\|npc\|global) [name([#])](:action)[:value] (duration:#)		\|\|- flag ({player}\|npc\|global) [name([#])](:action)[:value] (duration:#)
	\|}		\|}
	~~You can then use~~ the ~~[[Denizen/Replaceable_Tags#Flags\|replaceable tags]] to call back~~ the flag ~~in any script~~.		If a flag's type (player, npc or global) is not specified, the flag is placed on the player by default, and if a value for the flag is not specified, the value is "true" by default.

	...Too much for you? Let's slow it down.		...Too much for you? Let's slow it down.
	=== ~~Strings~~ ===		=== The Basics ===
	The first, most used, most basic flag you need is a string flag. Strings are ~~basically just~~ variables that represent words or phrases that you can change at any time.
			To start using flags, you must first understand the basics. This means learning the 4 types of flags you can use: booleans, strings, integers, and lists.

			==== Boolean ====

			The first, most used, most basic flag you need (besides a default flag) is a boolean flag. A boolean is a variable that represents either true or false.
			You can set a boolean flag to true by using <pre>- flag "RandomFlag"</pre> ...That's it. That automatically sets the flag named RandomFlag attached to the player interacting with the script as 'true'.
			You can set it to false by simply doing <pre>- flag "RandomFlag:false"</pre>
			This type of flag is helpful for 'if' statements. More information on that can be found [[Denizen/Commands/If#Flags\|here]].

			==== String ====

			Let's move forward. Probably the second most important flag you'll need on your journey is the string flag. Strings are variables that represent words or phrases that you can change at any time.

	For example, <pre>- flag "RandomFlag:Blah something whatever"</pre> would set the flag 'RandomFlag' on the player who's interacting with the script as 'Blah something whatever'.		For example, <pre>- flag "RandomFlag:Blah something whatever"</pre> would set the flag 'RandomFlag' on the player who's interacting with the script as 'Blah something whatever'.
			Remember, you can also attach the flag to the NPC that the script is being run by, or the server itself by specifying 'npc' or 'global'. That will be covered in the advanced section.

			==== Integer ====

Morphan1: /* Strings */

2013-06-19T07:25:53Z

Strings

← Older revision		Revision as of 07:25, 19 June 2013
Line 13:		Line 13:

	...Too much for you? Let's slow it down.		...Too much for you? Let's slow it down.
	=== ~~Examples~~ ===		=== Strings ===
			The first, most used, most basic flag you need is a string flag. Strings are basically just variables that represent words or phrases that you can change at any time.

			For example, <pre>- flag "RandomFlag:Blah something whatever"</pre> would set the flag 'RandomFlag' on the player who's interacting with the script as 'Blah something whatever'.

Morphan1 at 18:31, 18 June 2013

2013-06-18T18:31:25Z

← Older revision		Revision as of 18:31, 18 June 2013
Line 14:		Line 14:
	...Too much for you? Let's slow it down.		...Too much for you? Let's slow it down.
	=== Examples ===		=== Examples ===

	~~== Examples ==~~