コライダー

説明

このコンポーネントは、エンティティに物理コライダーを確立します。

コライダーシェイプ

タイプ	説明
ボックス	ボックス
スフィア	スフィア
飛行機	飛行機
カプセル	カプセル
コーン	コーン
シリンダー	シリンダー

プロパティ

名称	タイプ	デフォルト	説明
形状（必須）	ecs.ColliderShape	ecs.ColliderShape.Box	サポートされている型はecs.ColliderShapeにあります。
幅	番号	0	ボックスまたはプレーン形状の幅。
高さ	番号	0	箱形、平面、カプセル形、円錐形、円柱形の高さ。
深さ	番号	0	ボックス形状の深さ。
半径	番号	0	球形、カプセル形、円錐形、円柱形の半径。
質量	番号	0	実体の質量。静的にするには0のままにする。
イベントのみ	ブーリアン	擬似	オブジェクトは衝突イベントのディスパッチのみを行い、物理的な応答は行わない方がよい。
グラビティファクトリー	番号	1	世界の重力を測定する係数
ロックX軸	ブーリアン	擬似	X軸の回転を無効にする
ロックYAxis	ブーリアン	擬似	Y軸の回転を無効にする
ロックザクシス	ブーリアン	擬似	Z軸の回転を無効にする
摩擦	番号	0.5	実体の接触摩擦の大きさ
損害賠償	番号	0	実体の弾力性
リニアダンピング	番号	0	移動中の空気抵抗
角度減衰	番号	0	回転中の空気抵抗
回転摩擦	番号	0	回転中に実体にかかる摩擦の量

機能

Get

Returns a read-only reference.

Example

ecs.Collider.get(world, component.eid)

Set

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

Example

ecs.Collider.set(world, component.eid, {
  shape: 'ecs.ColliderShape.Box',
  width: 0,
  height: 0,
  depth: 0,
  radius: 0,
  mass: 0,
  eventOnly: false,
  gravityFactory: 1,
  lockXAxis: false,
  lockYAxis: false,
  lockZAxis: false,
  friction: 0.5,
  restitution: 0,
  linearDamping: 0,
  angularDamping: 0,
  spinningFriction: 0
})

Mutate

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

Example

ecs.Collider.mutate(world, component.eid, (cursor) => {
  cursor.mass=5;
  、cursor.friction=0.8;
  return false;
})

Remove

Removes the component from the entity.

Example

ecs.Collider.remove(world, component.eid)

Has

Returns true if the component is present on the entity.

Example

ecs.Collider.has(world, component.eid)

Reset

Adds, or resets the component to its default state.

Example

ecs.Collider.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.Collider.cursor(world, component.eid)

Acquire

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

Example

ecs.Collider.acquire(world, component.eid)

Commit

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

Example

ecs.Collider.commit(world, component.eid)
ecs.Collider.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.Collider.dirty(world, component.eid)

説明​