DialogueEditorHelpers
| Kind | class |
| Package | editors.helpers |
| Full name | editors.helpers.DialogueEditorHelpers |
| Source | source/editors/helpers/DialogueEditorHelpers.hx |
| Metadata | @:access(editors.DialogueCharacterEditorState) @:access(editors.DialogueEditorState) |
Public methods
jsonStringify
static function jsonStringify(data:Dynamic):String
---- Pure shared: JSON stringify (dialogue save) ----
| Parameter | Type | Default |
|---|---|---|
data | Dynamic | — |
readRawJson
static function readRawJson(path:String):String
---- Pure shared: read raw json file content ----
| Parameter | Type | Default |
|---|---|---|
path | String | — |
browseForJsonFile
static function browseForJsonFile(file:FileReference, onLoadComplete:Dynamic->Void, onLoadCancel:Dynamic->Void, onLoadError:Dynamic->Void):Void
---- Shared: set up a FileReference browse dialog for a JSON file ----
| Parameter | Type | Default |
|---|---|---|
file | FileReference | — |
onLoadComplete | Dynamic->Void, onLoadCancel:Dynamic->Void, onLoadError:Dynamic->Void | — |
saveJsonFile
static function saveJsonFile(file:FileReference, data:String, fileName:String, onComplete:Dynamic->Void, onCancel:Dynamic->Void, onError:Dynamic->Void):Void
---- Shared: save a JSON string through a FileReference dialog ----
| Parameter | Type | Default |
|---|---|---|
file | FileReference | — |
data | String | — |
fileName | String | — |
onComplete | Dynamic->Void, onCancel:Dynamic->Void, onError:Dynamic->Void | — |
cancelLoadFile
static function cancelLoadFile(file:FileReference, onLoadComplete:Dynamic->Void, onLoadCancel:Dynamic->Void, onLoadError:Dynamic->Void):Void
---- Shared: remove load listeners + cancel trace ----
| Parameter | Type | Default |
|---|---|---|
file | FileReference | — |
onLoadComplete | Dynamic->Void, onLoadCancel:Dynamic->Void, onLoadError:Dynamic->Void | — |
failLoadFile
static function failLoadFile(file:FileReference, onLoadComplete:Dynamic->Void, onLoadCancel:Dynamic->Void, onLoadError:Dynamic->Void):Void
---- Shared: remove load listeners + load error trace ----
| Parameter | Type | Default |
|---|---|---|
file | FileReference | — |
onLoadComplete | Dynamic->Void, onLoadCancel:Dynamic->Void, onLoadError:Dynamic->Void | — |
completeSaveFile
static function completeSaveFile(file:FileReference, onComplete:Dynamic->Void, onCancel:Dynamic->Void, onError:Dynamic->Void):Void
---- Shared: remove save listeners + success notice ----
| Parameter | Type | Default |
|---|---|---|
file | FileReference | — |
onComplete | Dynamic->Void, onCancel:Dynamic->Void, onError:Dynamic->Void | — |
cancelSaveFile
static function cancelSaveFile(file:FileReference, onComplete:Dynamic->Void, onCancel:Dynamic->Void, onError:Dynamic->Void):Void
---- Shared: remove save listeners (cancelled, no message) ----
| Parameter | Type | Default |
|---|---|---|
file | FileReference | — |
onComplete | Dynamic->Void, onCancel:Dynamic->Void, onError:Dynamic->Void | — |
failSaveFile
static function failSaveFile(file:FileReference, onComplete:Dynamic->Void, onCancel:Dynamic->Void, onError:Dynamic->Void):Void
---- Shared: remove save listeners + save error ----
| Parameter | Type | Default |
|---|---|---|
file | FileReference | — |
onComplete | Dynamic->Void, onCancel:Dynamic->Void, onError:Dynamic->Void | — |
onLoadCompleteCharacter
static function onLoadCompleteCharacter(state:DialogueCharacterEditorState):Void
---- per-file: onLoadComplete for editors.DialogueCharacterEditorState ----
| Parameter | Type | Default |
|---|---|---|
state | DialogueCharacterEditorState | — |
onLoadCompleteDialogue
static function onLoadCompleteDialogue(state:DialogueEditorState):Void
---- per-file: onLoadComplete for editors.DialogueEditorState ----
| Parameter | Type | Default |
|---|---|---|
state | DialogueEditorState | — |