Class EditorBuiltin

Contains a set of built-in resources used by the editor.

Index

Constructors

Accessors

defaultFont rsxLogo uiSkin

Methods

createEditableShaderResource getDraftTypeScriptComponentCode getDraftTypeScriptEditorPluginCode getEnvironmentMap getFont getGizmo getSceneViewIcon getSprite getTexture reloadUISkin

Constructors

constructor

new EditorBuiltin(): EditorBuiltin
Returns EditorBuiltin

Accessors

`Static`defaultFont

get defaultFont(): Font
Returns the default font used by the editor.

Returns Font

`Static`rsxLogo

get rsxLogo(): Shape
Gets the RSX logo shape.

Returns Shape

`Static`uiSkin

get uiSkin(): UISkin
Returns the default editor UI skin.

Returns UISkin

Methods

`Static`createEditableShaderResource

createEditableShaderResource(type, filename, project, author, company, date): Shader
Returns text contained in the default "empty" shader.
Parameters
- type: EnumValue<EditorBuiltinShaderTemplate, number>
- filename: string
- project: string
- author: string
- company: string
- date: string
Returns Shader

`Static`getDraftTypeScriptComponentCode

getDraftTypeScriptComponentCode(filename, project, author, company, date): string
Returns draft TypeScript Component source code.
Parameters
- filename: string
- project: string
- author: string
- company: string
- date: string
Returns string

`Static`getDraftTypeScriptEditorPluginCode

getDraftTypeScriptEditorPluginCode(filename, project, author, company, date): string
Returns draft TypeScript Editor Plugin source code.
Parameters
- filename: string
- project: string
- author: string
- company: string
- date: string
Returns string

`Static`getEnvironmentMap

getEnvironmentMap(type): Texture
Retrieves a built-in environment map.
Parameters
- type: EnumValue<EditorBuiltinEnvironment, number>
Returns Texture

`Static`getFont

getFont(font): Font
Returns a named font.
Parameters
- font: EnumValue<EditorBuiltinFont, number>
Returns Font

`Static`getGizmo

getGizmo(gizmoMeshFilename): Mesh
Retrieves a builtin gizmo mesh from it's filename.
Parameters
- gizmoMeshFilename: string
  The filename of the mesh.
Returns Mesh

`Static`getSceneViewIcon

getSceneViewIcon(icon): Image
Retrieves an icon that may be displayed in the 3D scene view.
Parameters
- icon: EnumValue<SceneViewIcon, number>
Returns Image

`Static`getSprite

getSprite(sprite): SpriteImage
Retrieves a builtin editor sprite texture.
Parameters
- sprite: EnumValue<EditorSprites, number>
Returns SpriteImage

`Static`getTexture

getTexture(textureFilename): Texture
Retrieves a builtin texture from it's filename.
Parameters
- textureFilename: string
  The filename of the texture.
Returns Texture

`Static`reloadUISkin

reloadUISkin(): void
Returns void