aboutsummaryrefslogtreecommitdiff
path: root/lib/components/grab.js
blob: df41360a02eb56c63acd1d3760f9aadc9f1224da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
import { Component } from '@serpentity/serpentity';

/**
 * Component that stores a dash skill
 *
 * @extends {external:Serpentity.Component}
 * @class GrabComponent
 * @param {object} config a configuration object to extend.
 */
export default class GrabComponent extends Component {
  constructor(config) {

    super(config);

    /**
     * The properthy that holds the grab state
     *
     * @property {boolean} grabbing
     * @instance
     * @memberof GrabComponent
     */
    this.dashing = this.grabbing || false;

    /**
     * The constraint used for the grab
     *
     * @property {external:MatterJs.Constraint} constraint
     * @instance
     * @memberof GrabComponent
     */
    this.constraint = this.constraint || null;

    /**
     * Whether the grab is locked from occuring
     *
     * @property {boolean} locked
     * @instance
     * @memberof GrabComponent
     */
    this.locked = this.locked || false;

    /**
     * Cooldown before lock is removed
     *
     * @property {number} cooldown
     * @instance
     * @memberof GrabComponent
     */
    this.cooldown = this.cooldown || 3000;

    /**
     * Current cooldown
     *
     * @property {number} currentCooldown
     * @instance
     * @memberof GrabComponent
     */
    this.currentCooldown = 0;
  }
}