ScriptDiscoveryService

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

Properties

Name Type Summary
debugScriptUrl string
defaultScriptsPath string
scriptsModel ScriptsModel
scriptsModelFilter ScriptsModelFilter

Methods

Name Return Value Summary
getLocal Array.<object>
getPublic Array.<object>
getRunning Array.<object>
loadOneScript None
loadScript boolean
onClearDebugWindow None
onErrorLoadingScript None
onErrorMessage None
onInfoMessage None
onPrintedMessage None
onScriptFinished None
onWarningMessage None
reloadAllScripts None
stopAllScripts None
stopScript boolean

Signals

Name Summary
clearDebugWindow
errorLoadingScript
errorMessage
infoMessage
printedMessage
scriptCountChanged
scriptLoadError
scriptsReloading
warningMessage

Method Details

(static) getLocal( ) → {Array.<object>}
Returns: Array.<object>

(static) getPublic( ) → {Array.<object>}
Returns: Array.<object>

(static) getRunning( ) → {Array.<object>}
Returns: Array.<object>

(static) loadOneScript( filename )

Parameters

Name Type Description
filename string
(static) loadScript( filenameopt, isUserLoadedopt, loadScriptFromEditoropt, activateMainWindowopt, reloadopt, quitWhenFinishedopt ) → {boolean}
Returns: boolean

Parameters

Name Type Attributes Default Value Description
filename string <optional>
""
isUserLoaded boolean <optional>
true
loadScriptFromEditor boolean <optional>
false
activateMainWindow boolean <optional>
false
reload boolean <optional>
false
quitWhenFinished boolean <optional>
false
(static) onClearDebugWindow( )

(static) onErrorLoadingScript( url )

Parameters

Name Type Description
url string
(static) onErrorMessage( message, scriptName )

Parameters

Name Type Description
message string
scriptName string
(static) onInfoMessage( message, scriptName )

Parameters

Name Type Description
message string
scriptName string
(static) onPrintedMessage( message, scriptName )

Parameters

Name Type Description
message string
scriptName string
(static) onScriptFinished( filename, engine )

Parameters

Name Type Description
filename string
engine object
(static) onWarningMessage( message, scriptName )

Parameters

Name Type Description
message string
scriptName string
(static) reloadAllScripts( )

(static) stopAllScripts( restartopt )

Parameters

Name Type Attributes Default Value Description
restart boolean <optional>
false
(static) stopScript( scriptHash, restartopt ) → {boolean}
Returns: boolean

Parameters

Name Type Attributes Default Value Description
scriptHash string
restart boolean <optional>
false

Signal Details

clearDebugWindow( )
Returns: Signal

 

errorLoadingScript( url )
Returns: Signal

 

Parameters

Name Type Description
url string
errorMessage( message, engineName )
Returns: Signal

 

Parameters

Name Type Description
message string
engineName string
infoMessage( message, engineName )
Returns: Signal

 

Parameters

Name Type Description
message string
engineName string
printedMessage( message, engineName )
Returns: Signal

 

Parameters

Name Type Description
message string
engineName string
scriptCountChanged( )
Returns: Signal

 

scriptLoadError( filename, error )
Returns: Signal

 

Parameters

Name Type Description
filename string
error string
scriptsReloading( )
Returns: Signal

 

warningMessage( message, engineName )
Returns: Signal

 

Parameters

Name Type Description
message string
engineName string