Difference between revisions of "Logon GUILD.php"

From Bebot Wiki 2
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
====== Introduction ======
+
====== Logon.php ======
−
The Logon Notifies core module offers a central place to handle logon notifies for guests or members on the buddy list. To prevent instant spamming it offers a custom-definable delay to the notifications to the modules.
+
This module handles how the org/guest buddies are announced by the bot when they are coming online or offline.
 +
You can set various elements via
 +
!settings Logon
  
−
====== How to register for notifies ======
+
Enable: Should logon spam be enabled at all?
−
If a module wants to use notifies to user logging in via this module it has to register it in the constructor. To do this it has to call
 
−
  $this -> bot -> logon_notifies -> register($this)
 
−
Every time a buddy logs in the module gets now notified via it's notify() function after the defined delay.
 
  
−
====== Function notify($name) ======
+
Guests:  Should Guests logon be spamed?
−
Any module using the central notifies has to implement the function
+
 
−
notify($name)
+
Members:  Should Members logon be spamed?
−
$name is the name of the newly logged in character. Any further actions for the character have to be taken here.
+
 
 +
NoLookup:  Tell the bot to use the built in cache for logon notice. If nothing is cache, no details of the player will be displayed. Warning, setting this to false can cause delays in displaying the logon notice, especially if Funcom XML is being slow.
 +
 
 +
Others: Should Others logon be spamed?
 +
 
 +
RemoveInviter : If current raid/org bot's members logging are to be invited into a remote bot (in which current bot is at least leader), set its name (otherwise leave empty by default).
 +
 
 +
ShowAlts:  Should we display the list of alts if the player logging on is a main in the details chatblob?
 +
 
 +
ShowDetails: Should we display list of details of the player logging on in a chatblob?
 +
 
 +
ShowLinks: Should we display Invite/Raid links (for AoC context only) ?
 +
 
 +
ShowMain: Should we display the main of the player logging in if it's an alt?
 +
 
 +
So you can set how you manage alts/mains, guests, and few more details.
 +
 
 +
You also should check those pages to understand other related features :
 +
 
 +
From Core Logon_Notify http://wiki.bebot.link/index.php/Logon
 +
 
 +
From Module Notify http://wiki.bebot.link/index.php/Notify.php

Latest revision as of 11:37, 2 March 2024

Logon.php

This module handles how the org/guest buddies are announced by the bot when they are coming online or offline. You can set various elements via 

!settings Logon

Enable: Should logon spam be enabled at all?

Guests: Should Guests logon be spamed?

Members: Should Members logon be spamed?

NoLookup: Tell the bot to use the built in cache for logon notice. If nothing is cache, no details of the player will be displayed. Warning, setting this to false can cause delays in displaying the logon notice, especially if Funcom XML is being slow.

Others: Should Others logon be spamed?

RemoveInviter : If current raid/org bot's members logging are to be invited into a remote bot (in which current bot is at least leader), set its name (otherwise leave empty by default).

ShowAlts: Should we display the list of alts if the player logging on is a main in the details chatblob?

ShowDetails: Should we display list of details of the player logging on in a chatblob?

ShowLinks: Should we display Invite/Raid links (for AoC context only) ?

ShowMain: Should we display the main of the player logging in if it's an alt?

So you can set how you manage alts/mains, guests, and few more details.

You also should check those pages to understand other related features :

From Core Logon_Notify http://wiki.bebot.link/index.php/Logon

From Module Notify http://wiki.bebot.link/index.php/Notify.php

Retrieved from "http://wiki.bebot.link/index.php?title=Logon_GUILD.php&oldid=49962"