Interface BodyOptions<UserDataType>

BodyOptions for body creation

interface BodyOptions<UserDataType> {
    angle?: number;
    group?: number;
    isCentered?: boolean;
    isStatic?: boolean;
    isTrigger?: boolean;
    padding?: number;
    userData?: UserDataType;
}

Type Parameters

  • UserDataType = any

Hierarchy (view full)

Properties

angle? group? isCentered? isStatic? isTrigger? padding? userData?

Properties

Optionalangle

angle?: number

body angle in radians use deg2rad to convert move(speed) moves at 1 speed = 1px towards angle

Optionalgroup

group?: number

group for collision filtering

Based on Box2D (tutorial)

Values in BodyGroup are predefined and used each the body type and should not be used for custom filtering

0b00000001 << 16 to 0b01000000 << 16 (max 0x7fffffff) are free to use for custom groups

See

canInteract for how groups are used

Default

0x7fffffff // member of all groups (can interact with everyting)

OptionalisCentered

isCentered?: boolean

is body offset centered for rotation purpouses

OptionalisStatic

isStatic?: boolean

system.separate() doesn't move this body

OptionalisTrigger

isTrigger?: boolean

system.separate() doesn't trigger collision of this body

Optionalpadding

padding?: number

BHV padding for bounding box, preventing costly updates

OptionaluserData

userData?: UserDataType

allows the user to set any misc data for client use

Settings

Member Visibility

On This Page

Properties