Function serializable

Marks a field for serialization and editor exposure. Required for fields that reference
other objects, components, or assets. Primitive types (string, number, boolean) work without a type argument.

Example: Primitive types (no type needed)

@serializable()
speed: number = 1;

@serializable()
label: string = "Hello";

Example: Object references

@serializable(Object3D)
target: Object3D | null = null;

@serializable(Renderer)
myRenderer: Renderer | null = null;

Example: Arrays

@serializable([Object3D])
waypoints: Object3D[] = [];

See

syncField for automatic network synchronization

Link

https://engine.needle.tools/docs/reference/typescript-decorators.html#serializable

  • serializable<T>(
        type?:
            | null
            | Constructor<T>
            | TypeResolver<T>
            | (Constructor<any> | TypeResolver<T>)[],
    ): (_target: any, _propertyKey: string | { name: string }) => void

    Type Parameters

    • T

    Parameters

    • Optionaltype: null | Constructor<T> | TypeResolver<T> | (Constructor<any> | TypeResolver<T>)[]

      The constructor type for complex objects. Omit for primitives.

    Returns (_target: any, _propertyKey: string | { name: string }) => void

Settings

Member Visibility