From c36ed9f95e9ba1a2727656360263c73cd0911ca6 Mon Sep 17 00:00:00 2001 From: zepumph Date: Thu, 4 Oct 2018 11:55:53 -0800 Subject: [PATCH] rename tandem.isSuppliedAndEnabled to PhetioObject.isPhetioInstrumented, https://github.com/phetsims/tandem/issues/62 --- js/input/SimpleDragHandler.js | 2 +- js/listeners/DragListener.js | 2 +- js/listeners/PressListener.js | 6 +++--- js/nodes/NodeIO.js | 6 +++--- js/nodes/RichTextIO.js | 2 +- js/nodes/TextIO.js | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/js/input/SimpleDragHandler.js b/js/input/SimpleDragHandler.js index d2d3769e4..ebd376c0b 100644 --- a/js/input/SimpleDragHandler.js +++ b/js/input/SimpleDragHandler.js @@ -69,7 +69,7 @@ define( function( require ) { phetioReadOnly: true, phetioState: false, tandem: options.tandem.createTandem( 'isDraggingProperty' ), - phetioInstanceDocumentation: 'Indicates whether the object is dragging' + phetioDocumentation: 'Indicates whether the object is dragging' } ); this.pointer = null; // the pointer doing the current dragging diff --git a/js/listeners/DragListener.js b/js/listeners/DragListener.js index 2833671fd..91e42ce0f 100644 --- a/js/listeners/DragListener.js +++ b/js/listeners/DragListener.js @@ -193,7 +193,7 @@ define( function( require ) { // @private {Emitter} - emitted on drag. Used for triggering phet-io events, see https://github.com/phetsims/scenery/issues/842 this._draggedEmitter = new Emitter( { tandem: options.tandem.createTandem( 'draggedEmitter' ), - phetioInstanceDocumentation: 'Emits whenever a drag occurs with an EventIO argument.', + phetioDocumentation: 'Emits whenever a drag occurs with an EventIO argument.', phetioReadOnly: options.phetioReadOnly, phetioEventType: 'user', phetioType: EmitterIO( [ EventIO ] ) diff --git a/js/listeners/PressListener.js b/js/listeners/PressListener.js index 10c5ea283..88730c458 100644 --- a/js/listeners/PressListener.js +++ b/js/listeners/PressListener.js @@ -272,8 +272,8 @@ define( function( require ) { // @private {Emitter} - emitted on press event this._pressedEmitter = new Emitter( { tandem: options.tandem.createTandem( 'pressedEmitter' ), - phetioInstanceDocumentation: 'Emits whenever a press occurs. The first argument when emitting can be ' + - 'used to convey info about the Event.', + phetioDocumentation: 'Emits whenever a press occurs. The first argument when emitting can be ' + + 'used to convey info about the Event.', phetioReadOnly: options.phetioReadOnly, phetioEventType: 'user', phetioType: EmitterIO( [ EventIO, VoidIO, VoidIO ] ) @@ -305,7 +305,7 @@ define( function( require ) { // @private - emitted on release event this._releasedEmitter = new Emitter( { tandem: options.tandem.createTandem( 'releasedEmitter' ), - phetioInstanceDocumentation: 'Emits whenever a release occurs.', + phetioDocumentation: 'Emits whenever a release occurs.', phetioReadOnly: options.phetioReadOnly, phetioEventType: 'user', phetioType: EmitterIO( [ VoidIO ] ) diff --git a/js/nodes/NodeIO.js b/js/nodes/NodeIO.js index ccd1a8840..bdd7e16f2 100644 --- a/js/nodes/NodeIO.js +++ b/js/nodes/NodeIO.js @@ -41,7 +41,7 @@ define( function( require ) { phetioType: PropertyIO( BooleanIO ), tandem: node.tandem.createTandem( 'visibleProperty' ), - phetioInstanceDocumentation: 'Controls whether the Node will be visible (and interactive), see the NodeIO documentation for more details.' + phetioDocumentation: 'Controls whether the Node will be visible (and interactive), see the NodeIO documentation for more details.' } ); var pickableProperty = new NodeProperty( node, 'pickability', 'pickable', { @@ -52,7 +52,7 @@ define( function( require ) { tandem: node.tandem.createTandem( 'pickableProperty' ), phetioType: PropertyIO( NullableIO( BooleanIO ) ), - phetioInstanceDocumentation: 'Sets whether the node will be pickable (and hence interactive), see the NodeIO documentation for more details' + phetioDocumentation: 'Sets whether the node will be pickable (and hence interactive), see the NodeIO documentation for more details' } ); // Adapter for the opacity. Cannot use NodeProperty at the moment because it doesn't handle numeric types @@ -65,7 +65,7 @@ define( function( require ) { tandem: node.tandem.createTandem( 'opacityProperty' ), range: { min: 0, max: 1 }, - phetioInstanceDocumentation: 'Opacity of the parent NodeIO, between 0 (invisible) and 1 (fully visible)' + phetioDocumentation: 'Opacity of the parent NodeIO, between 0 (invisible) and 1 (fully visible)' } ); opacityProperty.link( function( opacity ) { node.opacity = opacity; } ); node.on( 'opacity', function() { opacityProperty.value = node.opacity; } ); diff --git a/js/nodes/RichTextIO.js b/js/nodes/RichTextIO.js index 4e1210fcd..b9a3e8c90 100644 --- a/js/nodes/RichTextIO.js +++ b/js/nodes/RichTextIO.js @@ -38,7 +38,7 @@ define( function( require ) { phetioType: PropertyIO( StringIO ), tandem: richText.tandem.createTandem( 'textProperty' ), - phetioInstanceDocumentation: 'Property for the displayed text' + phetioDocumentation: 'Property for the displayed text' } ); // @private diff --git a/js/nodes/TextIO.js b/js/nodes/TextIO.js index a4162b6f2..895428f98 100644 --- a/js/nodes/TextIO.js +++ b/js/nodes/TextIO.js @@ -41,7 +41,7 @@ define( function( require ) { phetioType: PropertyIO( StringIO ), tandem: text.tandem.createTandem( 'textProperty' ), - phetioInstanceDocumentation: 'Property for the displayed text' + phetioDocumentation: 'Property for the displayed text' } ); // @private