funkin.backend.scripting.DummyScript - Codename Engine API

Simple class for empty scripts or scripts whose language isn't imported yet.

Constructor

`new(path:String)`

Variables

`variables:Map<String, Dynamic> = []`

Methods

Inherited Variables

Defined by Script

`extension:String`

Script Extension

`fileName:String`

Script name (with extension)

`path:String = null`

Path to the script.

`remappedNames:Map<String, String> = []`

Remapped filenames. Used for trace messages, to show what mod the script is from.

Inherited Methods

Defined by Script

`call(func:String, ?parameters:Array<Dynamic>):Dynamic`

Calls the function func defined in the script.

Parameters:

`func`	Name of the function
`parameters`	(Optional) Parameters of the function.

Returns:

Result (if void, then null)

`error(text:String, ?additionalInfo:Dynamic):Void`

Shows an error from this script.

Parameters:

`text`	Text of the error (ex: Null Object Reference).
`additionalInfo`	Additional information you could provide.

`load():Void`

Loads the script

`loadFromString(code:String):Script`

Loads the code from a string, doesn't really work after the script has been loaded

Parameters:

`code`	The code.

`onCreate(path:String):Void`

Called when the script is created.

Parameters:

`path`	Path to the script

`onLoad():Void`

Called when the script is loaded.

`reload():Void`

Hot-reloads the script, if possible

`setParent(variable:Dynamic):Void`

Sets a script's parent object so that its properties can be accessed easily. Ex: Passing PlayState.instance will allow boyfriend to be typed instead of PlayState.instance.boyfriend.

Parameters:

`variable`	Parent variable.

`setPublicMap(map:Map<String, Dynamic>):Void`

HSCRIPT ONLY FOR NOW Sets the "public" variables map for ScriptPack

`trace(v:Dynamic):Void`

Traces something as this script.