Class EditorBuiltin

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

Constructors

constructor

Accessors

defaultFont proceduralSpriteAnimationPreloadFPS proceduralSpriteAnimationPreloadSize rsxLogo uiSkin

Methods

createEditableShaderResource getDraftTypeScriptComponentCode getDraftTypeScriptEditorPluginCode getEnvironmentMap getFont getGizmo getProceduralSpriteAnimation getProceduralSpriteAnimationImage getProceduralSpriteAnimationImagePreloaded getSceneViewIcon getSprite getStockIcon getStockIconFont getStockIconInPixels getTexture makeStockIconString reloadUISkin

Constructors

constructor

Accessors

StaticdefaultFont

  • get defaultFont(): Font

  • Returns the default font used by the editor.

    Returns Font

StaticproceduralSpriteAnimationPreloadFPS

  • get proceduralSpriteAnimationPreloadFPS(): number

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

    Returns number

StaticproceduralSpriteAnimationPreloadSize

  • get proceduralSpriteAnimationPreloadSize(): Immutable<Size2>

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

    Returns Immutable<Size2>

StaticrsxLogo

  • get rsxLogo(): Shape

  • Gets the RSX logo shape.

    Returns Shape

StaticuiSkin

  • get uiSkin(): UISkin

  • Returns the default editor UI skin.

    Returns UISkin

Methods

StaticcreateEditableShaderResource

  • createEditableShaderResource(type, filename, project, author, company, date): Shader

  • Returns text contained in the default "empty" shader.

    Parameters

    Returns Shader

StaticgetDraftTypeScriptComponentCode

  • 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

StaticgetDraftTypeScriptEditorPluginCode

  • 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

StaticgetEnvironmentMap

StaticgetFont

StaticgetGizmo

  • getGizmo(gizmoMeshFilename): Mesh

  • Retrieves a builtin gizmo mesh from it's filename.

    Parameters

    • gizmoMeshFilename: string

      The filename of the mesh.

    Returns Mesh

StaticgetProceduralSpriteAnimation

StaticgetProceduralSpriteAnimationImage

  • getProceduralSpriteAnimationImage(animation, frameSize, framesPerSecond, overrideColor, playbackType): UncertainAsyncOp<ResourceHandle<SpriteImage>, string>

  • Returns a rendered builtin editor sprite animation as an asynchronous operation.

    Parameters

    • animation: EnumValue<EditorBuiltinSpriteAnimation, number>

      The builtin editor sprite animation type.

    • frameSize: Immutable<Size2>

      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, number>

      The playback type of the animation sprite image.

    Returns UncertainAsyncOp<ResourceHandle<SpriteImage>, string>

    The async operation with the rendered sprite image.

StaticgetProceduralSpriteAnimationImagePreloaded

  • getProceduralSpriteAnimationImagePreloaded(animation, overrideColor, playbackType): 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

    Returns SpriteImage

    The already loaded animated sprite image of the animation.

StaticgetSceneViewIcon

StaticgetSprite

StaticgetStockIcon

  • getStockIcon(icon, size?): Image

  • Returns a Image for the at the requested in points. Uses the default style for the icon.

    Parameters

    Returns Image

StaticgetStockIconFont

  • getStockIconFont(): Font

  • Returns the builtin font icon for the given style.

    Returns Font

StaticgetStockIconInPixels

  • getStockIconInPixels(icon, size?): Image

  • Returns a Image for the at the requested in pixels. Uses the default style for the icon.

    Parameters

    Returns Image

StaticgetTexture

  • getTexture(textureFilename): Texture

  • Retrieves a builtin texture from it's filename.

    Parameters

    • textureFilename: string

      The filename of the texture.

    Returns Texture

StaticmakeStockIconString

  • makeStockIconString(icon): string

  • Makes a string that contains the given font awesome unicode code.

    Parameters

    Returns string

StaticreloadUISkin

  • reloadUISkin(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods