Нативные курсоры. Делаем!

В этой записи решил рассказать о нативных курсорах на Flash платформе. О их преимуществах и собственно как их реализовать.

Часто стал замечал, что во многих играх разработчики используют свои курсоры. Особенно если игра не может обойтись обычным системным курсором (различные квесты, hiden objects и другие игры где нужно менять состояние курсора для большей интуитивности в игре). Это безусловно можно отнести к плюсам конечной игры. Но, то что мне не нравится в таком подходе, так это подтормаживание тех самых курсоров. Возможно через 10 минут игры об этом и забывается, но поначалу приходят только негативные эмоции, т.к. кажется, что игра работает не на максимуме FPS.

Также в играх, где пользователю приходится что-то быстро нажимать и на что-то быстро реагировать мышкой, геймплей начинает казаться слегка замедленным, будто желе двигаешь, а не мышь:) Этот неприятный эффект мы и попытаемся устранить.

---

Это как?

Всего есть 2 способа заменить системный белый курсор своим:

1. Мы создаем MovieClip, добавляем событие MOUSE_MOVE (которое возникает при движении мыши) и дальше просто присваиваем координаты нашему курсору

   Mouse.hide(); //Прячем системный курсор
   
   myCursor = new MyCursor(); // Создаем свой
   addChild(myCursor);
   
   addEventListener(MouseEvent.MOUSE_MOVE, mouseMove); // Добавляем слушатель события
   
   private function mouseMove(e:MouseEvent):void {
           myCursor.x = e.stageX; // Задаем x нашему курсору
           myCursor.y = e.stageY; // Задаем y нашему курсору
           e.updateAfterEvent(); // Дополнительно делаем обновление
   }

   //И хоть мы дополнительно вызываем метод updateAfterEvent(), 100% скорости курсора этим способом не добиться.

2. Второй способ намного лучше первого. С его помощью можно добиться идеальной скорости курсора. Функционал для данного метода добавлен уже в 10.2 версии флешплеера, но как и писал выше не многие им пользуются. Этот способ мы и будем реализовывать. Идем дальше.

---

Наглядный пример

Я думаю тут сразу можно заметить преимущества нативного курсора 
над курсором реализованным способом MOUSE_MOVE.

---

Как сделать?

Способ прост. Создается объект MouseCursorData, в его свойство data передается Vector из BitmapData. Одна BitmapData – 1 кадр. Если она единственная в векторе, то курсор будет статичным. После курсор надо всего лишь зарегистрировать.

Но вам не придется в этом копаться. Как это бывает, когда в процессе игры наткнешься на то, что нужно доработать/оптимизировать, то через пару дней всё таки напишешь класс, чтобы всё это удобно использовать. Вот я и написал несколько классов и поделюсь ими, возможно они кому-то облегчат работу с нативными курсорами.

---

Как использовать?

addCursor(MyCursor, "MY_CURSOR");

• MyCursor – класс нашего курсора. Его не надо создавать, просто передавать ссылку например из вашего .swc или же ссылку на embed класс.
• «MY_CURSOR» – имя нашего курсора. Может быть любым. В дальнейшем оно служит для переключения курсоров (если их больше одного).

changeCursor("MY_CURSOR"); //Включает указанный курсор.

И вот наконец минимальный код который нужен для того чтобы добавить и включить наш курсор.

import com.remindgames.ui.RemindCursors;

_cursorsNative = new RemindCursors(); // Создаем класс для работы с нативными курсорами
_cursorsNative.addCursor(UI_CursorNative, "MY_CURSOR"); // Добавляем наш курсор и даем ему имя
_cursorsNative.changeCursor("MY_CURSOR"); // Включаем курсор
// Всё!:) Курсор уже работает

---

Дополнительно

Дабы еще удобней это всё использовать, добавил в этот мини-фреймворк пару нужных вещей.

removeCursor($name:String); //Удаляет курсор по заданному имени

removeCursorAt($id:int); //Удаляет курсор по заданному индексу

removeAllCursors(); //Удаляет все ранее добавленные курсоры

currentCursorName //Имя текущего курсора

numCursors //Текущее кол-во добавленных курсоров

И напоследок:

setButtonCursor($mainCursorName:String, $buttonCursorName: String,
                   $stage:Stage, $buttonCursorClass: Class = null);

Задает курсор для кнопок

• $mainCursorName – имя основного курсора
• $buttonCursorName – имя курсора, который будет использоваться при наведении на кнопки
• $stage ссылка на наш stage
• $buttonCursorClass – класс кнопок. Если не задан, то будет SimpleButton

resetButtonCursor(); //Чтобы сбросить настройки для кнопок

Пример использования setButtonCursor();

---

Исходники RemindCursors
Для использования поместите папку ‘com’ в ваш проект
Надеюсь это облегчит работу с курсорами. Удачи!