# PlayCanvas Editor API

> The API reference of `@playcanvas/editor-api` 1.1.28: the classes and types for automating and extending the PlayCanvas Editor from its browser console or user scripts. The API is in beta.

Each link leads to a Markdown page with the symbol's signatures, parameters and examples. In the Editor, the API is reached through the global `editor.api.globals`. For guides, see the [Editor index](https://developer.playcanvas.com/user-manual/editor/llms.txt) of the User Manual.

## Classes

- [Asset](https://api.playcanvas.com/editor/classes/Asset.md): The Asset class represents an asset in Editor.
- [Assets](https://api.playcanvas.com/editor/classes/Assets.md): The Assets Editor API
- [AssetsSchema](https://api.playcanvas.com/editor/classes/AssetsSchema.md): Provides methods to access the Assets schema
- [ComponentSchema](https://api.playcanvas.com/editor/classes/ComponentSchema.md): Provides methods to access the components schema
- [Entities](https://api.playcanvas.com/editor/classes/Entities.md): The entities editor API
- [Entity](https://api.playcanvas.com/editor/classes/Entity.md): The Entity class represents an entity in the Editor.
- [globals](https://api.playcanvas.com/editor/classes/globals.md): Global variables
- [History](https://api.playcanvas.com/editor/classes/History.md): The history API responsible for undo / redo.
- [SceneSchema](https://api.playcanvas.com/editor/classes/SceneSchema.md): Provides methods to access the render schema
- [SceneSettings](https://api.playcanvas.com/editor/classes/SceneSettings.md): The Scene Settings API provides access to the settings of the currently loaded scene.
- [Schema](https://api.playcanvas.com/editor/classes/Schema.md): Provides methods to access the Editor schema.
- [Selection](https://api.playcanvas.com/editor/classes/Selection.md): Selection API.
- [SelectionHistory](https://api.playcanvas.com/editor/classes/SelectionHistory.md): Enables undo / redo of selection changes
- [Settings](https://api.playcanvas.com/editor/classes/Settings.md): The settings for the Editor.
- [SettingsSchema](https://api.playcanvas.com/editor/classes/SettingsSchema.md): Provides methods to access the settings schema

## Type aliases

- [AnimationAssetData](https://api.playcanvas.com/editor/types/AnimationAssetData.md): Represents the data for an Animation asset.
- [AnimationComponent](https://api.playcanvas.com/editor/types/AnimationComponent.md): Animation Component Properties.
- [AnimComponent](https://api.playcanvas.com/editor/types/AnimComponent.md): Anim Component Properties.
- [AnimstategraphAssetData](https://api.playcanvas.com/editor/types/AnimstategraphAssetData.md): Represents the data for an AnimStateGraph asset.
- [AssetData](https://api.playcanvas.com/editor/types/AssetData.md): Represents the data for an Asset.
- [AssetObserver](https://api.playcanvas.com/editor/types/AssetObserver.md): Represents an observer for an asset, extending the base Observer.
- [AssetProps](https://api.playcanvas.com/editor/types/AssetProps.md): Represents an Asset.
- [AssetUploadArguments](https://api.playcanvas.com/editor/types/AssetUploadArguments.md): Arguments passed when uploading an asset file.
- [AudioListenerComponent](https://api.playcanvas.com/editor/types/AudioListenerComponent.md): AudioListener Component Properties.
- [BundleAssetData](https://api.playcanvas.com/editor/types/BundleAssetData.md): Represents the data for a Bundle asset.
- [ButtonComponent](https://api.playcanvas.com/editor/types/ButtonComponent.md): Button Component Properties.
- [CameraComponent](https://api.playcanvas.com/editor/types/CameraComponent.md): Camera Component Properties.
- [CollisionComponent](https://api.playcanvas.com/editor/types/CollisionComponent.md): Collision Component Properties.
- [Components](https://api.playcanvas.com/editor/types/Components.md): Components of an Entity.
- [CreateEntityArguments](https://api.playcanvas.com/editor/types/CreateEntityArguments.md): Data to create a new Entity
- [CubemapAssetData](https://api.playcanvas.com/editor/types/CubemapAssetData.md): Represents the data for a Cubemap asset.
- [ElementComponent](https://api.playcanvas.com/editor/types/ElementComponent.md): Element Component Properties.
- [EntityObserver](https://api.playcanvas.com/editor/types/EntityObserver.md): Represents an observer for an entity, extending the base Observer.
- [EntityProps](https://api.playcanvas.com/editor/types/EntityProps.md): Represents an Entity.
- [FontAssetData](https://api.playcanvas.com/editor/types/FontAssetData.md): Represents the data for a Font asset.
- [LayoutChildComponent](https://api.playcanvas.com/editor/types/LayoutChildComponent.md): LayoutChild Component Properties.
- [LayoutGroupComponent](https://api.playcanvas.com/editor/types/LayoutGroupComponent.md): LayoutGroup Component Properties.
- [LightComponent](https://api.playcanvas.com/editor/types/LightComponent.md): Light Component Properties.
- [MaterialAssetData](https://api.playcanvas.com/editor/types/MaterialAssetData.md): Represents the data for a Material asset.
- [MessagerClient](https://api.playcanvas.com/editor/types/MessagerClient.md): The MessagerClient interface extends the Events class and defines the methods and properties required for the...
- [ModelAssetData](https://api.playcanvas.com/editor/types/ModelAssetData.md): Represents the data for a Model asset.
- [ModelComponent](https://api.playcanvas.com/editor/types/ModelComponent.md): Model Component Properties.
- [ParticleSystemComponent](https://api.playcanvas.com/editor/types/ParticleSystemComponent.md): ParticleSystem Component Properties.
- [RenderAssetData](https://api.playcanvas.com/editor/types/RenderAssetData.md): Represents the data for a Render asset.
- [RenderComponent](https://api.playcanvas.com/editor/types/RenderComponent.md): Render Component Properties.
- [ReparentArguments](https://api.playcanvas.com/editor/types/ReparentArguments.md): Data to reparent an entity under a new parent
- [RigidBodyComponent](https://api.playcanvas.com/editor/types/RigidBodyComponent.md): RigidBody Component Properties.
- [SceneImportSettings](https://api.playcanvas.com/editor/types/SceneImportSettings.md): Import settings used when uploading a scene (fbx etc.).
- [SceneSettingsObserver](https://api.playcanvas.com/editor/types/SceneSettingsObserver.md): Represents an observer for the Scene Settings, extending the base Observer.
- [SceneSettingsProps](https://api.playcanvas.com/editor/types/SceneSettingsProps.md): Represents the settings for the currently loaded scene.
- [ScreenComponent](https://api.playcanvas.com/editor/types/ScreenComponent.md): Screen Component Properties.
- [ScriptAssetData](https://api.playcanvas.com/editor/types/ScriptAssetData.md): Represents the data for a Script asset.
- [ScriptComponent](https://api.playcanvas.com/editor/types/ScriptComponent.md): Script Component Properties.
- [ScrollbarComponent](https://api.playcanvas.com/editor/types/ScrollbarComponent.md): Scrollbar Component Properties.
- [ScrollviewComponent](https://api.playcanvas.com/editor/types/ScrollviewComponent.md): Scrollview Component Properties.
- [SoundComponent](https://api.playcanvas.com/editor/types/SoundComponent.md): Sound Component Properties.
- [SpriteAssetData](https://api.playcanvas.com/editor/types/SpriteAssetData.md): Represents the data for a Sprite asset.
- [SpriteComponent](https://api.playcanvas.com/editor/types/SpriteComponent.md): Sprite Component Properties.
- [TextureAssetData](https://api.playcanvas.com/editor/types/TextureAssetData.md): Represents the data for a Texture asset.
- [TextureAtlasAssetData](https://api.playcanvas.com/editor/types/TextureAtlasAssetData.md): Represents the data for a TextureAtlas asset.
- [TextureImportSettings](https://api.playcanvas.com/editor/types/TextureImportSettings.md): Import settings used when uploading a texture asset.
- [WasmAssetData](https://api.playcanvas.com/editor/types/WasmAssetData.md): Represents the data for a Wasm asset.

## Variables

- [revision](https://api.playcanvas.com/editor/variables/revision.md): The git revision of the Editor API library.
- [version](https://api.playcanvas.com/editor/variables/version.md): The version of the Editor API library.

## Internal

- [Clipboard](https://api.playcanvas.com/editor/classes/Clipboard.md): Represents a custom clipboard with a specific name which stores a value in localStorage under that name
- [Guid](https://api.playcanvas.com/editor/classes/Guid.md): Basically a very large random number (128-bit) which means the probability of creating two that clash is vanishingly...
- [Jobs](https://api.playcanvas.com/editor/classes/Jobs.md): Facilitates tracking of asynchronous jobs.
- [LocalStorage](https://api.playcanvas.com/editor/classes/LocalStorage.md): Wrapper around native local storage
- [Messenger](https://api.playcanvas.com/editor/classes/Messenger.md): The Messenger API.
- [Realtime](https://api.playcanvas.com/editor/classes/Realtime.md): Provides methods to communicate and load / save data to the realtime server
- [RealtimeAsset](https://api.playcanvas.com/editor/classes/RealtimeAsset.md): Represents an asset in sharedb
- [RealtimeAssets](https://api.playcanvas.com/editor/classes/RealtimeAssets.md): Provides methods to load assets from sharedb
- [RealtimeConnection](https://api.playcanvas.com/editor/classes/RealtimeConnection.md): Handles connecting and communicating with the Realtime server.
- [RealtimeScene](https://api.playcanvas.com/editor/classes/RealtimeScene.md): Represents a scene in sharedb
- [RealtimeScenes](https://api.playcanvas.com/editor/classes/RealtimeScenes.md): Provides methods to load scenes from sharedb
- [utils](https://api.playcanvas.com/editor/classes/utils.md): Contains various utility methods

## Optional

- [All pages in one file](https://api.playcanvas.com/editor/llms-full.txt): 76 pages (93 KB), for downloading and searching rather than reading into context.