Documentación

La librería OScratch emula un entorno de juego de Scratch bajo la plataforma de programación de Processing. La siguiente imagen muestra el entorno de ejecución, donde se está desarrollando un juego con dos actores: Un gato y un murciélago.

Como se puede apreciar dentro de la ventana de ejecución del juego aparecen tres áreas diferenciadas:

  • Una cabecera en la parte superior, donde se encuentran el icono de bandera y de stop.

  • Un pie o barra de estado en la parte inferior, donde se muestran las coordenadas del puntero del ratón.

  • La zona de juego que ocupa la parte central y es mucho más grande que las anteriores.

La funcionalidad de la librería OScratch descansa principalmente en tres clases:

  • OsGame: Representa el entorno de Scratch

  • OsSprite: Representa un actor o sprite

  • OsStage: Representa un escenario o stage

La siguiente imagen muestra un ejemplo de la estructura básica de un programa que utiliza esta librería.

La pestaña principal del programa que se está realizando con Processing contendrá un código semejante al mostrado. Será, no obstante, necesario implementar las clases MiEscenario y MiActor. Esto se puede hacer dentro de la propia pestaña principal o en pestañas separadas que formen parte del mismo sketch de Processing.

La siguiente imagen muestra el esquema que tendría la clase MiEscenario.

Las funciones que aparecen en la plantilla, serán llamadas por el sistema en respuesta a distintos eventos:

  • setup(): Es llamada por el sistema cuando se crea el escenario. Es el lugar ideal para cargar los fondos y sonidos con los que contará el escenario.

  • alPresionarBandera(): Como su nombre indica el sistema llamará a esta función cuando el usuario pulse sobre la bandera del entorno de juego.

  • alPresionarObjeto(): El sistema llama a esta función cuando el usuario del juego pulsa sobre el fondo.

  • alPresionarTecla(): Es llamada por el sistema cuando el usuario del juego pulsa una tecla.

  • alRecibir(): Es llamada por el sistema en respuesta a un evento de enviarATodos. Forma parte del mecanismo de envío de mensajes que implementa Scratch para la comunicación entre los distintos objetos que forman parte del juego.

Será responsabilidad del programador del juego implementar el código de estas funciones para desarrollar la lógica del juego. Cabe mencionar que no es obligatorio la implementación de estas funciones.

En cuanto a la clase MiActor, la siguiente imagen muestra el esquema que podría seguir.

Como se puede observar presenta el mismo esquema que el de la clase MiEscenario. Por tanto, todo lo dicho anteriormente para la clase que implementa el escenario es aplicable para la clase que implementa al actor.

Hay que destacar que los nombres datos a las clases (MiEscenario y MiActor) podrían ser otros distintos, al igual que las variables que las instancian. De hecho cada programador dará los nombres a estas clases y variables que considere oportuno. También, hay que puntualizar que puede haber más de una clase que implementa un actor. Al igual que puede haber varios actores distintos de la misma clase.

Para más información se puede descargar el Manual de Usuario y el Manual de Instalación.