BlendStruct

One struct in the file, read by field name.

class BlendStruct

import { BlendStruct } from '@driftengine/assets';

Constructor

`new`

constructor(file: BlendData, struct: DnaStruct, offset: number, /** The datablock this struct's data belongs to, which every pointer in it is resolved inside. */ scope: number)

Parameter	Type	Description
`file`	`BlendData`
`struct`	`DnaStruct`
`offset`	`number`
`/** The datablock this struct's data belongs to`
`which every pointer in it is resolved inside. */ scope: number`

Properties

Name	Type	Description
`file`readonly	`BlendData`
`struct`readonly	`DnaStruct`
`offset`readonly	`number`
`scope`readonly	`number`	The datablock this struct's data belongs to, which every pointer in it is resolved inside.

Accessors

Name	Type	Description
`type`get	`string`

Methods

`has`

has(name: string): boolean

Parameter	Type	Description
`name`	`string`

`field`

field(name: string): DnaField

Parameter	Type	Description
`name`	`string`

`int`

int(name: string, index?: number): number

An integer field of any width, signed as its type is.

Parameter	Type	Description
`name`	`string`
`index?`	`number`

`float`

float(name: string, index?: number): number

Parameter	Type	Description
`name`	`string`
`index?`	`number`

`floats`

floats(name: string): number[]

Every element of a float array field, flattened: co[3] is three, mat[4][4] sixteen.

Parameter	Type	Description
`name`	`string`

`ints`

ints(name: string): number[]

Parameter	Type	Description
`name`	`string`

`string`

string(name: string): string

A char[] field as text, up to its first zero.

Parameter	Type	Description
`name`	`string`

`idName`

idName(): string

An ID's name without its two-letter code: OBCube is Cube.

`ptr`

ptr(name: string, index?: number): bigint

Parameter	Type	Description
`name`	`string`
`index?`	`number`

`deref`

deref(name: string, type?: string): BlendStruct | null

Follow a pointer field, typed by the block it lands in or by type where that is known.

Parameter	Type	Description
`name`	`string`
`type?`	`string`

`array`

array(name: string, type: string, count?: number): BlendStruct[]

An array a pointer field names, count long or as long as its block.

Parameter	Type	Description
`name`	`string`
`type`	`string`
`count?`	`number`

`raw`

raw(name: string): Uint8Array | null

The bytes a pointer field names, through the end of their block.

Parameter	Type	Description
`name`	`string`

`blockOf`

blockOf(name: string): BlendBlock | null

The block a pointer field names.

Parameter	Type	Description
`name`	`string`

`text`

text(name: string): string

A char * field's text.

Parameter	Type	Description
`name`	`string`

`sub`

sub(name: string): BlendStruct

An embedded struct field, viewed in place.

Parameter	Type	Description
`name`	`string`

`list`

list(name: string, type?: string): BlendStruct[]

The links of a ListBase field, following next until it runs out.

Parameter	Type	Description
`name`	`string`
`type?`	`string`

`pointers`

pointers(name: string, count: number): bigint[]

An array of pointers that a pointer-to-pointer field names: Mesh.mat, Object.mat.

Parameter	Type	Description
`name`	`string`
`count`	`number`