mirror of
https://github.com/photonstorm/phaser
synced 2025-02-25 20:07:08 +00:00
Added jsdocs for TS defs export
This commit is contained in:
Richard Davey
parent
eca3c09df1
commit
c1e5aa72ef
2 changed files with 224 additions and 1 deletions
|
|
@ -32,6 +32,226 @@ var Scene = new Class({
|
|||
* @since 3.0.0
|
||||
*/
|
||||
this.sys = new Systems(this, config);
|
||||
|
||||
/**
|
||||
* A reference to the Phaser.Game instance.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#game
|
||||
* @type {Phaser.Game}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.game;
|
||||
|
||||
/**
|
||||
* A reference to the global Animation Manager.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#anims
|
||||
* @type {Phaser.Animations.AnimationManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.anims;
|
||||
|
||||
/**
|
||||
* A reference to the global Cache.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#cache
|
||||
* @type {Phaser.Cache.CacheManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.cache;
|
||||
|
||||
/**
|
||||
* A reference to the game level Data Manager.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#registry
|
||||
* @type {Phaser.Data.DataManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.registry;
|
||||
|
||||
/**
|
||||
* A reference to the Sound Manager.
|
||||
* This property will only be available if defined in the Scene Injection Map and the plugin is installed.
|
||||
*
|
||||
* @name Phaser.Scene#sound
|
||||
* @type {Phaser.Sound.BaseSoundManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.sound;
|
||||
|
||||
/**
|
||||
* A reference to the Texture Manager.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#textures
|
||||
* @type {Phaser.Textures.TextureManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.textures;
|
||||
|
||||
/**
|
||||
* A scene level Event Emitter.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#events
|
||||
* @type {Phaser.Events.EventEmitter}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.events;
|
||||
|
||||
/**
|
||||
* A scene level Camera System.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#cameras
|
||||
* @type {Phaser.Cameras.Scene2D.CameraManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.cameras;
|
||||
|
||||
/**
|
||||
* A scene level 3D Camera System.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#cameras3d
|
||||
* @type {Phaser.Cameras.Sprite3D.CameraManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.cameras3d;
|
||||
|
||||
/**
|
||||
* A scene level Game Object Factory.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#add
|
||||
* @type {Phaser.GameObjects.GameObjectFactory}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.add;
|
||||
|
||||
/**
|
||||
* A scene level Game Object Creator.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#make
|
||||
* @type {Phaser.GameObjects.GameObjectCreator}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.make;
|
||||
|
||||
/**
|
||||
* A reference to the Scene Manager Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#scene
|
||||
* @type {Phaser.Scenes.ScenePlugin}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.scene;
|
||||
|
||||
/**
|
||||
* A scene level Game Object Display List.
|
||||
* This property will only be available if defined in the Scene Injection Map.
|
||||
*
|
||||
* @name Phaser.Scene#children
|
||||
* @type {Phaser.GameObjects.DisplayList}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.children;
|
||||
|
||||
/**
|
||||
* A scene level Lights Manager Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map and the plugin is installed.
|
||||
*
|
||||
* @name Phaser.Scene#lights
|
||||
* @type {Phaser.GameObjects.DisplayList}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.lights;
|
||||
|
||||
/**
|
||||
* A scene level Data Manager Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map and the plugin is installed.
|
||||
*
|
||||
* @name Phaser.Scene#data
|
||||
* @type {Phaser.Data.DataManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.data;
|
||||
|
||||
/**
|
||||
* A scene level Input Manager Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map and the plugin is installed.
|
||||
*
|
||||
* @name Phaser.Scene#input
|
||||
* @type {Phaser.Input.InputPlugin}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.input;
|
||||
|
||||
/**
|
||||
* A scene level Loader Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map and the plugin is installed.
|
||||
*
|
||||
* @name Phaser.Scene#load
|
||||
* @type {Phaser.Loader.LoadPlugin}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.load;
|
||||
|
||||
/**
|
||||
* A scene level Time and Clock Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map and the plugin is installed.
|
||||
*
|
||||
* @name Phaser.Scene#time
|
||||
* @type {Phaser.Time.Clock}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.time;
|
||||
|
||||
/**
|
||||
* A scene level Tween Manager Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map and the plugin is installed.
|
||||
*
|
||||
* @name Phaser.Scene#tweens
|
||||
* @type {Phaser.Tweens.TweenManager}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.tweens;
|
||||
|
||||
/**
|
||||
* A scene level Arcade Physics Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.
|
||||
*
|
||||
* @name Phaser.Scene#physics
|
||||
* @type {Phaser.Physics.Arcade.ArcadePhysics}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.physics;
|
||||
|
||||
/**
|
||||
* A scene level Impact Physics Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.
|
||||
*
|
||||
* @name Phaser.Scene#impact
|
||||
* @type {Phaser.Physics.Impact.ImpactPhysics}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.impact;
|
||||
|
||||
/**
|
||||
* A scene level Matter Physics Plugin.
|
||||
* This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.
|
||||
*
|
||||
* @name Phaser.Scene#matter
|
||||
* @type {Phaser.Physics.Matter.MatterPhysics}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.matter;
|
||||
},
|
||||
|
||||
/**
|
||||
|
|
@ -40,6 +260,9 @@ var Scene = new Class({
|
|||
* @method Phaser.Scene#update
|
||||
* @override
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {number} time - [description]
|
||||
* @param {number} delta - [description]
|
||||
*/
|
||||
update: function ()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -167,7 +167,7 @@ var Systems = new Class({
|
|||
* [description]
|
||||
*
|
||||
* @name Phaser.Scenes.Systems#displayList
|
||||
* @type {null}
|
||||
* @type {Phaser.GameObjects.DisplayList}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.displayList;
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue