이벤트 함수

이벤트 함수에 대해 안내합니다.

이벤트 함수는 특정 이벤트 상황에서 실행되도록 미리 정의된 함수입니다. 새로운 유저가 들어오는 경우, 혹은 키보드나 마우스 입력을 실행하는 경우 등에 사용자가 정의한 스크립트를 실행할 수 있도록 하는 수단입니다.

Start()

플레이 시작할 때 최초 한번 실행됩니다.

const box = WORLD.getObject("BOX");
 
function Start() {
  PLAYER.onCollide(box, () => {
    box.kill();
  });
}

Update(dt)

매 프레임 반복하여 실행됩니다.

• dt : deltaTime. time interval between frames, in seconds.

function Update(dt) {
  this.position.y += dt * 2;
  if (this.position.y >= 10) {
    this.position.y = 0;
  }
}

OnKeyDown(event)

키보드 키를 눌렀을 때 실행됩니다.

• event : 키보드 이벤트. event.code 또는 event.key를 통해 어떤 key인지 알 수 있습니다.

reference

• Code values for keyboard events
• JavaScript Key Code Event Tool & List

function OnKeyDown(event) {
    switch (event.code) {
        case "KeyQ":
            changeWeapon();
            break;
        case "KeyR":
            reload();
            break;
        default:
            break;
    }
}
 
const changeWeapon = () => {...}
 
const reload = () => {...}

OnKeyUp(event)

키보드 키를 (눌렀다가) 뗐을 때 실행됩니다.

• event : 키보드 이벤트. event.code 또는 event.key를 통해 어떤 key인지 알 수 있습니다.

function OnKeyUp(event) {
    switch (event.code) {
        case "KeyQ":
            doSomething();
            break;
        default:
            break;
    }
}
 
const doSomething = () = {...}

OnPointerDown(event)

포인터를 눌렀을 때 실행됩니다.

• event : 포인터 이벤트. event.button을 통해 좌클릭/우클릭을, event.clientX와 event.clientY를 통해 좌표를 알 수 있습니다.

MouseEvent: button property

PonterEvent: pointerType property

function OnPointerDown(event) {
    if (event.button === 0) {
        fire(event.clientX, event.clientY);
    }
}
 
const fire = (x, y) => {...};

OnPointerMove(event)

포인터를 움직였을 때 실행됩니다.

• event : 포인터 이벤트. event.clientX와 event.clientY를 통해 좌표를 알 수 있습니다.

function OnPointerMove(event) {
  // Similar to OnPointerDown
}

OnPointerUp(event)

포인터를 (눌렀다가) 뗐을 때 실행됩니다.

• event : 포인터 이벤트. event.button을 통해 좌클릭/우클릭을, event.clientX와 event.clientY를 통해 좌표를 알 수 있습니다.

function OnPointerUp(event) {
  // Similar to OnPointerDown
}

OnJoin(clientId, avatar)

새로운 플레이어가 참가했을 때 실행됩니다. Client Script에서 사용될 경우 새로운 플레이어가 참가했을 때 기존에 있던 플레이어들은 새로운 플레이어에 대해 OnJoin 함수가 실행되고, 새로운 플레이어는 자기자신을 포함하여 기존에 있던 모든 플레이어들에 대해 OnJoin 함수가 실행됩니다.

• clientId : 새롭게 참가한 플레이어의 clientId.
• avatar : 새롭게 참가한 플레이어의 avatar.

 
function OnJoin(clientId, avatar) {
playerAvatars[clientId] = avatar;
}
 

OnLeave(clientId)

플레이어가 떠났을 때 실행됩니다.

• clientId : 떠난 플레이어의 clientId.

const playerAvatars = {};
 
function OnLeave(clientId) {
  delete playerAvatars[clientId];
}