Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

6.5 KB
Raw Blame

API surface — esengine/rig2d

Symbols: 0 public · 0 beta · 53 experimental · 0 deprecated

Bone2D — const @experimental

ComponentDef<Bone2DData>

Bone2DData — interface @experimental

length: number

BoneConstraint2D — const @experimental

ComponentDef<BoneConstraint2DData>

BoneConstraint2DData — interface @experimental

enabled: boolean
kind: number
max: number
min: number
offset: number
source: number
weight: number

BoneConstraintKind — const @experimental

{ readonly LimitRotation: 0; readonly CopyRotation: 1; readonly CopyPosition: 2; readonly LookAt: 3; }

ChainBone — interface @experimental

max: number | undefined
min: number | undefined
rotation: number
x: number
y: number

ChainSolveOptions — interface @experimental

bend: number | undefined
iterations: number | undefined
tipLength: number
tolerance: number | undefined

IK2D — const @experimental

ComponentDef<IK2DData>

IK2DData — interface @experimental

bend: number
chainLength: number
enabled: boolean
matchTargetRotation: boolean
target: number
weight: number

RIG_MAX_INFLUENCES — const @experimental

4

RIG_SOURCE_EXT — const @experimental

".esrig"

RIG_SOURCE_VERSION — const @experimental

1

Rig2DPlugin — class @experimental

activeWhen: (ComponentDef<BoneConstraint2DData> | ComponentDef<IK2DData>)[]
build: (app: App) => void
name: string
static new (): Rig2DPlugin
static prototype: Rig2DPlugin

RigBone — interface @experimental

id: string | undefined
length: number
name: string
parent: number
rotation: number
x: number
y: number

RigBoneWorld — interface @experimental

rotation: number
x: number
y: number

RigDeform — interface @experimental

name: string
offsets: Record<string, number[]>

RigImage — interface @experimental

alpha: (x: number, y: number) => number
height: number
width: number

RigPart — interface @experimental

name: string
rect: { x: number; y: number; w: number; h: number; }
triangles: number[]
vertices: number[]
weights: number[][]
x: number
y: number

RigPathChanges — interface @experimental

before: Set<string>
removed: string[]
renamed: Map<string, string>

RigRebindReport — interface @experimental

matched: string[]
moved: { from: string; to: string; }[]

RigSource — interface @experimental

bones: RigBone[]
deforms: RigDeform[]
parts: RigPart[]
texture: string
textureHeight: number
textureWidth: number
unitsPerPixel: number
version: number

RigWeightDab — interface @experimental

bone: number
mode: "add" | "remove" | "smooth"
radius: number
strength: number
x: number
y: number

SpawnedRig — interface @experimental

bones: number[]
root: number

autoWeightPart — function @experimental

(rig: RigSource, part: RigPart, opts?: { bones?: readonly number[]; falloff?: number; }): void

bakeRig — function @experimental

(rig: RigSource): MeshData

bindPartToBone — function @experimental

(part: RigPart, bone: number): void

chainTip — function @experimental

(chain: readonly ChainBone[], tipLength: number): { x: number; y: number; }

checkRig — function @experimental

(rig: RigSource): string[]

clampAngle — function @experimental

(angle: number, min?: number, max?: number): number

coverRigPart — function @experimental

(image: RigImage, rect: RigPart["rect"], opts?: { cell?: number; threshold?: number; }): { vertices: number[]; triangles: number[]; }

createRig — function @experimental

(texture: string, textureWidth: number, textureHeight: number, unitsPerPixel?: number): RigSource

ensureRigBoneIds — function @experimental

(rig: RigSource): void

findRigParts — function @experimental

(image: RigImage, opts?: { threshold?: number; minArea?: number; }): { x: number; y: number; w: number; h: number; }[]

paintPartWeights — function @experimental

(rig: RigSource, part: RigPart, dab: RigWeightDab): number

parseRig — function @experimental

(text: string): RigSource

partWeightsOf — function @experimental

(part: RigPart, bone: number): Float32Array

pushRigDeform — function @experimental

(rig: RigSource, deformIndex: number, x: number, y: number, radius: number, dx: number, dy: number): number

rebindRigToSkeleton — function @experimental

(rig: RigSource, skeleton: readonly RigBone[]): RigRebindReport

remapRigPath — function @experimental

(path: string, changes: RigPathChanges): string | null

removeRigBone — function @experimental

(rig: RigSource, index: number): void

rigBoneId — function @experimental

(bones: readonly RigBone[], index: number): string

rigBonePaths — function @experimental

(bones: readonly RigBone[]): string[]

rigBoneWorlds — function @experimental

(bones: readonly RigBone[], rotations?: ArrayLike<number>): RigBoneWorld[]

rigImageFromRGBA — function @experimental

(width: number, height: number, rgba: ArrayLike<number>): RigImage

rigParentProblem — function @experimental

(rig: RigSource, index: number, parent: number): string | null

rigPathChanges — function @experimental

(before: readonly RigBone[], after: readonly RigBone[]): RigPathChanges

rigPrefab — function @experimental

(rig: RigSource, name: string, mesh: string, texture: string): { version: string; name: string; rootEntityId: string; entities: Record<string, unknown>[]; }

rigVertex — function @experimental

(rig: RigSource, part: RigPart, vertex: number): { x: number; y: number; }

serializeRig — function @experimental

(rig: RigSource): string

setRigBoneParent — function @experimental

(rig: RigSource, index: number, parent: number): number

skinRigPart — function @experimental

(rig: RigSource, partIndex: number, posed: readonly RigBoneWorld[], deformWeights?: ArrayLike<number>): Float32Array

solveChain2D — function @experimental

(chain: ChainBone[], targetX: number, targetY: number, opts: ChainSolveOptions): void

spawnRig — function @experimental

(world: World, rig: RigSource, opts: { mesh: number; texture: number; layer?: number; x?: number; y?: number; z?: number; }): SpawnedRig