data/manual/complementos/index.html
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Complementos - pilas-engine</title>
<link rel="shortcut icon" href="../img/favicon.ico">
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script>
// Current page data
var mkdocs_page_name = "Complementos";
var mkdocs_page_input_path = "complementos.md";
var mkdocs_page_url = "/complementos/";
</script>
<script src="../js/jquery-2.1.1.min.js"></script>
<script src="../js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> pilas-engine</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li>
<li class="toctree-l1 ">
<a class="" href="..">Principal</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../que_juegos/">Tipos de juegos</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../instalacion/">Instalación</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../about/">Acerca de ...</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../empezando/">Empezando y los primeros pasos con pilas</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../actores/">Actores</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../actores_personalizados/">Actores personalizados</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../grupos/">Grupos</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../colisiones/">Colisiones</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../etiquetas/">Etiquetas</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../fisica/">Fisica</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../controles/">Controles</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../joystick/">Joystick</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../imagen/">Imagen</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../sonidos/">Audio: Sonidos y Música</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../dibujado_simple_en_pantalla/">Dibujado simple en pantalla</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../dibujado_avanzado_con_superficies/">Dibujado avanzado con Superficies</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../tareas/">Manejo de tiempo con tareas</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../interpolacion/">Interpolaciones</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../controlando_la_pantalla/">Controlando la pantalla</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../comportamientos/">Comportamientos</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../escenas/">Escenas</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../interfaz/">Interfaz de usuario</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../menu/">Cómo crear menúes para tu juegos</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../mapas_y_plataformas/">Mapas y plataformas</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../dialogos/">Diálogos</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../camara/">Manejo de Cámara</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../eventos/">Eventos</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../texto/">Textos</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../habilidades/">Habilidades</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../depurando/">Depurando</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../como_funciona_pilas_por_dentro/">¿Cómo funciona pilas por dentro?</a>
</li>
<li>
<li>
<li class="toctree-l1 current">
<a class="current" href="./">Complementos</a>
<ul>
<li class="toctree-l3"><a href="#complementos-plugins">Complementos (Plugins)</a></li>
<li><a class="toctree-l4" href="#que-son-los-complementos">¿Que son los complementos?</a></li>
<li><a class="toctree-l4" href="#inicializando-los-complementos">Inicializando los complementos</a></li>
<li><a class="toctree-l4" href="#creando-un-plugin-de-ejemplo">Creando un plugin de ejemplo</a></li>
<li><a class="toctree-l4" href="#no-olvides-pasar-el-objeto-pilas">No olvides pasar el objeto "pilas"...</a></li>
</ul>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="../desarrolladores/">Guía para desarrolladores</a>
</li>
<li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">pilas-engine</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> »</li>
<li>Complementos</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="complementos-plugins">Complementos (Plugins)</h1>
<p>Pilas incorpora un sistema de complementos para que se pueda
personalizar el entorno completo usando código auto-incluido.</p>
<p>Esta es una funcionalidad avanzada, que se suele utilizar en
talleres o cursos especializados. La idea general es que pilas
se puede modificar añadiendo código en un directorio especial y
sin necesidad de tocar le código fuente de pilas en sí.</p>
<h2 id="que-son-los-complementos">¿Que son los complementos?</h2>
<p>Los complementos, o plugins, son simplemente archivos de código
python que pilas leerá al momento de iniciar.</p>
<p>Cada código python podrá definir clases que luego se podrán utilizar
directamente desde el motor.</p>
<p>Todos los complementos tienen que existir en un directorio
especial del sistema. Estos son los lugares en donde se buscarán los
complementos:</p>
<ul>
<li>En linux: $USERDIR/.pilas-engine/complementos/</li>
<li>En OSX: $USERDIR/.pilas-engine/complementos/</li>
</ul>
<h2 id="inicializando-los-complementos">Inicializando los complementos</h2>
<p>Los complementos no se buscarán a menos que se iniciale pilas-engine
especificando que queremos complementos.</p>
<p>Para inicializar pilas-engine con soporte para completos tenemos
que usar el parámetro "cargar_plugins" así:</p>
<pre><code class="python">import pilasengine
pilas = pilasengine.iniciar(cargar_plugins=True)
</code></pre>
<p>Y en la consola tendrá que aparecer un texto indicando la cantidad de
complementos encontrada.</p>
<h2 id="creando-un-plugin-de-ejemplo">Creando un plugin de ejemplo</h2>
<p>Para probar esta funcionalidad, vamos a hacer un complemento muy
simple que solamente muestre un mensaje cuando pilas se inicializa.</p>
<p>Primero tenemos que crear el archivo para el complemento, en este
caso <code>$HOMEDIR/.pilas-engine/plugins/saludar.py</code></p>
<pre><code class="python">class Saludar(object):
def __init__(self, pilas):
pilas.avisar("Bienvenido, pilas se inicio correctamente.")
</code></pre>
<p>Luego, para iniciarle a pilas que queremos cargar los complementos
tenemos que iniciar pilas así:</p>
<pre><code class="python">import pilasengine
pilas = pilasengine.iniciar(cargar_plugins=True)
</code></pre>
<p>tendríamos que ver en consola el mensaje <code>Se encontro un plugin</code>. Luego,
para inicializar el complemento:</p>
<pre><code class="python">pilas.complementos.Saludar(pilas)
</code></pre>
<p>Es decir, en el nombre de cualquier clase definida en nuestros complementos
estará accesible a través del acceso <code>pilas.complementos...</code></p>
<h2 id="no-olvides-pasar-el-objeto-pilas">No olvides pasar el objeto "pilas"...</h2>
<p>Ten en cuenta que a partir de la versión 0.90 de pilas-engine, para
acceder a la funcionalidad de pilas tenemos que usar la variable "pilas", y
que esta no el global. Así que te recomendamos hacer complementos
tal y como lo sugeremos aquí en el ejemplo, declarando "pilas" como un arguemento
en el inicializador:</p>
<pre><code class="python">def NombreComplemento(object):
def __init__(self, pilas):
# [etc...]
</code></pre>
<p>e inicializándolo especificando el objeto pilas:</p>
<pre><code class="python">pilas.complementos.NombreComplemento(pilas)
</code></pre>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../desarrolladores/" class="btn btn-neutral float-right" title="Guía para desarrolladores"/>Siguiente <span class="icon icon-circle-arrow-right"></span></a>
<a href="../como_funciona_pilas_por_dentro/" class="btn btn-neutral" title="¿Cómo funciona pilas por dentro?"><span class="icon icon-circle-arrow-left"></span> Anterior</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Creado con <em>MkDocs</em>.
<script>
$(document).ready(function() {
$('img').each(function(elemento) {
if (this.src.indexOf('github.io') > 0) {
this.src = this.src.replace('github.io/imagenes', 'github.io/pilas-manual/imagenes');
}
});
});
</script>
<script>
$(document).ready(function() {
String.prototype.endsWith = function(suffix){
return this.indexOf(suffix, this.length - suffix.length) !== -1;
};
$('a').each(function(){
var x=this.href;
if (!this.href.endsWith('html') && this.href.indexOf('#') < 0 && this.href.indexOf('http://') === -1 && this.href.indexOf('https://') === -1) {
if (this.href.endsWith('/')) {
this.href = this.href + "index.html";
} else {
this.href = this.href + "/index.html";
}
}
});
});
</script>
<script>
function alternar_menu() {
var sidebar = document.querySelectorAll(".wy-nav-side")[0];
var left = sidebar.style.left;
if (left === "-300px") {
sidebar.style.left = "0px";
} else {
if (left === "0px") {
sidebar.style.left = "-300px";
} else {
sidebar.style.left = "0px";
}
}
}
$(document).ready(function() {
document.querySelector('ul.wy-breadcrumbs>li>a').onclick = function() {
var w = Math.max(document.documentElement.clientWidth, window.innerWidth || 0);
if (w < 768) {
alternar_menu();
return false;
} else {
return true;
}
}
});
</script>
<style>
.rst-versions {
border: 0 !important;
}
.wy-nav-side {
padding-bottom: 50px;
}
.wy-nav-content-wrap {
background-color: white !important;
}
.wy-nav-content {
background-color: white !important;
}
.star {
display: inline-block !important;
width: 14px !important;
height: 14px !important;
background-image: url('/imagenes/star.png');
margin-bottom: -2px;
margin-left: 4px;
}
</style>
</footer>
<script type="text/javascript">
var dentro_de_pilas_engine = (document.location.href.indexOf('file://') === 0);
// Ocultando la barra de búsqueda
if (dentro_de_pilas_engine) {
var b = document.getElementsByName('q');
b[0].style.display = "none"
}
</script>
<style media="screen">
code {
font-size: 15px !important;
}
</style>
<style>
img {
width: auto !important;
}
pre {
padding: 0px !important;
}
.hljs {
font-size: 15px;
}
td {
padding: 15px;
text-align: center;
}
.wy-menu-vertical li.current {
background: #0B0B0B;
}
.wy-menu-vertical li.on a, .wy-menu-vertical li.current>a {
color: #FFFFFF;
padding: 0.4045em 1.618em;
font-weight: bold;
position: relative;
background: #6C6C6C;
border: none;
border-bottom: none;
border-top: none;
padding-left: 1.618em -4px;
}
.wy-menu-vertical li.current a {
color: rgb(186, 186, 186);
}
.wy-menu-vertical li.current a:hover {
background: #444444;
}
</pre>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="../como_funciona_pilas_por_dentro/" style="color: #fcfcfc;">« Previous</a></span>
<span style="margin-left: 15px"><a href="../desarrolladores/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
</body>
</html>