BaseExtension

java.lang.Object
- stencyl.sw.ext.BaseExtension

Direct Known Subclasses:: GameExtension

public abstract class BaseExtension
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`authorName` Deprecated.
`protected int`	`category`
`protected java.lang.String`	`classname` Deprecated.
`protected java.lang.String`	`description` Deprecated.
`protected java.lang.String`	`gameCenterName` The name of this extension in the Dashboard sidebar menu.
`protected javax.swing.Icon`	`icon` Deprecated.
`protected int`	`ID`
`protected int`	`internalVersion` Deprecated.
`protected boolean`	`isActive`
`protected boolean`	`isInGameCenter` Whether this extension is included in the Dashboard sidebar menu
`protected boolean`	`isInMenu` Whether this extension is included in the menu bar's "Extensions" menu
`protected boolean`	`isMenuItemInitiallyEnabled` Whether this extension is initially enabled in the Extensions menu.
`protected java.lang.String`	`menuName` The name of this extension in the Extensions menu.
`protected java.lang.String`	`name` Deprecated.
`protected java.util.HashMap<java.lang.String,java.lang.Object>`	`properties`
`protected java.lang.String`	`version` Deprecated.
`protected java.lang.String`	`website` Deprecated.

Constructor Summary

Constructors
Constructor and Description

BaseExtension()

Constructors
Constructor and Description
`BaseExtension()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`disableMenu()`
`static void`	`doLongTask(java.lang.Runnable mainTask, java.lang.Runnable onFinish)` Do a background task that could hold up the program.
`void`	`enableMenu()`
`void`	`extensionsReady()` Deprecated.
`java.lang.String`	`getAuthorName()` Deprecated.
`int`	`getCategory()`
`java.lang.String`	`getClassname()` Deprecated.
`java.lang.String`	`getDescription()` Deprecated.
`stencyl.sw.editors.snippet.designer.Definitions.DefinitionMap`	`getDesignModeBlocks()` A set of Design Mode blocks provided by this extension.
`java.lang.String`	`getGameCenterName()`
`javax.swing.Icon`	`getIcon()` Deprecated.
`int`	`getID()`
`java.lang.Integer`	`getImageSaveRequest()` Override this function to skip the Save File dialog for screenshots (scene and behavior/event screen captures)
`int`	`getInternalVersion()` Deprecated.
`stencyl.sw.ext.ExtensionManifest`	`getManifest()`
`java.lang.String`	`getMenuName()`
`java.lang.String`	`getName()` Deprecated.
`java.lang.String`	`getVersion()` Deprecated.
`java.lang.String`	`getWebsite()` Deprecated.
`boolean`	`handlesImages(boolean requiresSameSize)` Return true if you want this extension to be included in a list of processors that operate on images.
`boolean`	`handlesSounds()` Return true if you want this extension to be included in a list of processors that operate on sounds.
`protected boolean`	`hasOptions()`
`protected void`	`hideProgressSpinner()` Hide the progress spinner.
`boolean`	`isActive()` Deprecated.
`boolean`	`isInGameCenter()`
`boolean`	`isInMenu()`
`boolean`	`isKitSpecific()` A kit can bundle an extension (placed at [KIT_DIR]/extensions/)
`boolean`	`isMenuItemInitiallyEnabled()`
`abstract void`	`onActivate()` Happens when the extension is told to display.
`void`	`onDestroy()` Happens when Stencyl closes.
`void`	`onGameBuild(stencyl.core.lib.Game game)` Happens when the user runs, previews or exports the game.
`javax.swing.JPanel`	`onGameCenterActivate()` Return a UI to show if/when this extension is shown in the Game Center.
`void`	`onGameClosed(stencyl.core.lib.Game game)` Happens when a game is closed.
`void`	`onGameCreatedFromKit()` Called when a game is created from a kit.
`abstract void`	`onGameOpened(stencyl.core.lib.Game game)` Happens when a game is opened.
`abstract void`	`onGameSave(stencyl.core.lib.Game game)` Happens when a game is saved.
`abstract void`	`onInstall()` Happens when the extension is first installed.
`abstract OptionsPanel`	`onOptions()` Show the options dialog for this extension.
`void`	`onScreenCapture(java.awt.image.BufferedImage img)` NJM new callback Happens when a screen capture is triggered.
`void`	`onStartup()` Happens when Stencyl launches.
`abstract void`	`onUninstall()` Happens when the extension is uninstalled.
`java.awt.image.BufferedImage`	`processImage(java.awt.image.BufferedImage in)` Given an image, process it and send back the final result.
`byte[]`	`processSound(byte[] in, java.lang.String format)` Given a sound, process it and send back the final result.
`protected void`	`putProp(java.lang.String key, java.lang.Object value)` Store a property.
`protected boolean`	`readBoolProp(java.lang.String key, boolean defaultValue)` Read a boolean property.
`protected java.lang.String`	`readData()` Read your extension's data in to a String.
`protected byte[]`	`readDataAsBytes()` Read your extension's data in to a byte array.
`protected double`	`readDoubleProp(java.lang.String key, double defaultValue)` Read a double property.
`protected float`	`readFloatProp(java.lang.String key, float defaultValue)` Read a float property.
`protected int`	`readIntProp(java.lang.String key, int defaultValue)` Read an integer property.
`protected java.lang.String`	`readStringProp(java.lang.String key, java.lang.String defaultValue)` Read a string property.
`protected boolean`	`saveData(java.lang.String data)` Save your extension's data given a String representation of it.
`protected boolean`	`saveDataAsBytes(byte[] b)` Save your extension's data given a byte array representation of it.
`void`	`setActive(boolean isActive)` Deprecated.
`void`	`setAuthorName(java.lang.String authorName)` Deprecated.
`void`	`setCategory(int category)`
`void`	`setDescription(java.lang.String description)` Deprecated.
`void`	`setGameCenterCount(int count)`
`void`	`setGameCenterItem(com.explodingpixels.macwidgets.SourceListItem item)`
`void`	`setGameCenterName(java.lang.String gameCenterName)`
`void`	`setID(int id)`
`void`	`setInGameCenter(boolean isInGameCenter)`
`void`	`setInMenu(boolean isInMenu)`
`void`	`setInternalVersion(int internalVersion)` Deprecated.
`void`	`setManifest(stencyl.sw.ext.ExtensionManifest manifest)`
`void`	`setMenuItem(javax.swing.JMenuItem item)`
`void`	`setMenuName(java.lang.String menuName)`
`void`	`setMenuText(java.lang.String t)`
`void`	`setName(java.lang.String name)` Deprecated.
`protected void`	`setProgressMessage(java.lang.String msg)` Show a progress spinner with a message.
`void`	`setVersion(java.lang.String version)` Deprecated.
`void`	`setWebsite(java.lang.String website)` Deprecated.
`void`	`showInGameCenter()`
`protected void`	`showMessageDialog(java.lang.String title, java.lang.String text)` Show a simple modal dialog to the user.
`protected void`	`showOptions()`
`protected void`	`showProgressSpinner()` Show a progress spinner with no message.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - classname
```
@Deprecated
protected java.lang.String classname
```
    Deprecated.
  - ID
```
protected int ID
```
  - name
```
@Deprecated
protected java.lang.String name
```
    Deprecated.
  - description
```
@Deprecated
protected java.lang.String description
```
    Deprecated.
  - authorName
```
@Deprecated
protected java.lang.String authorName
```
    Deprecated.
  - website
```
@Deprecated
protected java.lang.String website
```
    Deprecated.
  - internalVersion
```
@Deprecated
protected int internalVersion
```
    Deprecated.
  - version
```
@Deprecated
protected java.lang.String version
```
    Deprecated.
  - category
```
protected int category
```
  - isActive
```
protected boolean isActive
```
  - icon
```
@Deprecated
protected javax.swing.Icon icon
```
    Deprecated.
  - isInMenu
```
protected boolean isInMenu
```
    Whether this extension is included in the menu bar's "Extensions" menu
  - isMenuItemInitiallyEnabled
```
protected boolean isMenuItemInitiallyEnabled
```
    Whether this extension is initially enabled in the Extensions menu. Use enableMenu and disableMenu to change this later.
  - menuName
```
protected java.lang.String menuName
```
    The name of this extension in the Extensions menu. Use setMenuText to set this later.
  - isInGameCenter
```
protected boolean isInGameCenter
```
    Whether this extension is included in the Dashboard sidebar menu
  - gameCenterName
```
protected java.lang.String gameCenterName
```
    The name of this extension in the Dashboard sidebar menu. Use setGameCenterName to set this later.
  - properties
```
protected java.util.HashMap<java.lang.String,java.lang.Object> properties
```
- Constructor Detail
  - BaseExtension
```
public BaseExtension()
```
- Method Detail
  - readIntProp
```
protected int readIntProp(java.lang.String key,
                          int defaultValue)
