Nanobot code help - Revision history

imported>Wikiadmin at 17:54, 31 August 2014

2014-08-31T17:54:31Z

← Older revision		Revision as of 17:54, 31 August 2014
Line 112:		Line 112:
	Object that can be used to schedule code to be executed at a later time.		Object that can be used to schedule code to be executed at a later time.
	:'''action(''' ''wait_time, command'' ''')''': Wait for ''wait_time'' seconds and then try to execute 'command'.		:'''action(''' ''wait_time, command'' ''')''': Wait for ''wait_time'' seconds and then try to execute 'command'.
	'''An eval() is performed on 'command' so use with caution!'''		'''<span style="color:#FF0000">An eval() is performed on 'command' so use with caution!</span>'''

imported>Wikiadmin at 17:52, 31 August 2014

2014-08-31T17:52:39Z

← Older revision		Revision as of 17:52, 31 August 2014
Line 13:		Line 13:
	:''<argument>'': optional argument to a function.		:''<argument>'': optional argument to a function.
	:''arg1\|arg2'': A specific set of options that are accepted. The function expects either 'arg1' or 'arg2' but not both or neither.		:''arg1\|arg2'': A specific set of options that are accepted. The function expects either 'arg1' or 'arg2' but not both or neither.
	:''<arg1\|arg2>'': A specific set of options that are accepted. Unlike the previous, the function may also be called without any arguments. When called without ~~argument~~, the ~~fuinction~~ will usually return the current value.		:''<arg1\|arg2>'': A specific set of options that are accepted. Unlike the previous, the function may also be called without any arguments. When called without arguments, the function will usually return the current value.

	=== @status ===		=== @status ===

imported>Wikiadmin at 17:52, 31 August 2014

2014-08-31T17:52:17Z

← Older revision		Revision as of 17:52, 31 August 2014
Line 13:		Line 13:
	:''<argument>'': optional argument to a function.		:''<argument>'': optional argument to a function.
	:''arg1\|arg2'': A specific set of options that are accepted. The function expects either 'arg1' or 'arg2' but not both or neither.		:''arg1\|arg2'': A specific set of options that are accepted. The function expects either 'arg1' or 'arg2' but not both or neither.
	:''<arg1\|arg2>'': A specific set of options that are accepted. Unlike the previous, the function may also be called without any arguments. When called without ~~arguments it~~ will return the current value.		:''<arg1\|arg2>'': A specific set of options that are accepted. Unlike the previous, the function may also be called without any arguments. When called without argument, the fuinction will usually return the current value.

	=== @status ===		=== @status ===

imported>Wikiadmin: /* @output */

2014-08-22T12:47:59Z

@output

← Older revision		Revision as of 12:47, 22 August 2014
Line 77:		Line 77:
	Object used to send output to the console.		Object used to send output to the console.
	:'''std(''' ''string'' ''')''': Prints a string. No automatic newlines.		:'''std(''' ''string'' ''')''': Prints a string. No automatic newlines.
	:''info'(''' ''string'' ''')''': Prints a string in yellow. No automatic newlines.		:'''info(''' ''string'' ''')''': Prints a string in yellow. No automatic newlines.
	:'''special(''' ''string'' ''')''': Prints a string in blue. No automatic newlines.		:'''special(''' ''string'' ''')''': Prints a string in blue. No automatic newlines.
	:'''good(''' ''string'' ''')''': Prints a string in green. No automatic newlines.		:'''good(''' ''string'' ''')''': Prints a string in green. No automatic newlines.

imported>Wikiadmin: /* @timer */

2014-08-22T12:47:15Z

@timer

← Older revision		Revision as of 12:47, 22 August 2014
Line 111:		Line 111:
	=== @timer ===		=== @timer ===
	Object that can be used to schedule code to be executed at a later time.		Object that can be used to schedule code to be executed at a later time.
	:'''action(''' ''wait_time, command'' ''')''': Wait for ~~a set amount of~~ seconds and then try to execute 'command'.		:'''action(''' ''wait_time, command'' ''')''': Wait for ''wait_time'' seconds and then try to execute 'command'.
	'''An eval() is performed on 'command' so use with caution!'''		'''An eval() is performed on 'command' so use with caution!'''

imported>Wikiadmin at 12:45, 22 August 2014

2014-08-22T12:45:12Z

← Older revision		Revision as of 12:45, 22 August 2014
Line 1:		Line 1:
	== Writing plugins for nanobot ==		== Writing plugins for nanobot ==
	If you cannot find a plugin with the functionality you need you may decide you want to write a plugin yourself.		If you cannot find a plugin with the functionality you need you may decide you want to write a plugin yourself.


	== The demo plugin ==		== The demo plugin ==

imported>Wikiadmin: /* The demo plugin */

2014-08-22T12:44:52Z

The demo plugin

← Older revision		Revision as of 12:44, 22 August 2014
Line 4:		Line 4:

	== The demo plugin ==		== The demo plugin ==
	By far the best place to start is with the demo plugin. It has a short description and example for every special function and examples of some common constructions you may use when writing your own plugin.		By far the best place to start is with the demo plugin. It has a short description and example for every special function and examples of some common constructions you may use when writing your own plugin. For a list of the special functions and when they're called have a look at [[Nanobot_manual#Plugins]]
	Besides that hand full of special functions it's just plain Ruby.		Besides that hand full of special functions it's just plain Ruby.


	== Global objects ==		== Global objects ==

