Options
All
  • Public
  • Public/Protected
  • All
Menu

Spider Engine API

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AnimationSampleType

AnimationSampleType: number | boolean | string | Color | Quaternion | Asset | null

BlendableType

BlendableType: Vector3 | Quaternion | number

CameraToRenderPassToDefinitionMap

CameraToRenderPassToDefinitionMap: Map<Camera, RenderPassToDefinitionMap>

Constructor

Constructor<T>: object

Type parameters

  • T

Type declaration

IfEquals

IfEquals<X, Y, A, B>: IfEquals<X, Y, A, B>

Type parameters

  • X

  • Y

  • A

  • B

NativeType

NativeType: number | string | boolean

ObjectProps

ObjectProps<T>: Partial<Pick<T, WritableProperties<T>>>

Type parameters

  • T

PrimitiveType

PrimitiveType: "POINTS" | "LINE_STRIP" | "LINE_LOOP" | "LINES" | "TRIANGLE_STRIP" | "TRIANGLE_FAN" | "TRIANGLES"

RenderPassToDefinitionMap

RenderPassToDefinitionMap: Map<number, IRenderPassDefinition>

RenderStateBucketsMap

RenderStateBucketsMap: Map<string, IRenderStateBucket>

RotationOrder

RotationOrder: "YXZ" | "ZYX" | "ZYX" | "XYZ" | "ZXY" | "YZX" | "XZY"

SerializedNativeArray

SerializedNativeArray: INativeArray

SerializedObjectType

SerializedObjectType: SerializedObject | SerializedPrefab | SerializedScene | SerializedAnimationTrack | SerializedNumberTrack | SerializedGamepadData

SerializedPropertyType

SerializedPropertyType: SerializedArrayProperty | SerializedReference | SerializedReferenceArray | SerializedAssetReference | SerializedAssetReferenceArray | SerializedAsset | SerializedVertexBuffer | SerializedUISize | SerializedSize | SerializedComponentReference | SerializedNativeArray

ShaderParamInstanceType

ShaderParamInstanceType: Vector2 | Vector3 | Vector4 | Color | Matrix44 | Matrix33 | Texture | StaticCubemap | Number | Boolean | String

ShaderParamType

ShaderParamType: "vec2" | "vec3" | "vec4" | "mat4" | "mat3" | "sampler1D" | "sampler2D" | "sampler2DArray" | "samplerCube" | "float" | "int" | "bool"

ShaderToVisualBucketsMap

ShaderToVisualBucketsMap: Map<Shader, VisualBucketsMap>

TypeDefinition

TypeDefinition<T>: [Constructor<T>, undefined | object]

Type parameters

VertexAttribute

VertexAttribute: "position" | "uv" | "uv2" | "uv3" | "uv4" | "normal" | "tangents" | "color" | "skinIndex" | "skinWeight" | "barycentricCoord"

VertexAttributes

VertexAttributes: object

Type declaration

VertexBufferToVisualsMap

VertexBufferToVisualsMap: Map<VertexBuffer, Visual[]>

VisualBucketsMap

VisualBucketsMap: Map<string, IVisualBucket>

WritableProperties

WritableProperties<T>: { [P in keyof T]-?: IfEquals<{ [Q in P]: T[P]; }, { -readonly [Q in P]: T[P]; }, P, never>; }[keyof T]

Type parameters

  • T

Variables

Const FIK

FIK: any = require("@aminere/fullik")

Functions

creatable

  • creatable(param: boolean): function

  • Parameters

    • param: boolean

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

defaultType

  • defaultType(typeName: string): function

  • Parameters

    • typeName: string

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

displayName

  • displayName(name: string): function

  • Parameters

    • name: string

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

editable

  • editable(param: boolean): function

  • Parameters

    • param: boolean

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

enumLiterals

  • enumLiterals(enumObject: object, getDisplayName?: undefined | function): function

  • Parameters

    • enumObject: object
    • Optional getDisplayName: undefined | function

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

exclusiveWith

  • exclusiveWith(typeName: string | string[]): function

  • Parameters

    • typeName: string | string[]

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

hasDedicatedEditor

  • hasDedicatedEditor(param: boolean): function

  • Parameters

    • param: boolean

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

helpUrl

  • helpUrl(url: string): function

  • Parameters

    • url: string

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

hidden

  • hidden(): function

  • Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

mandatory

  • mandatory(): function

  • Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

nullable

  • nullable(param: boolean): function

  • Parameters

    • param: boolean

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

referencable

  • referencable(param: boolean): function

  • Parameters

    • param: boolean

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

requires

  • requires(typeName: string): function

  • Parameters

    • typeName: string

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

rotationAngle

  • rotationAngle(): function

  • Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

sortOrder

  • sortOrder(order: number): function

  • Parameters

    • order: number

    Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

unserializable

  • unserializable(): function

  • Returns function

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void

      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void