Class EditorBuiltin

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

Constructors

constructor

new EditorBuiltin(): EditorBuiltin

Returns EditorBuiltin

Accessors

`Static`defaultFont

get defaultFont(): Font

Returns the default font used by the editor.

Returns Font

`Static`proceduralSpriteAnimationPreloadFPS

get proceduralSpriteAnimationPreloadFPS(): number

Returns the framerate that the procedural sprite animation cache is initialized with when the builtin animations are preloaded.

Returns number

`Static`proceduralSpriteAnimationPreloadSize

get proceduralSpriteAnimationPreloadSize(): Immutable<rsx.UISizePixel>

Returns the size that the procedural sprite animation cache is initialized with when the builtin animations are preloaded.

Returns Immutable<rsx.UISizePixel>

`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: EnumValue<EditorBuiltinShaderTemplate>,
    filename: string,
    project: string,
    author: string,
    company: string,
    date: string,
): Shader
Returns text contained in the default "empty" shader.
Parameters
- type: EnumValue<EditorBuiltinShaderTemplate>
- filename: string
- project: string
- author: string
- company: string
- date: string
Returns Shader

`Static`getDraftTypeScriptComponentCode

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

`Static`getDraftTypeScriptEditorPluginCode

getDraftTypeScriptEditorPluginCode(
    filename: string,
    project: string,
    author: string,
    company: string,
    date: string,
): 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: EnumValue<EditorBuiltinEnvironment>): Texture
Retrieves a built-in environment map.
Parameters
- type: EnumValue<EditorBuiltinEnvironment>
Returns Texture

`Static`getFont

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

`Static`getGizmo

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

`Static`getProceduralSpriteAnimation

getProceduralSpriteAnimation(
animation: EnumValue<EditorBuiltinSpriteAnimation>,
): ProceduralSpriteAnimation
Retrieves a builtin editor sprite animation.
Parameters
- animation: EnumValue<EditorBuiltinSpriteAnimation>
Returns ProceduralSpriteAnimation

`Static`getProceduralSpriteAnimationImage

getProceduralSpriteAnimationImage(
    animation: EnumValue<EditorBuiltinSpriteAnimation>,
    frameSize: Immutable<rsx.UISizePixel>,
    framesPerSecond: number,
    overrideColor: Immutable<Color>,
    playbackType: EnumValue<SpriteAnimationPlayback>,
): UncertainAsyncOp<ResourceHandle<SpriteImage>, string>
Returns a rendered builtin editor sprite animation as an asynchronous operation.
Parameters
- animation: EnumValue<EditorBuiltinSpriteAnimation>
  The builtin editor sprite animation type.
- frameSize: Immutable<rsx.UISizePixel>
  The dimensions of a single frame of the animation.
- framesPerSecond: number
  The number of frames per second the animation should have.
- overrideColor: Immutable<Color>
  An optional parameter. If set, it will override all colors in the animation to the one passed in (useful for converting monochrome animations).
- playbackType: EnumValue<SpriteAnimationPlayback>
  The playback type of the animation sprite image.
Returns UncertainAsyncOp<ResourceHandle<SpriteImage>, string>
The async operation with the rendered sprite image.

`Static`getProceduralSpriteAnimationImagePreloaded

getProceduralSpriteAnimationImagePreloaded(
    animation: EnumValue<EditorBuiltinSpriteAnimation>,
    overrideColor: Immutable<Color>,
    playbackType: EnumValue<SpriteAnimationPlayback>,
): SpriteImage
Returns a pre-rendered sprite image from the builtin procedural sprite animations that are preloaded. It will assert that a preloaded animation is available for the provided arguments.
Parameters
- animation: EnumValue<EditorBuiltinSpriteAnimation>
  The builtin editor sprite animation type.
- overrideColor: Immutable<Color>
  An optional parameter. If set, it will override all colors in the animation to the one passed in (useful for converting monochrome animations).
- playbackType: EnumValue<SpriteAnimationPlayback>
  The playback type of the animation sprite image.
Returns SpriteImage
The already loaded animated sprite image of the animation.

`Static`getSceneViewIcon

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

`Static`getSprite

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

`Static`getStockIcon

getStockIcon(icon: EnumValue<EditorStockIcon>, size?: number): Image
Returns a Image for the at the requested in points. Uses the default style for the icon.
Parameters
- icon: EnumValue<EditorStockIcon>
- Optionalsize: number
Returns Image

`Static`getStockIconFont

getStockIconFont(): Font

Returns the builtin font icon for the given style.

Returns Font

`Static`getStockIconInPixels

getStockIconInPixels(icon: EnumValue<EditorStockIcon>, size?: number): Image
Returns a Image for the at the requested in pixels. Uses the default style for the icon.
Parameters
- icon: EnumValue<EditorStockIcon>
- Optionalsize: number
Returns Image

`Static`getTexture

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

`Static`makeStockIconString

makeStockIconString(icon: EnumValue<EditorStockIcon>): string
Makes a string that contains the given font awesome unicode code.
Parameters
- icon: EnumValue<EditorStockIcon>
Returns string

`Static`reloadUISkin

reloadUISkin(): void

Returns void

Class EditorBuiltin

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns EditorBuiltin

Accessors

StaticdefaultFont

Returns Font

StaticproceduralSpriteAnimationPreloadFPS

Returns number

StaticproceduralSpriteAnimationPreloadSize

Returns Immutable<rsx.UISizePixel>

StaticrsxLogo

Returns Shape

StaticuiSkin

Returns UISkin

Methods

StaticcreateEditableShaderResource

Parameters

Returns Shader

StaticgetDraftTypeScriptComponentCode

Parameters

Returns string

StaticgetDraftTypeScriptEditorPluginCode

Parameters

Returns string

StaticgetEnvironmentMap

Parameters

Returns Texture

StaticgetFont

Parameters

Returns Font

StaticgetGizmo

Parameters

Returns Mesh

StaticgetProceduralSpriteAnimation

Parameters

Returns ProceduralSpriteAnimation

StaticgetProceduralSpriteAnimationImage

Parameters

Returns UncertainAsyncOp<ResourceHandle<SpriteImage>, string>

StaticgetProceduralSpriteAnimationImagePreloaded

Parameters

Returns SpriteImage

StaticgetSceneViewIcon

Parameters

Returns Image

StaticgetSprite

Parameters

Returns SpriteImage

StaticgetStockIcon

Parameters

Returns Image

StaticgetStockIconFont

Returns Font

StaticgetStockIconInPixels

Parameters

Returns Image

StaticgetTexture

Parameters

Returns Texture

StaticmakeStockIconString

Parameters

Returns string

StaticreloadUISkin

Returns void

Settings

On This Page

`Static`defaultFont

`Static`proceduralSpriteAnimationPreloadFPS

`Static`proceduralSpriteAnimationPreloadSize

`Static`rsxLogo

`Static`uiSkin

`Static`createEditableShaderResource

`Static`getDraftTypeScriptComponentCode

`Static`getDraftTypeScriptEditorPluginCode

`Static`getEnvironmentMap

`Static`getFont

`Static`getGizmo

`Static`getProceduralSpriteAnimation

`Static`getProceduralSpriteAnimationImage

`Static`getProceduralSpriteAnimationImagePreloaded

`Static`getSceneViewIcon

`Static`getSprite

`Static`getStockIcon

`Static`getStockIconFont

`Static`getStockIconInPixels

`Static`getTexture

`Static`makeStockIconString

`Static`reloadUISkin