Setudef - Revision history

Geo: /* Bind Mask (less preferred) */

2022-08-29T23:20:26Z

Bind Mask (less preferred)

← Older revision		Revision as of 23:20, 29 August 2022
Line 78:		Line 78:

	From that, we can see here that a mask that would trigger on only one channel would take the form of		From that, we can see here that a mask that would trigger on only one channel would take the form of
	<~~pre~~>"channel nick!user@host"</~~pre~~>, or specifically for this case, <~~pre~~>"#test *"</~~pre~~>. This creates a bind that is triggered by any user on #test.		<code>"channel nick!user@host"</code>, or specifically for this case, <code>"test *"</code>. This creates a bind that can be triggered by any user on #test.

	=== Example Tcl Script ===		=== Example Tcl Script ===

Geo: /* Bind Mask (less preferred) */

2022-08-29T23:19:11Z

Bind Mask (less preferred)

← Older revision		Revision as of 23:19, 29 August 2022
Line 64:		Line 64:

	== Bind Mask (less preferred) ==		== Bind Mask (less preferred) ==
			Using a bind mask is generally considered less friendly to the user, as the user must edit the Tcl file and then restart the Eggdrop in order to enable or disable the script on a channel.

	If your script uses a bind to trigger an action, it probably incorporates a mask that specifies which users or conditions are allowed to trigger the bind. For example, the documentation for a JOIN bind states:		If your script uses a bind to trigger an action, it probably incorporates a mask that specifies which users or conditions are allowed to trigger the bind. For example, the documentation for a JOIN bind states:
	<pre>		<pre>
Line 75:		Line 77:
	</pre>		</pre>

	From that, we can see here that a mask that would trigger only on channel ~~#test~~ would take the form of		From that, we can see here that a mask that would trigger on only one channel would take the form of
	<pre>		<pre>"channel nick!user@host"</pre>, or specifically for this case, <pre>"#test *"</pre>. This creates a bind that is triggered by any user on #test.
	"channel nick!user@host"
	</pre>
	~~You can choose a mask such as~~ <pre>"#test *"</pre> that ~~could be~~ triggered by any user on #test~~, but this is considered less user-friendly to maintain, as the user would have to edit the Tcl file and then restart the Eggdrop in order to enable or disable the script on a channel~~.

	=== Example Tcl Script ===		=== Example Tcl Script ===

Geo at 23:15, 29 August 2022

2022-08-29T23:15:49Z

@@ Line 60: / Line 60: @@
      putserv "PRIVMSG $chan :Hello $nick, welcome to $chan!"
+   }
+}
 </pre>

Geo: /* Example Tcl script */

2022-08-29T22:58:13Z

Example Tcl script

← Older revision		Revision as of 22:58, 29 August 2022
Line 56:		Line 56:

	setudef flag greetScript		setudef flag greetScript
	proc greetNewUser{nick user hand chan} {		proc greetNewUser {nick user hand chan} {
	if {[channel get $chan greetScript]} {		if {[channel get $chan greetScript]} {
	putserv "PRIVMSG $chan :Hello $nick, welcome to $chan!"		putserv "PRIVMSG $chan :Hello $nick, welcome to $chan!"

Geo: /* Checking a channel flag */

2022-08-29T22:56:17Z

Checking a channel flag

← Older revision		Revision as of 22:56, 29 August 2022
Line 48:		Line 48:
	putserv "PRIVMSG #test :This is a message that is only sent if the myscript flag is enabled"		putserv "PRIVMSG #test :This is a message that is only sent if the myscript flag is enabled"
	}		}
			</pre>

	=== Example Tcl script ===		=== Example Tcl script ===

Geo: Finish setudef

2022-08-29T22:55:53Z

Finish setudef

@@ Line 2: / Line 2: @@
 == User-defined Channel Flags (Preferred) ==
 From [https://docs.eggheads.org/using/tcl-commands.html doc/tcl-commands.doc], you can use the [https://docs.eggheads.org/using/tcl-commands.html#setudef-flag-int-str-name setudef command]:
 <pre>
@@ Line 29: / Line 30: @@
 User defined channel flags:
       +myscript
 </pre>

Geo: Initial commit

2022-08-29T22:44:02Z

Initial commit

New page

Eggdrop users often like a script's functionality to work on only some of the channels the Eggdrop resides on. For example, an Eggdrop running a Tcl script that greets every user is nice on a small channel, but would quickly become annoying on a busy channel where users are joining every 30 seconds. There are two ways you can enable a script to work on only some channels the Eggdrop resides on.

== User-defined Channel Flags (Preferred) ==
From [https://docs.eggheads.org/using/tcl-commands.html doc/tcl-commands.doc], you can use the [https://docs.eggheads.org/using/tcl-commands.html#setudef-flag-int-str-name setudef command]:
<pre>
setudef <flag/int/str> <name>

Description: initializes a user defined channel flag, string or integer setting. You can use it like any other flag/setting. IMPORTANT: Don’t forget to reinitialize your flags/settings after a restart, or it’ll be lost.
</pre>

This command creates a new flag setting that can be used via the <pre>.chanset</pre> command, and viewed via the <pre>.chaninfo</pre> command. To create a custom flag that a script can check, create it by adding the setudef command:
<pre>
setudef flag myscript
</pre>

This will add a flag that can be viewed, enabled or disabled via the partyline:
<pre>
User defined channel flags:
-myscript
</pre>

As with any other Eggdrop channel flag, it can be enabled or disabled with the .chanset command:
<pre>
.chanset #test +myscript
Successfully set modes { +myscript } on #test.
[22:42:18] #-HQ# chanset #test +myscript

.chaninfo #test
User defined channel flags:
+myscript
</pre>