PlayCanvasのコードエディターでコード補完をする

PlayCanvas標準のコードエディタを利用している場合にコード補完が効かない場合があります。その場合にはJSDocのアノテーションを追加することで標準のエディターでコード補完ができます。

var Exmaple = pc.createScript('example');

Example.prototype.initialize = function() {
  // ① ※ pc.GraphNodeとされるためEntityのコード補完が効かない
  const cube = this.app.root.findByName("Root");
  cube.rotateLocal(0, 0.1, 0);

  // ② ※ pc.Entityとして扱われる
  /** @type {pc.Entity} */
  const typedCube = this.app.root.findByName("Root");
  typedCube.rotateLocal(0, 0.1, 0);
}

① / ②それぞれの違いについて

① ※ pc.GraphNodeとされるためEntityのコード補完が効かない

② ※ pc.Entityとして扱われる

参考

変数以外にも関数などについても同様に補完ができます。記述方法などについてはこちらが参考になります。

• JSDocリファレンス

PlayCanvasのコンポーネント名などについてはこちらが参考になります。

• API Reference PlayCanvas