@kognifai/cogsengine
    Preparing search index...

    Class FontSelectorComponent

    Creates fontHandle from Font+Size passing handle to other components having the 'fontHandle' field.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    flags fontName fontSize isTyped

    Accessors

    entity name type

    Methods

    create wrap

    Constructors

    Properties

    flags: FontSelectorFlags

    If set to ApplyToChildren the fontHandle is also passed to all child entities with 'fontHandle' field and all child FontSelectorComponents is also synced with same Font+Size.

    fontName: string

    Name of Font.

    fontSize: number

    Size of font.

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    Accessors

    • get entity(): Entity

      Gets the optional owning entity

      Returns Entity

    • set entity(entity: Entity): void

      Internal: set owning entity.

      Parameters

      Returns void

    • get name(): string

      Component name == type. For compatibility

      Returns string

    • get type(): string

      Gets the type of the component. Ex. "TransformComponent", "SceneComponent" etc.

      Returns string

    Methods

    • Internal: Creates a new component of the given type (name). Component is wrapped when adding to an entity.

      Parameters

      • type: string

        Type of the component. Ex. "TransformComponent"

      Returns Component

      Created Cogs.js component.

    • Internal: Creates a new component being wrapped as an existing member of the entity

      Parameters

      • type: string

        Type of the component. Ex. "TransformComponent"

      • entity: Entity

        The owning entity

      Returns Component

      Created Cogs.js component.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods