stencyl.sw.ext

Class GameExtension

java.lang.Object

stencyl.sw.ext.BaseExtension

stencyl.sw.ext.GameExtension

public abstract class GameExtension
extends BaseExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.Object>	extensionGameProperties
protected boolean	isInstalledForGame

Fields inherited from class stencyl.sw.ext.BaseExtension

authorName, category, classname, description, gameCenterName, icon, ID, internalVersion, isActive, isInGameCenter, isInMenu, isMenuItemInitiallyEnabled, menuName, name, properties, version, website

Constructor Summary

Constructors

Constructor and Description
GameExtension()

Method Summary

Modifier and Type	Method and Description
void	clearDataForGame(stencyl.core.lib.Game game)
java.io.File	getDataFolder()
java.io.File	getExtrasFolder()
stencyl.core.lib.Game	getGame()
int	getVersionForGame(stencyl.core.lib.Game game)
void	installForGame() Install this extension for the active game.
boolean	isInstalledForGame(stencyl.core.lib.Game game)
void	onGameClosed(stencyl.core.lib.Game game) Happens when a game is closed.
void	onGameOpened(stencyl.core.lib.Game game) Happens when a game is opened.
void	onGameSave(stencyl.core.lib.Game game) Happens when a game is saved.
abstract void	onGameWithDataClosed()
abstract void	onGameWithDataOpened()
abstract void	onGameWithDataSaved()
abstract void	onInstalledForGame()
abstract void	onUninstalledForGame()
protected void	putGameProp(java.lang.String key, java.lang.Object value) Store a property for the active game.
protected boolean	readBoolGameProp(java.lang.String key, boolean defaultValue) Read a boolean property for the active game.
protected double	readDoubleGameProp(java.lang.String key, double defaultValue) Read a double property for the active game.
protected float	readFloatGameProp(java.lang.String key, float defaultValue) Read a float property for the active game.
protected int	readIntGameProp(java.lang.String key, int defaultValue) Read an integer property for the active game.
protected java.lang.String	readStringGameProp(java.lang.String key, java.lang.String defaultValue) Read a string property for the active game.
void	uninstallForGame() Uninstall this extension for the active game
abstract void	updateFromVersion(int fromVersion) Use this method to run scripts for updating data when the extension is updated.

Methods inherited from class stencyl.sw.ext.BaseExtension

disableMenu, doLongTask, enableMenu, extensionsReady, getAuthorName, getCategory, getClassname, getDescription, getDesignModeBlocks, getGameCenterName, getIcon, getID, getImageSaveRequest, getInternalVersion, getManifest, getMenuName, getName, getVersion, getWebsite, handlesImages, handlesSounds, hasOptions, hideProgressSpinner, isActive, isInGameCenter, isInMenu, isKitSpecific, isMenuItemInitiallyEnabled, onActivate, onDestroy, onGameBuild, onGameCenterActivate, onGameCreatedFromKit, onInstall, onOptions, onScreenCapture, onStartup, onUninstall, processImage, processSound, putProp, readBoolProp, readData, readDataAsBytes, readDoubleProp, readFloatProp, readIntProp, readStringProp, saveData, saveDataAsBytes, setActive, setAuthorName, setCategory, setDescription, setGameCenterCount, setGameCenterItem, setGameCenterName, setID, setInGameCenter, setInMenu, setInternalVersion, setManifest, setMenuItem, setMenuName, setMenuText, setName, setProgressMessage, setVersion, setWebsite, showInGameCenter, showMessageDialog, showOptions, showProgressSpinner, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

isInstalledForGame

protected boolean isInstalledForGame

extensionGameProperties

protected java.util.HashMap<java.lang.String,java.lang.Object> extensionGameProperties

Constructor Detail

GameExtension

public GameExtension()

Method Detail

getDataFolder

public java.io.File getDataFolder()

Returns:

A folder where extension data can be saved for the active game.

getExtrasFolder

public java.io.File getExtrasFolder()

Returns:

A folder inside the game's extras folder for saving runtime extension data.

readIntGameProp

protected int readIntGameProp(java.lang.String key,
                              int defaultValue)

Read an integer property for the active game.

Parameters:

key - Property name

defaultValue - Default value if the property doesn't exist

Returns:

The value of the property or defaultValue

readDoubleGameProp

protected double readDoubleGameProp(java.lang.String key,
                                    double defaultValue)

Read a double property for the active game.

Parameters:

key - Property name

defaultValue - Default value if the property doesn't exist

Returns:

The value of the property or defaultValue

readFloatGameProp

protected float readFloatGameProp(java.lang.String key,
                                  float defaultValue)

Read a float property for the active game.

Parameters:

key - Property name

defaultValue - Default value if the property doesn't exist

Returns:

The value of the property or defaultValue

readBoolGameProp

protected boolean readBoolGameProp(java.lang.String key,
                                   boolean defaultValue)

Read a boolean property for the active game.

Parameters:

key - Property name

defaultValue - Default value if the property doesn't exist

Returns:

The value of the property or defaultValue

readStringGameProp

protected java.lang.String readStringGameProp(java.lang.String key,
                                              java.lang.String defaultValue)

Read a string property for the active game.

Parameters:

key - Property name

defaultValue - Default value if the property doesn't exist

Returns:

The value of the property or defaultValue

putGameProp

protected void putGameProp(java.lang.String key,
                           java.lang.Object value)

Store a property for the active game. Properties are saved to the file system when the extension is installed or updated for a game and when the game is saved.

Parameters:

key - Property name

value - The value to store.

getVersionForGame

public int getVersionForGame(stencyl.core.lib.Game game)

Parameters:

game - The game to check

Returns:

The internalVersion of the extension last used for the game.

isInstalledForGame

public boolean isInstalledForGame(stencyl.core.lib.Game game)

Parameters:

game - The game to check

Returns:

Whether this extension is installed for the game

installForGame

public void installForGame()

Install this extension for the active game.

uninstallForGame

public void uninstallForGame()

Uninstall this extension for the active game

clearDataForGame

public void clearDataForGame(stencyl.core.lib.Game game)

Parameters:

game - Delete extension data for this game

onInstalledForGame

public abstract void onInstalledForGame()

onUninstalledForGame

public abstract void onUninstalledForGame()

onGameOpened

public final void onGameOpened(stencyl.core.lib.Game game)

Description copied from class: BaseExtension

Happens when a game is opened.

Specified by:

onGameOpened in class BaseExtension

Parameters:

game - The game that was opened.

onGameSave

public final void onGameSave(stencyl.core.lib.Game game)

Description copied from class: BaseExtension

Happens when a game is saved.

Specified by:

onGameSave in class BaseExtension

Parameters:

game - The game that was saved.

onGameClosed

public final void onGameClosed(stencyl.core.lib.Game game)

Description copied from class: BaseExtension

Happens when a game is closed.

Overrides:

onGameClosed in class BaseExtension

Parameters:

game - The game that was closed.

onGameWithDataOpened

public abstract void onGameWithDataOpened()

onGameWithDataSaved

public abstract void onGameWithDataSaved()

onGameWithDataClosed

public abstract void onGameWithDataClosed()

updateFromVersion

public abstract void updateFromVersion(int fromVersion)

Use this method to run scripts for updating data when the extension is updated.

Parameters:

fromVersion - Previous internalVersion of extension used with this game.

getGame

public stencyl.core.lib.Game getGame()

Returns:

The active game for this extension