imported>Wikiadmin at 12:08, 22 August 2014

2014-08-22T12:08:11Z

← Older revision		Revision as of 12:08, 22 August 2014
Line 110:		Line 110:
	:'''mode(''' ''channel, mode, subject, <true\|false>'' ''')''': Send MODE command to set modes on a subject. High priority may be specified.		:'''mode(''' ''channel, mode, subject, <true\|false>'' ''')''': Send MODE command to set modes on a subject. High priority may be specified.
	:'''quit(''' ''message, <true\|false>'' ''')''': Send QUIT command with a quit message. High priority may be specified.		:'''quit(''' ''message, <true\|false>'' ''')''': Send QUIT command with a quit message. High priority may be specified.

			=== @timer ===
			Object that can be used to schedule code to be executed at a later time.
			:'''action(''' ''wait_time, command'' ''')''': Wait for a set amount of seconds and then try to execute 'command'.
			'''An eval() is performed on 'command' so use with caution!'''

imported>Wikiadmin at 12:04, 22 August 2014

2014-08-22T12:04:24Z

← Older revision		Revision as of 12:04, 22 August 2014
Line 90:		Line 90:
	:'''cbad(''' ''string'' ''')''': Same as above, except in red.		:'''cbad(''' ''string'' ''')''': Same as above, except in red.
	:'''cspecial(''' ''string'' ''')''': Same as above, except in blue.		:'''cspecial(''' ''string'' ''')''': Same as above, except in blue.

			=== @irc ===
			Object to interact with the IRC socket
			:'''socket()''': Return a reference to the raw socket object. Not something you normally need.
			:'''raw(''' ''line, <true\|false>'' ''')''': Send a raw string to the socket. True or false may be specified as the second argument to indicate if this is a priority message. If true it will be placed in a special high priority output queue so it will bypass any long output queues.
			:'''connect()''': Used by the bot to set up the initial connection with the IRC server.
			:'''reconnect()''': Used by the bot to reconnect if required for whatever reason.
			:'''disconnect()''': Try to send any messages in the queue and close the connection to the IRC server.
			:'''sendinit()''': Used by the bot upon connect to send server passwords and nickname information.
			:'''login()''': Used by the bot to identify with nickserv and autojoin channels.
			:'''pong(''' ''PING_line'' ''')''': Used by the bot to respond to PING requests from the server.
			:'''message(''' ''dest, message, <true\|false>'' ''')''': Send a normal IRC message. Dest may be a nickname or a channel. The boolean specifies if it is a high priority message.
			:'''notice(''' ''dest, message, <true\|false>'' ''')''': Same as above, except a notice is sent.
			:'''nick(''' ''nickname, <true\|false>'' ''')''': Send a NICK command to the server to change the bots nickname. Also sets @config.nick. A priority may be specified.
			:'''topic(''' ''channel, topic, <true\|false>'' ''')''': Set the topic of a channel. High priority may be specified.
			:'''join(''' ''channel, <true\|false>'' ''')''': Send JOIN command to join a channel. High priority may be specified.
			:'''part(''' ''channel, <true\|false>'' ''')''': Same as above except PART command is sent.
			:'''kick(''' ''channel, user, reason, <true\|false>'' ''')''': Kick a user from a channel with a specified reason. High priority may be specified.
			:'''mode(''' ''channel, mode, subject, <true\|false>'' ''')''': Send MODE command to set modes on a subject. High priority may be specified.
			:'''quit(''' ''message, <true\|false>'' ''')''': Send QUIT command with a quit message. High priority may be specified.

imported>Wikiadmin at 11:50, 22 August 2014

2014-08-22T11:50:05Z

← Older revision		Revision as of 11:50, 22 August 2014
Line 75:		Line 75:
	:'''show()''': Called on startup to see if the -p option is set. Do not call manually since it calls 'Process.exit' at the end of the function.		:'''show()''': Called on startup to see if the -p option is set. Do not call manually since it calls 'Process.exit' at the end of the function.
	:'''yn(''' ''variable'' ''')''': Helper function for 'show()'. Returns 'Yes' if a variable is true, 'No' if false.		:'''yn(''' ''variable'' ''')''': Helper function for 'show()'. Returns 'Yes' if a variable is true, 'No' if false.

			=== @output ===
			Object used to send output to the console.
			:'''std(''' ''string'' ''')''': Prints a string. No automatic newlines.
			:''info'(''' ''string'' ''')''': Prints a string in yellow. No automatic newlines.
			:'''special(''' ''string'' ''')''': Prints a string in blue. No automatic newlines.
			:'''good(''' ''string'' ''')''': Prints a string in green. No automatic newlines.
			:'''bad(''' ''string'' ''')''': Prints a string in red. No automatic newlines.
			:'''debug(''' ''string'' ''')''': Prints a string if the debug level is 1 or higher.
			:'''debug_extra(''' ''string'' ''')''': Prints a string if the debug level is 2 or higher.
			:'''c(''' ''string'' ''')''': Prints a string for the interactive console. Does not print if console is disabled. No newlines.
			:'''cinfo(''' ''string'' ''')''': Same as above, except in yellow.
			:'''cgood(''' ''string'' ''')''': Same as above, except in green.
			:'''cbad(''' ''string'' ''')''': Same as above, except in red.
			:'''cspecial(''' ''string'' ''')''': Same as above, except in blue.