```
    Read an integer property.
    
    Parameters:
    
    key - Property name
    
    defaultValue - Default value if the property doesn't exist
    
    Returns:
    
    The value of the property or defaultValue
  - readDoubleProp
```
protected double readDoubleProp(java.lang.String key,
                                double defaultValue)
```
    Read a double property.
    
    Parameters:
    
    key - Property name
    
    defaultValue - Default value if the property doesn't exist
    
    Returns:
    
    The value of the property or defaultValue
  - readFloatProp
```
protected float readFloatProp(java.lang.String key,
                              float defaultValue)
```
    Read a float property.
    
    Parameters:
    
    key - Property name
    
    defaultValue - Default value if the property doesn't exist
    
    Returns:
    
    The value of the property or defaultValue
  - readBoolProp
```
protected boolean readBoolProp(java.lang.String key,
                               boolean defaultValue)
```
    Read a boolean property.
    
    Parameters:
    
    key - Property name
    
    defaultValue - Default value if the property doesn't exist
    
    Returns:
    
    The value of the property or defaultValue
  - readStringProp
```
protected java.lang.String readStringProp(java.lang.String key,
                                          java.lang.String defaultValue)
```
    Read a string property.
    
    Parameters:
    
    key - Property name
    
    defaultValue - Default value if the property doesn't exist
    
    Returns:
    
    The value of the property or defaultValue
  - putProp
```
protected void putProp(java.lang.String key,
                       java.lang.Object value)
```
    Store a property. Properties are saved to the file system when the extension is destroyed and when the extension's options menu is closed with "ok".
    
    Parameters:
    
    key - Property name
    
    value - The value to store.
  - showMessageDialog
```
protected final void showMessageDialog(java.lang.String title,
                                       java.lang.String text)
```
    Show a simple modal dialog to the user.
    
    Parameters:
    
    title - Title of the message
    
    text - Content of the message
  - doLongTask
```
public static final void doLongTask(java.lang.Runnable mainTask,
                                    java.lang.Runnable onFinish)
```
    Do a background task that could hold up the program.
    
    Parameters:
    
    mainTask - task to run in the background
    
    onFinish - task to run when mainTask is complete
  - setProgressMessage
```
protected final void setProgressMessage(java.lang.String msg)
```
    Show a progress spinner with a message.
    
    Parameters:
    
    msg - Message to show
  - showProgressSpinner
```
protected final void showProgressSpinner()
```
    Show a progress spinner with no message.
  - hideProgressSpinner
```
protected final void hideProgressSpinner()
```
    Hide the progress spinner.
  - readData
```
protected final java.lang.String readData()
```
    Read your extension's data in to a String. Location is pre-determined.
    
    Returns:
    
    Previously saved data as a String.
  - readDataAsBytes
```
protected final byte[] readDataAsBytes()
```
    Read your extension's data in to a byte array. Location is pre-determined.
    
    Returns:
    
    Previously saved as a byte[].
  - saveData
```
protected final boolean saveData(java.lang.String data)
```
    Save your extension's data given a String representation of it. Location is pre-determined.
    
    Parameters:
    
    data - The data to save
    
    Returns:
    
    true if the data was successfully saved
  - saveDataAsBytes
```
protected final boolean saveDataAsBytes(byte[] b)
```
    Save your extension's data given a byte array representation of it. Location is pre-determined.
    
    Parameters:
    
    b - The data to save
    
    Returns:
    
    true if the data was successfully saved
  - handlesImages
```
public boolean handlesImages(boolean requiresSameSize)
```
    Return true if you want this extension to be included in a list of processors that operate on images. For example, a Scale2x processor that given an image will scale it up by 2x and spit it back.
    
    Parameters:
    
    requiresSameSize - informs you whether the image has to retain its size
    
    Returns:
    
    true if you want this extension to be an image processor
  - processImage
```
public java.awt.image.BufferedImage processImage(java.awt.image.BufferedImage in)
```
    Given an image, process it and send back the final result.
    
    Parameters:
    
    in - the input image
    
    Returns:
    
    The resulting image
  - handlesSounds
```
public boolean handlesSounds()
```
    Return true if you want this extension to be included in a list of processors that operate on sounds.
    
    Returns:
    
    true if you want this extension to be an image processor
  - processSound
```
public byte[] processSound(byte[] in,
                           java.lang.String format)
