قفل اشاره‌گر و کنترل‌های تیرانداز طرف اول

مقدمه

‫Pointer Lock API به پیاده‌سازی صحیح کنترل‌های تیرانداز طرف اول در بازی مرورگر کمک می‌کند. بدون حرکت نسبی موشواره، مکان‌نمای بازیکن ممکن است، برای مثال، به لبه سمت راست صفحه برخورد کند و هر حرکت دیگری به سمت راست نادیده گرفته شود - نمای بازی دیگر به سمت راست حرکت نمی‌کند و بازیکن نمی‌تواند دشمنان را تعقیب کند و با مسلسل به آن‌ها شلیک کند. بازیکن قرار است کشته شود و ناامید شود. با قفل اشاره‌گر، این رفتار نامطلوب نمی‌تواند اتفاق بیفتد.

Pointer Lock API به برنامه شما اجازه می‌دهد کارهای زیر را انجام دهد:

  • دسترسی به داده‌های خام موشواره ازجمله حرکات نسبی موشواره
  • هدایت کردن همه رویدادهای موشواره به عنصری خاص

به‌عنوان عارضه جانبی فعال کردن قفل اشاره‌گر، مکان‌نمای موشواره پنهان می‌شود و به شما امکان می‌دهد درصورت تمایل، اشاره‌گر خاص برنامه را انتخاب کنید یا اشاره‌گر موشواره را پنهان بگذارید تا کاربر بتواند قاب را با موشواره حرکت دهد. حرکت نسبی موشواره عبارت است از دلتای موقعیت اشاره‌گر موشواره از قاب قبلی، صرف‌نظر از موقعیت مطلق. برای مثال، اگر اشاره‌گر موشواره از (۶۴۰، ۴۸۰) به (۵۲۰، ۴۹۰) حرکت کند، حرکت نسبی (۱۰، ۱۲۰-) است. برای مشاهده نمونه تعاملی که دلتاهای موقعیت خام موشواره را نشان می‌دهد، به زیر مراجعه کنید.

این آموزش گام‌به‌گام دو موضوع را پوشش می‌دهد: اصول اولیه فعال‌سازی و پردازش رویدادهای قفل اشاره‌گر، و پیاده‌سازی طرح کنترل تیرانداز اول شخص. That's right, when you're finished reading this article you will know how to use pointer lock and implement Quake-style controls for your very own browser game!

سازگاری مرورگر

Browser Support

  • Chrome: 37.
  • Edge: 13.
  • Firefox: 50.
  • Safari: 10.1.

Source

مکانیک قفل اشاره‌گر

تشخیص ویژگی

برای تعیین اینکه آیا مرورگر کاربر از قفل اشاره‌گر پشتیبانی می‌کند یا نه، باید pointerLockElement یا نسخه پیشوند فروشنده را در شیء سند بررسی کنید. در کد:

var havePointerLock = 'pointerLockElement' in document ||
    'mozPointerLockElement' in document ||
    'webkitPointerLockElement' in document;

درحال‌حاضر قفل اشاره‌گر فقط در Firefox و Chrome دردسترس است. Opera و IE هنوز از آن پشتیبانی نمی‌کنند.

درحال فعال‌سازی

فعال کردن قفل اشاره‌گر فرایندی دو مرحله‌ای است. ابتدا برنامه شما درخواست می‌کند که قفل اشاره‌گر برای عنصر خاصی فعال شود و بلافاصله پس‌از اینکه کاربر اجازه داد، رویداد pointerlockchange فعال می‌شود. کاربر می‌تواند هروقت خواست با فشار دادن کلید گریز، قفل اشاره‌گر را لغو کند. برنامه‌تان همچنین می‌تواند به‌صورت برنامه‌نویسی‌شده از قفل اشاره‌گر خارج شود. وقتی قفل اشاره‌گر لغو می‌شود، رویداد pointerlockchange اجرا می‌شود.

element.requestPointerLock = element.requestPointerLock ||
                 element.mozRequestPointerLock ||
                 element.webkitRequestPointerLock;
// Ask the browser to lock the pointer
element.requestPointerLock();

// Ask the browser to release the pointer
document.exitPointerLock = document.exitPointerLock ||
               document.mozExitPointerLock ||
               document.webkitExitPointerLock;
document.exitPointerLock();

کد بالا تنها چیزی است که لازم دارید. وقتی مرورگر اشاره‌گر را قفل می‌کند، حبابی بالا می‌آید که به کاربر اطلاع می‌دهد برنامه شما اشاره‌گر را قفل کرده است و به او می‌گوید که می‌تواند با فشار دادن کلید «Esc» آن را لغو کند.

نوار اطلاعات «قفل اشاره‌گر» در Chrome.
نوار اطلاعات «قفل اشاره‌گر» در Chrome.

مدیریت رویداد

دو رویداد وجود دارد که برنامه شما باید برای آن‌ها شنونده اضافه کند. اولین مورد pointerlockchange است که هرگاه تغییری در وضعیت قفل اشاره‌گر رخ دهد، فعال می‌شود. دومی mousemove است که هر زمان موشواره حرکت کند فعال می‌شود.

// Hook pointer lock state change events
document.addEventListener('pointerlockchange', changeCallback, false);
document.addEventListener('mozpointerlockchange', changeCallback, false);
document.addEventListener('webkitpointerlockchange', changeCallback, false);

// Hook mouse move events
document.addEventListener("mousemove", this.moveCallback, false);

در pointerlockchange callback خود باید بررسی کنید که آیا اشاره‌گر به‌تازگی قفل یا باز شده است. تعیین اینکه آیا قفل اشاره‌گر فعال شده است یا نه ساده است: بررسی کنید که آیا document.pointerLockElement با عنصری که قفل اشاره‌گر برای آن درخواست شده است برابر است یا نه. اگر این‌طور باشد، برنامه شما باموفقیت اشاره‌گر را قفل کرده است و اگر این‌طور نباشد، اشاره‌گر توسط کاربر یا کد خودتان باز شده است.

if (document.pointerLockElement === requestedElement ||
  document.mozPointerLockElement === requestedElement ||
  document.webkitPointerLockElement === requestedElement) {
  // Pointer was just locked
  // Enable the mousemove listener
  document.addEventListener("mousemove", this.moveCallback, false);
} else {
  // Pointer was just unlocked
  // Disable the mousemove listener
  document.removeEventListener("mousemove", this.moveCallback, false);
  this.unlockHook(this.element);
}

وقتی قفل اشاره‌گر فعال باشد، clientX، clientY، screenX، و screenY ثابت می‌مانند. ‫movementX و movementY با تعداد پیکسل‌هایی که اشاره‌گر از زمان ارسال آخرین رویداد جابه‌جا شده است به‌روز می‌شوند. در شبه‌کد:

event.movementX = currentCursorPositionX - previousCursorPositionX;
event.movementY = currentCursorPositionY - previousCursorPositionY;

درون mousemove، داده‌های حرکت نسبی موشواره را می‌توان از فیلدهای movementX و movementY رویداد استخراج کرد.

function moveCallback(e) {
  var movementX = e.movementX ||
      e.mozMovementX          ||
      e.webkitMovementX       ||
      0,
  movementY = e.movementY ||
      e.mozMovementY      ||
      e.webkitMovementY   ||
      0;
}

گرفتن خطاها

اگر هنگام ورود یا خروج از قفل اشاره‌گر خطایی رخ دهد، رویداد pointerlockerror فعال می‌شود. هیچ داده‌ای به این رویداد پیوست نشده است.

document.addEventListener('pointerlockerror', errorCallback, false);
document.addEventListener('mozpointerlockerror', errorCallback, false);
document.addEventListener('webkitpointerlockerror', errorCallback, false);

تمام‌صفحه لازم است؟

در ابتدا قفل اشاره‌گر به FullScreen API گره خورده بود. یعنی عنصر باید در حالت تمام‌صفحه باشد تا بتوان اشاره‌گر را روی آن قفل کرد. این دیگر درست نیست و می‌توان از قفل اشاره‌گر برای هر عنصری در برنامه شما، چه تمام‌صفحه باشد چه نباشد، استفاده کرد.

نمونه کنترل‌های تیرانداز اول شخص

اکنون که قفل اشاره‌گر را فعال کرده‌ایم و رویدادها را دریافت می‌کنیم، وقت آن است که یک مثال کاربردی را بررسی کنیم. تاکنون خواسته‌اید بدانید کنترل‌های Quake چگونه کار می‌کنند؟ کمربندهایتان را ببندید چون می‌خواهم آن‌ها را با کد توضیح دهم!

