-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathexample.py
102 lines (84 loc) · 3.83 KB
/
example.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# -*- coding: UTF8 -*-
# CopyRight (C) 2006-2009 GatoLoko
#
# This file is part of GatoScript
#
# GatoScript is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# GatoScript is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GatoScript; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
Modulo Ejemplo del GatoScript.
Este es un modulo de ejemplo del GatoScript.
"""
__module_name__ = "GatoScript Ejemplo"
__module_description__ = "Modulo Ejemplo para el GatoScript"
__module_autor__ = "GatoLoko"
# Cargamos las librerias y funciones que necesitamos
import xchat
import auxiliar
#############################################################################
# Definimos algunas variables que describen el entorno de trabajo
#############################################################################
_SCRIPTDIR = xchat.get_info("xchatdir")
_GATODIR = "{0}/gatoscript/".format(_SCRIPTDIR)
#############################################################################
# Inicializamos el modulo
#############################################################################
#############################################################################
# Definimos las funciones de uso interno en el modulo
#############################################################################
def ejemplo_interno():
"""Ejemplo de funcion"""
# Comentario
auxiliar.gprint("Esta funcion solo se utiliza dentro de este modulo")
#############################################################################
# Definimos las funcion publicas del modulo
#############################################################################
def ejemplo_publico(word, word_eol, userdata):
"""Ejemplo de funcion publica
Argumentos:
Recibimos los 3 argumentos que utiliza xchat, aunque no los queramos
word -- array de palabras que envia xchat a cada hook (ignorado)
word_eol -- array de cadenas que envia xchat a cada hook (ignorado)
userdata -- variable opcional que se puede enviar a un hook (ignorado)
"""
# Comentario
auxiliar.gprint("Esta funcion se conecta a algun disparador de xchat")
return xchat.EAT_ALL
#############################################################################
# Definimos la funcion de informacion y ayuda sobre el manejo del modulo
#############################################################################
def ayuda():
"""Muestra la ayuda de las funciones de ejemplo para GatoScript"""
mensajes = [
"",
"Ejemplo:",
" /ejemplo_publico: Muestra un mensaje de ejemplo",
""]
return mensajes
#############################################################################
# Definimos la funcion para la descarga del programa
#############################################################################
def unload_cb(userdata):
"""Esta funcion debe desconectar todas las funciones del modulo al
descargarse el script
Argumentos:
userdata -- variable opcional que se puede enviar a un hook (ignorado)
"""
# Desconectamos las funciones
xchat.unhook(HOOKEJEMPLO1)
#############################################################################
# Conectamos los "lanzadores" de xchat con las funciones que hemos definido
# para ellos
#############################################################################
HOOKEJEMPLO1 = xchat.hook_command('ejemplo', ejemplo_publico, userdata=None)