本文へスキップ

コンポーネント機能

はじめに​

コンポーネントは実行時に追加、変更、削除できる。 組み込みコンポーネントとカスタムコンポーネントは、コンポーネントデータの管理に同じインターフェイスを使用します。

カスタムコンポーネントの参照​

次の例は、異なるコード・ファイル間でカスタム・コンポーネントへの参照を共有する方法を示しています。

チップ

コンポーネントをインポートまたは使用する前に、必ずコンポーネントをエクスポートしてください。

/custom-component.ts
import * as ecs from '@8thwall/ecs'

const CustomComponent = ecs.registerComponent({
  ...
})

export {CustomComponent}
/another-component.ts
import * as ecs from '@8thwall/ecs'
import {CustomComponent} from './custom-component'

ecs.registerComponent({
  name: 'Another Custom Component',
  stateMachine: ({world, eid, schemaAttribute, dataAttribute}) => {
    ecs.defineState('default')
      .initial()
      .onEnter(() => {
        const entity = world.createEntity()

        CustomComponent.set(world, entity, {
          displayName: 'Jini'
        })
      })
  },
})

機能​

コンポーネント関数を使用すると、エンティティに関連するコンポーネントとそのデータに対して、さまざまなアクションを実行できます。

Get​

Returns a read-only reference.

Example

ecs.円柱幾何学.get(world, component.eid)

Set​

Ensures the component exists on the entity, then assigns the (optional) data to the component.

Example

ecs.円柱幾何学.set(world, component.eid, {
  radius: 1,
  height: 1
})

Mutate​

Perform an update to the component within a callback function. Return true to indicate no changes made.

Example

ecs.円柱幾何学.mutate(world, component.eid, (cursor) => {
  cursor.radius += 1;
 cursor.height *= 2;
 return false;
})

Remove​

Removes the component from the entity.

Example

ecs.円柱幾何学.remove(world, component.eid)

Has​

Returns true if the component is present on the entity.

Example

ecs.円柱幾何学.has(world, component.eid)

Reset​

Adds, or resets the component to its default state.

Example

ecs.円柱幾何学.reset(world, component.eid)

Advanced Functions​

Cursor​

Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.

Example
ecs.円柱幾何学.cursor(world, component.eid)

Acquire​

Same behavior as cursor, but commit must be called after the cursor is done being used.

Example
ecs.円柱幾何学.acquire(world, component.eid)

Commit​

Called after acquire. An optional third argument determines whether the cursor was mutated or not.

Example
ecs.円柱幾何学.commit(world, component.eid)
ecs.円柱幾何学.commit(world, component.eid, false)

Dirty​

Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.

Example
ecs.円柱幾何学.dirty(world, component.eid)