Files
JiboOs/docs/deprecation.js
2026-03-16 13:53:01 +02:00

573 lines
16 KiB
JavaScript

/**
* @class
* @name SerialTimer
* @memberof jibo.utils
* @see jibo.utils.perf.SerialTimer
* @deprecated since version 2.1.0
* @private
*/
/**
* @class
* @name ParallelTimer
* @memberof jibo.utils
* @see jibo.utils.perf.ParallelTimer
* @deprecated since version 2.1.0
* @private
*/
/**
* @name jibo.bodySettings
* @deprecated since 1.1.0
* @see jibo.settings
*/
/**
* @name jibo.body
* @deprecated since 4.2.6
* @see jibo.settings
*/
/**
* @name jibo.audio
* @deprecated since 4.2.6
* @see jibo.settings
*/
/**
* Gets the base directory and the name of the project.
* @method jibo.utils.PathUtils~getBaseDirectory
* @deprecated since 3.1.0
* @see jibo.utils.PathUtils#findRoot
*/
/**
* Gets the project root running jibo.
* @method jibo.utils.PathUtils~getProjectRoot
* @deprecated since 3.1.0
* @see jibo.utils.PathUtils#findRoot
*/
/** Load a list of nodes by id. All KBs in this Model will be
* searched, in order, for each id in the array. An empty array is
* returned (via callback) if none of the ids are found. If
* callback is omitted a promise is returned instead.
*
* @method jibo.kb.Model#loadList
* @memberof jibo.kb
* @see jibo.kb.Model#load
* @deprecated since version 6.0.0
*/
/** Fetch a list of nodes by id from cache synchronously. Use on
* models created with `begin()` and preloaded with nodes.
*
* @method jibo.kb.Model#fetchList
* @memberof jibo.kb
* @see jibo.kb.Model#fetch
* @deprecated since version 6.0.0
*/
/**
* @name jibo.bt.factory
* @deprecated since 1.1.0
* @see jibo.bt
*/
/**
* Current status of the behavior tree.
* @type {String}
* @name jibo.bt.BehaviorTree~status
* @deprecated since 4.0.0
* @see jibo.bt.BehaviorTree#currentStatus
*/
/**
* Same constant as `ViewManager.TRANS_UP`, made accessible via `jibo.face.views` for convenience
* @method jibo.rendering.gui.ViewManager#UP
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.UP
*/
/**
* Same constant as `ViewManager.TRANS_DOWN`, made accessible via `jibo.face.views` for convenience
* @method jibo.rendering.gui.ViewManager#DOWN
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.DOWN
*/
/**
* Same constant as `ViewManager.TRANS_RIGHT`, made accessible via `jibo.face.views` for convenience
* @method jibo.rendering.gui.ViewManager#RIGHT
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.RIGHT
*/
/**
* Same constant as `ViewManager.TRANS_LEFT`, made accessible via `jibo.face.views` for convenience
* @method jibo.rendering.gui.ViewManager#LEFT
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.LEFT
*/
/**
* Same constant as `ViewManager.TRANS_IN`, made accessible via `jibo.face.views` for convenience
* @method jibo.rendering.gui.ViewManager#IN
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.IN
*/
/**
* Same constant as `ViewManager.TRANS_OUT`, made accessible via `jibo.face.views` for convenience
* @method jibo.rendering.gui.ViewManager#OUT
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.OUT
*/
/**
* Same constant as `ViewManager.TRANS_NONE`, made accessible via `jibo.face.views` for convenience
* @method jibo.rendering.gui.ViewManager#NONE
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.NONE
*/
/**
* Transition type for view components to move upwards.
* @method jibo.rendering.gui.ViewManager~TRANS_UP
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.UP
*/
/**
* Transition type for view components to move downwards.
* @method jibo.rendering.gui.ViewManager~TRANS_DOWN
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.DOWN
*/
/**
* Transition type for view to move right.
* @method jibo.rendering.gui.ViewManager~TRANS_RIGHT
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.RIGHT
*/
/**
* Transition type for view to move left.
* @method jibo.rendering.gui.ViewManager~TRANS_LEFT
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.LEFT
*/
/**
* Transition type for view to fade and scale in from center of screen.
* @method jibo.rendering.gui.ViewManager~TRANS_IN
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.IN
*/
/**
* Transition type for view to or from eye.
* Use in conjunction with custom View transitions.
* @method jibo.rendering.gui.ViewManager~TRANS_EYE
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.EYE
*/
/**
* Transition type for view to fade and scale out from center of screens.
* @method jibo.rendering.gui.ViewManager~TRANS_OUT
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.OUT
*/
/**
* Transition type for no transition.
* @method jibo.rendering.gui.ViewManager~TRANS_NONE
* @deprecated since 7.8.4
* @see jibo.face.views.TRANSITION.NONE
*/
/**
* Transition type for no transition.
* @method jibo.rendering.gui.ViewManager~NONE
* @deprecated since 4.1.0
* @see jibo.face.views#NONE
*/
/**
* View status triggered once view's init method has been called.
* The same constant is statically accessible via `STATE.INITIALIZED`.
* @name jibo.face.views#INITIALIZED
* @deprecated since 8.1.0
* @see jibo.face.views.STATE.INITIALIZED
*/
/**
* View status triggered once initial data has been loaded and configurations set.
* The same constant is statically accessible via `STATE.DATA_LOADED`.
* @name jibo.face.views#DATA_LOADED
* @deprecated since 8.1.0
* @see jibo.face.views.STATE.DATA_LOADED
*/
/**
* View status triggered once initial assets have been loaded.
* The same constant is statically accessible via `STATE.ASSETS_LOADED`.
* @name jibo.face.views#ASSETS_LOADED
* @deprecated since 8.1.0
* @see jibo.face.views.STATE.ASSETS_LOADED
*/
/**
* View status triggered once loading is complete, at point of dispatch View should be ready for use.
* The same constant is statically accessible via `STATE.LOADED`.
* @name jibo.face.views#LOADED
* @deprecated since 8.1.0
* @see jibo.face.views.STATE.LOADED
*/
/**
* View status triggered once View has completed its opening transition.
* The same constant is statically accessible via `STATE.OPENED`.
* @name jibo.face.views#OPENED
* @deprecated since 8.1.0
* @see jibo.face.views.STATE.OPENED
*/
/**
* View status triggered once View has completed its closing transition.
* The same constant is statically accessible via `STATE.CLOSED`.
* @name jibo.face.views#CLOSED
* @deprecated since 8.1.0
* @see jibo.face.views.STATE.CLOSED
*/
/**
* Category for views that contain an interactive user interface.
* The same constant is statically accessible via `CATEGORY.GUI`.
* @name jibo.face.views#CATEGORY_GUI
* @deprecated since 8.1.0
* @see jibo.face.views.CATEGORY.GUI
*/
/**
* Category for views that are primarily used for display and not for interaction.
* The same constant is statically accessible via `CATEGORY.DISPLAY`.
* @name jibo.face.views#CATEGORY_DISPLAY
* @deprecated since 8.1.0
* @see jibo.face.views.CATEGORY.DISPLAY
*/
/**
* Category for EyeView type views.
* The same constant is statically accessible via `CATEGORY.EYE`.
* @name jibo.face.views#CATEGORY_EYE
* @deprecated since 8.1.0
* @see jibo.face.views.CATEGORY.EYE
*/
/**
* Tap gesture type.
* The same constant is statically accessible via `GESTURE.TAP`.
* @name jibo.face.views.TAP
* @deprecated since 8.1.0
* @see jibo.face.views.GESTURE.TAP
*/
/**
* Swipe down gesture type.
* Swipes currently only works for Views.
* The same constant is statically accessible via `GESTURE.SWIPE_DOWN`.
* @name jibo.face.views.SWIPE
* @deprecated since 8.1.0
* @see jibo.face.views.GESTURE.SWIPE_DOWN
*/
/**
* Option for setting custom transitions.
* Use with `View.setTransitions` to define custom transitions for adding a View to the view stack.
* @type {number}
* @name jibo.face.views.STACK_ADD
* @deprecated since 8.1.0
* @see jibo.face.views~STACK_DIRECTION
*/
/**
* Option for setting custom transitions.
* Use with `View.addTransition` to define custom transitions for removing a View from the view stack
* @type {number}
* @name jibo.face.views.STACK_REMOVE
* @deprecated since 8.1.0
* @see jibo.face.views~STACK_DIRECTION
*/
/**
* Option for setting custom transitions.
* Use with `View.addTransition` to define custom transitions where views are swapped,
* this would be when the currentvIew is removed and a new one is added so that the view stack length remians unchanged.
* @type {number}
* @name jibo.face.views.STACK_SWAP
* @deprecated since 8.1.0
* @see jibo.face.views~STACK_DIRECTION
*/
/**
* Close all currently active views and open the 'root' view (EyeView).
* @method jibo.face.views#closeAll
* @deprecated 4.1.0
* @see jibo.face.views#removeAll
*/
/**
* Close all currently active views up to the root, then add View.
* @method jibo.face.views#closeAllThenAdd
* @deprecated since 4.1.0
* @see jibo.face.views#removeAllThenAdd
*/
/**
* Close all currently active views up to the root view but do not open the root view, instead leave an empty screen.
* @method jibo.face.views#closeAllLeaveEmpty
* @deprecated since 4.1.0
* @see jibo.face.views#removeAllLeaveEmpty
*/
/**
* Remove the currently displayed View, but do not open the view beneath so that the display is left empty.
* Use when you don't know what the next view will be (i.e. switching skills).
* If current view paused the previous view, proceed as if removeView has been called
* @method jibo.face.views#removeViewLeaveEmpty
* @deprecated since 5.0.0
* @see jibo.face.views#changeView
*/
/**
* Close all currently active views up to the root, then add {@link jibo.face.views.View}.
* The newly added view will be one above the root once opened.ed
* @method jibo.face.views#removeAllThenAdd
* @deprecated since 5.0.0
* @see jibo.face.views#changeView
*/
/**
* Close all currently active views up to root view. Do not open root; leave screen empty.
* Use when next view is unknown, i.e.switching between skills.
* @method jibo.face.views#removeAllLeaveEmpty
* @deprecated since 5.0.0
* @see jibo.face.views#changeView
*/
/**
* Close all currently active views and open the 'root' view ({@link jibo.face.views.EyeView}).
* @method jibo.face.views#removeAll
* @deprecated since 5.0.0
* @see jibo.face.views#changeView
*/
/**
* Tap gesture type.
* @name jibo.face.views.TouchManager.TAP
* @deprecated since 8.1.0
* @see jibo.face.views.GESTURE.TAP
*/
/**
* Swipe down gesture type.
* @name jibo.face.views.TouchManager.SWIPE
* @deprecated since 8.1.0
* @see jibo.face.views.GESTURE.SWIPE_DOWN
*/
/**
* Pan horizontal gesture type.
* @name jibo.face.views.TouchManager.PAN
* @deprecated since 8.1.0
* @see jibo.face.views.GESTURE.PAN
*/
/**
* Setup View to trigger its actions list when the hitArea ia clicked.
* @method jibo.face.views#setupScreenClick
* @deprecated since 5.5.2
* @see jibo.face.views.View#setupScreenClick
*/
/**
* Intialize the data.
* @method jibo.face.views.View~INITIALIZED
* @deprecated since 8.1.0
* @see jibo.face.views~STATE.INITIALIZED
*/
/**
* State set and emitted once initial data has been loaded and configurations set.
* @method jibo.face.views.View~DATA_LOADED
* @deprecated since 8.1.0
* @see jibo.face.views~STATE.DATA_LOADED
*/
/**
* State set and emitted once initial assets have been loaded.
* @method jibo.face.views.View~ASSETS_LOADED
* @deprecated since 8.1.0
* @see jibo.face.views~STATE.ASSETS_LOADED
*/
/**
* State set and emitted once loading is complete, at point of dispatch View should be ready for use.
* @method jibo.face.views.View~LOADED
* @deprecated since 8.1.0
* @see jibo.face.views~STATE.LOADED
*/
/**
* State set and emitted once View has completed its opening transition.
* @method jibo.face.views.View~OPENED
* @deprecated since 8.1.0
* @see jibo.face.views~STATE.OPENED
*/
/**
* State set and emitted once View has completed its closing transition.
* @method jibo.face.views.View~CLOSED
* @deprecated since 8.1.0
* @see jibo.face.views~STATE.CLOSED
*/
/**
* State set and emitted View has been destroyed.
* @method jibo.face.views.View~DESTROYED
* @deprecated since 8.1.0
* @see jibo.face.views~STATE.DESTROYED
*/
/**
* Event emitted if there is a load error.
* @method jibo.face.views.View~LOAD_ERROR
* @deprecated since 8.1.0
* @see jibo.face.views~STATE.LOAD_ERROR
*/
/**
* Category for views that contain an interactive user interface.
* @name jibo.face.views.View.CATEGORY_GUI
* @deprecated since 8.1.0
* @see jibo.face.views~CATEGORY.GUI
*/
/**
* Category for views that are primarily used for display and not for interfacing.
* @name jibo.face.views.View.CATEGORY_DISPLAY
* @deprecated since 8.1.0
* @see jibo.face.views~CATEGORY.DISPLAY
*/
/**
* Category for EyeView type views.
* @name jibo.face.views.View.CATEGORY_EYE
* @deprecated since 8.1.0
* @see jibo.face.views~CATEGORY.EYE
*/
/**
* @method
* @name jibo.bt~addBehavior
* @deprecated since 0.10.0
* @see jibo.bt#register
*/
/**
* Creates a behavior.
* @method
* @name jibo.bt~createBehavior
* @see jibo.bt#register
* @deprecated since 0.10.0
*/
/**
* Creates a decorator.
* @method
* @name jibo.bt~createDecorator
* @see jibo.bt#register
* @deprecated since 0.10.0
*/
/**
* @method
* @name jibo.bt~registerBehavior
* @deprecated since 1.1.0
* @see jibo.bt#register
*/
/**
* @method
* @name jibo.bt~registerDecorator
* @deprecated since 1.1.0
* @see jibo.bt#register
*/
/**
* Creates a behavior.
* @method
* @name jibo.bt.Behavior~setDecorators
* @deprecated since 1.1.0
* @see jibo.bt.Behavior#decorators
*/
/**
* Creates a behavior.
* @method
* @name jibo.bt.Behavior~getName
* @deprecated since 1.1.0
* @see jibo.bt.Behavior#name
*/
/**
* Creates a behavior.
* @method
* @name jibo.bt.ParentBehavior~setChildren
* @deprecated since 1.1.0
* @see jibo.bt.ParentBehavior#children
*/
/**
* @class
* @name AudioUtils
* @memberof jibo.utils
* @deprecated Since 3.0.0
*/
/**
* Creates and returns correct full audio path from given file; takes into account asset packs, etc.
* @method jibo.utils.AudioUtils~getPath
* @deprecated Since 3.0.0
*/
/**
* Creates a new "Audio" stream based on given audio path and project uri; returns the audio object.
* @method jibo.utils.AudioUtils~startAudio
* @deprecated Since 3.0.0
*/
/**
* @method jibo.media~getUrlById
* @deprecated Since 5.8.2
* @see jibo.media#getUrl
*/
/**
*
* Stop jibo using voice commands.
* @name jibo.globalEvents#stop
* @deprecated since 6.0.4
* @see jibo.globalEvents#voiceStop
*/
/**
*
* Stop jibo using touch commands
* @name jibo.globalEvents#touchOn
* @deprecated since 6.0.4
* @see jibo.globalEvents#touchStop
*/