#Stencyl dialog extension how to#
#Stencyl dialog extension manual#
#Stencyl dialog extension full#
#Stencyl dialog extension code#

Return true if this extension has options that can be configured with the onOptions panel. Provide a set of blocks to be added to the palette. Use this to modify the resulting project. Usually, you'd use this to save stuff out. Try not to do anything intense, or it will slow down launch.Ĭalled when the extension is told to display or 'do work'Ĭalled when Stencyl is being quit out of.

#Stencyl dialog extension full#

Consult the API for the full list of callbacks.Ĭalled when Stencyl is launching. These callback functions are called at specific times in Stencyl's lifecycle. Callback ReferenceĬallbacks are functions that you implement inside your extension. We cover the main parts of this API in the following sections. It's preferable that you either build documentation into the forum topic or provide a link to a site that does. At least 1 screenshot of your extension.Include the following details in the forum topic.

If not, contact us and point out your forum topic. If the community response is positive, we may post up your extension without any action on your part.Post your extension on the Forums for a community review.Extensions must be manually approved to show up on that site. Optional, connect to this repository for extension updatesġ (increasing this causes updateFromVersion to be called for GameExtensions)Įxtensions are distributed through our Developer Center. Main class extends BaseExtension or GameExtension. These details can be edited in the ant task used to build your extension by using the nested element. The name, description, icon location, and other basic details of the extension are saved in. Rebuild (run the dist ANT task) and relaunch Stencyl.For example, change menuName = 'Extension Name' to a different value. Now that the sample extension runs, open up SampleExtension.java, the source that defines the extension itself.ĭo you see how it implements a bunch of callback functions that all start with 'on'? Launch your copy of Stencyl, and you will see the Sample Extension appear in the Extensions menu and also inside the Extensions Manager (Extensions > Extension Manager).This builds a Java JAR file that Stencyl recognizes as an extension. Add an ANT task for the dist task inside build.xml.Īfter that is done, run the dist ANT task from the IDE.Place it under /extensions/ - This folder contains all of your toolset extensions.Ĭreate a project for the extension using your IDE of choice. Use this as a template to base your own extension off of. We'll go through it when we reach the point where it's needed. Eclipse, Netbeans or any setup that can run an ANT Build.ĪNT is a task running system for Java.You will need the following before you begin.

#Stencyl dialog extension how to#

Getting Started - How to Create an Extension Requirements

#Stencyl dialog extension manual#

These callback functions are called at specific times in Stencyl's lifecycle.įor example, there are callbacks for these activities:Įvery callback is documented at the end of this manual and inside our API docs.

Extensions menu in the dashboard sidebarĬallbacks are functions that you implement inside your extension.

At this time, the available places where an extension an hook into include: Hooks determine where your extension is displayed in Stencyl's GUI. If you have an idea for an extension but you need some new hooks, callbacks, or capabilities on Stencyl's side, let us know and we'd be happy to work together to bring your extension to life! Concepts - Hooks and Callbacksĭeveloping an extension is simple once you master two key concepts: hooks and callbacks.

#Stencyl dialog extension code#

If you're looking to extend the engine, look here instead.įor source code examples of existing extensions, you can see the polydes collection of extensions. Can _ be an extension?Īs long as the extension has something to do with Stencyl, it's generally doable.

Swing and/or some experience creating GUIsĪlthough we provide an API that makes it simple to build a GUI with no Swing knowledge, knowing it will give you the ability to create more powerful extensions.

The most notable extension created with Stencyl at the moment is the Dialog Extension, a powerful, easy to use dialog system that supports pretty much every feature you'd need. Extensions allow the community to extend the utility of Stencyl itself to fit its unique needs. They serve the same purpose as extensions for web browsers, such as Firefox and Chrome.

Comments How to Create Toolset ExtensionsĮxtensions are small applications or controls that add new functionality to Stencyl.