```
    Given a sound, process it and send back the final result.
    
    Parameters:
    
    in - The input sound
    
    format - The format it's in
    
    Returns:
    
    The resulting sound
  - onStartup
```
public void onStartup()
```
    Happens when Stencyl launches. Avoid doing anything time-intensive in here, or it will slow down launch.
  - extensionsReady
```
@Deprecated
public void extensionsReady()
```
    Deprecated.
    
    Happens after all extensions have started up.
  - onActivate
```
public abstract void onActivate()
```
    Happens when the extension is told to display. May happen multiple times during the course of the app. A good way to handle this is to make your extension a singleton.
  - onGameCenterActivate
```
public javax.swing.JPanel onGameCenterActivate()
```
    Return a UI to show if/when this extension is shown in the Game Center.
    
    Returns:
    
    The JPanel to display in the content area.
  - onDestroy
```
public void onDestroy()
```
    Happens when Stencyl closes. Usually used to save things out.
  - onGameSave
```
public abstract void onGameSave(stencyl.core.lib.Game game)
```
    Happens when a game is saved.
    
    Parameters:
    
    game - The game that was saved.
  - onGameOpened
```
public abstract void onGameOpened(stencyl.core.lib.Game game)
```
    Happens when a game is opened.
    
    Parameters:
    
    game - The game that was opened.
  - onGameClosed
```
public void onGameClosed(stencyl.core.lib.Game game)
```
    Happens when a game is closed.
    
    Parameters:
    
    game - The game that was closed.
  - onScreenCapture
```
public void onScreenCapture(java.awt.image.BufferedImage img)
```
    NJM new callback Happens when a screen capture is triggered. Passes in a reference to the BufferedImage as "img". This happens both in the Scene Designer as well as Behavior/Event Editors. If you wish to prevent the "Save To Disk" from happening, return an appropriate value in the getImageSaveRequest() method.
    
    Parameters:
    
    img - The resulting image from the screen capture.
  - onOptions
```
public abstract OptionsPanel onOptions()
```
    Show the options dialog for this extension.
    
    Returns:
    
    A panel to display and modify extension settings.
  - onInstall
```
public abstract void onInstall()
```
    Happens when the extension is first installed.
  - onUninstall
```
public abstract void onUninstall()
```
    Happens when the extension is uninstalled. Clean up files.
  - onGameBuild
```
public void onGameBuild(stencyl.core.lib.Game game)
```
    Happens when the user runs, previews or exports the game. This is a good place to modify the exported openfl project files if needed.
    
    Parameters:
    
    game - The game that is being built.
  - isKitSpecific
```
public boolean isKitSpecific()
```
    A kit can bundle an extension (placed at [KIT_DIR]/extensions/)
    
    onCreate.jar - Only run once at create-time. Unloaded immediately after.
    
    Any other name - Loaded only when the game is opened, so hooks outside this context will not work.
    
    The extensions unload when the kit or app is closed. If the app closes prematurely, they still will not load the next time the app starts.
    
    Returns:
    
    The value
  - onGameCreatedFromKit
```
public void onGameCreatedFromKit()
```
    Called when a game is created from a kit. Used to ask questions about the kit in order to customize it (modify, remove resources).
  - hasOptions
```
protected boolean hasOptions()
```
    Returns:
    
    Whether this extension has options to configure with showOptions.
  - showOptions
```
protected final void showOptions()
```
  - getID
```
public int getID()
```
  - setID
```
public void setID(int id)
```
  - getClassname
```
@Deprecated
public java.lang.String getClassname()
```
    Deprecated.
  - getName
```
@Deprecated
public java.lang.String getName()
```
    Deprecated.
  - setName
```
@Deprecated
public void setName(java.lang.String name)
```
    Deprecated.
  - getDescription
```
@Deprecated
public java.lang.String getDescription()
```
    Deprecated.
  - setDescription
```
@Deprecated
public void setDescription(java.lang.String description)
```
    Deprecated.
  - getAuthorName
```
@Deprecated
public java.lang.String getAuthorName()
```
    Deprecated.
  - setAuthorName
```
@Deprecated
public void setAuthorName(java.lang.String authorName)
```
    Deprecated.
  - getWebsite
```
@Deprecated
public java.lang.String getWebsite()
```
    Deprecated.
  - setWebsite
```
@Deprecated
public void setWebsite(java.lang.String website)
```
    Deprecated.
  - getInternalVersion
```
@Deprecated
public int getInternalVersion()
```
    Deprecated.
  - setInternalVersion
```
@Deprecated
public void setInternalVersion(int internalVersion)
```
    Deprecated.
  - getVersion
```
@Deprecated
public java.lang.String getVersion()
```
    Deprecated.
  - setVersion
```
@Deprecated
public void setVersion(java.lang.String version)
```
    Deprecated.
  - getCategory
```
public int getCategory()
```
  - setCategory
```
public void setCategory(int category)
```
  - isActive
```
@Deprecated
public boolean isActive()
```
    Deprecated.
  - setActive
```
@Deprecated
public void setActive(boolean isActive)
```
    Deprecated.
  - setMenuItem
```
public void setMenuItem(javax.swing.JMenuItem item)
```
    Parameters:
    
    item - Set the item in the Extensions menu to this custom JMenuItem
  - isInMenu
```
public boolean isInMenu()
```
  - isMenuItemInitiallyEnabled
```
public boolean isMenuItemInitiallyEnabled()
```
  - setInMenu
```
public void setInMenu(boolean isInMenu)
```
  - getMenuName
```
public java.lang.String getMenuName()
```
  - setMenuName
```
public void setMenuName(java.lang.String menuName)
```
  - setGameCenterItem
```
public void setGameCenterItem(com.explodingpixels.macwidgets.SourceListItem item)
```
  - isInGameCenter
```
public boolean isInGameCenter()
```
  - setInGameCenter
```
public void setInGameCenter(boolean isInGameCenter)
```
  - getGameCenterName
```
public java.lang.String getGameCenterName()
```
  - setGameCenterName
```
public void setGameCenterName(java.lang.String gameCenterName)
```
  - enableMenu
```
public void enableMenu()
```
  - disableMenu
```
public void disableMenu()
```
  - setMenuText
```
public void setMenuText(java.lang.String t)
```
  - setGameCenterCount
```
public void setGameCenterCount(int count)
```
    Parameters:
    
    count - The number to appear next to your extension in the Dashboard sidebar.
  - showInGameCenter
```
public void showInGameCenter()
```
  - getIcon
```
@Deprecated
public javax.swing.Icon getIcon()
```
    Deprecated.
  - getImageSaveRequest
```
public java.lang.Integer getImageSaveRequest()
```
    Override this function to skip the Save File dialog for screenshots (scene and behavior/event screen captures)
    
    Returns:
    
    1 or greater for Yes, -1 or less for No.
  - getDesignModeBlocks
```
public stencyl.sw.editors.snippet.designer.Definitions.DefinitionMap getDesignModeBlocks()
```
    A set of Design Mode blocks provided by this extension. A DefinitionMap is just a HashMap<String, Definition> of block tag names to block definitions.
    
    Returns:
    
    Blocks
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getManifest
```
public stencyl.sw.ext.ExtensionManifest getManifest()
```
  - setManifest
```
public void setManifest(stencyl.sw.ext.ExtensionManifest manifest)
```

Class BaseExtension

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

classname

ID

name

description

authorName

website

internalVersion

version

category

isActive

icon

isInMenu

isMenuItemInitiallyEnabled

menuName

isInGameCenter

gameCenterName

properties

Constructor Detail

BaseExtension

Method Detail

readIntProp

readDoubleProp

readFloatProp

readBoolProp

readStringProp

putProp

showMessageDialog

doLongTask

setProgressMessage

showProgressSpinner

hideProgressSpinner

readData

readDataAsBytes

saveData

saveDataAsBytes

handlesImages

processImage

handlesSounds

processSound

onStartup

extensionsReady

onActivate

onGameCenterActivate

onDestroy

onGameSave

onGameOpened

onGameClosed

onScreenCapture

onOptions

onInstall

onUninstall

onGameBuild

isKitSpecific

onGameCreatedFromKit

hasOptions

showOptions

getID

setID

getClassname

getName

setName

getDescription

setDescription

getAuthorName

setAuthorName

getWebsite

setWebsite

getInternalVersion

setInternalVersion

getVersion

setVersion

getCategory

setCategory

isActive