کنترل‌های تیرانداز اول شخص براساس چهار مکانیک اصلی ساخته شده‌اند:

  • حرکت به جلو و عقب در امتداد بردار نگاه فعلی
  • حرکت به چپ و راست در امتداد بردار رگبار فعلی
  • چرخاندن زاویه انحراف نما (چپ و راست)
  • چرخاندن زاویه نما (بالا و پایین)

بازی‌ای که این طرح کنترل را پیاده‌سازی می‌کند فقط به سه قطعه داده نیاز دارد: موقعیت دوربین، بردار دید دوربین، و بردار ثابت بالا. بردار بالا همیشه (0, 1, 0) است. هر چهار مکانیک بالا فقط موقعیت دوربین و بردار دید دوربین را به روش‌های مختلف دستکاری می‌کنند.

جنبش

اولین مورد در دستور کار، حرکت است. در نسخه نمایشی زیر، حرکت به کلیدهای استاندارد W،‏ A،‏ S، و D نگاشت شده است. کلیدهای W و S دوربین را به جلو و عقب می‌برند. و کلیدهای A و D دوربین را به چپ و راست هدایت می‌کنند. حرکت دادن دوربین به جلو و عقب ساده است:

// Forward direction
var forwardDirection = vec3.create(cameraLookVector);
// Speed
var forwardSpeed = dt * cameraSpeed;
// Forward or backward depending on keys held
var forwardScale = 0.0;
forwardScale += keyState.W ? 1.0 : 0.0;
forwardScale -= keyState.S ? 1.0 : 0.0;
// Scale movement
vec3.scale(forwardDirection, forwardScale * forwardSpeed);
// Add scaled movement to camera position
vec3.add(cameraPosition, forwardDirection);

برای حرکت به چپ و راست، باید جهت حرکت مشخص شود. جهت حرکت جانبی را می‌توان بااستفاده از ضرب خارجی محاسبه کرد:

// Strafe direction
var strafeDirection = vec3.create();
vec3.cross(cameraLookVector, cameraUpVector, strafeDirection);

وقتی جهت حرکت جانبی را مشخص کردید، پیاده‌سازی حرکت جانبی مانند حرکت به جلو یا عقب است.

مرحله بعدی چرخاندن نما است.

انحراف از مسیر

انحراف یا چرخش افقی نمای دوربین فقط یک چرخش حول بردار ثابت بالا است. در زیر کد کلی برای چرخاندن بردار دید دوربین حول یک محور دلخواه آورده شده است. این کار با ساختن یک کواترنیون که نشان‌دهنده چرخش رادیان‌های deltaAngle در اطراف axis است انجام می‌شود و سپس از کواترنیون برای چرخاندن بردار نگاه دوربین استفاده می‌کند:

// Extract camera look vector
var frontDirection = vec3.create();
vec3.subtract(this.lookAtPoint, this.eyePoint, frontDirection);
vec3.normalize(frontDirection);
var q = quat4.create();
// Construct quaternion
quat4.fromAngleAxis(deltaAngle, axis, q);
// Rotate camera look vector
quat4.multiplyVec3(q, frontDirection);
// Update camera look vector
this.lookAtPoint = vec3.create(this.eyePoint);
vec3.add(this.lookAtPoint, frontDirection);

زیر و بمی صدا

پیاده‌سازی گام یا چرخش عمودی نمای دوربین مشابه است، اما به‌جای چرخش حول بردار بالا، چرخش را حول بردار حرکت جانبی اعمال می‌کنید. اولین قدم محاسبه بردار حرکت جانبی و سپس چرخاندن بردار نگاه دوربین حول آن محور است.

خلاصه

‫Pointer Lock API به شما امکان می‌دهد کنترل مکان‌نمای موشواره را دردست بگیرید. اگر بازی‌های تحت وب می‌سازید، بازیکنان شما از اینکه دیگر به‌دلیل حرکت هیجان‌زده موشواره به خارج از پنجره و توقف دریافت به‌روزرسانی‌های موشواره توسط بازی شما کشته نمی‌شوند، خوشحال خواهند شد. استفاده از آن ساده است:

  • افزودن شنونده رویداد pointerlockchange برای ردیابی وضعیت قفل اشاره‌گر
  • درخواست قفل اشاره‌گر برای عنصر خاص
  • افزودن شنونده رویداد mousemove برای دریافت به‌روزرسانی‌ها

نسخه‌های نمایشی خارجی

مرجع‌ها