Сохранение и загрузка пользовательских уровней

Всем еще раз привет :-)

Сегодня я расскажу как делал сохранение уровней на сервере.

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

Это наверное не имеет отношения к сохранению уровней на сервер, но я расскажу :-) Объекты каждого типа у меня лежат внутри объекта типа Sprite, которые уже лежат внутри общего спрайта игры. Сохранение уровней это обход каждого из этих спрайтов с помощью замечательных функций numChildren и getChildAt и запись параметров объектов в xml. После этого с помощью прекрасных функций объекта ByteArray writeUTFBytes и compress, а также надыбанной где-то по блогам библиотеки as3base64 получается не очень большая, но очень страшная вид строка.

Загрузить эту строчку совсем не сложно. Надо ее обратно раскодировать, разжать и распарсить в xml, а потом обойти все узлы и создать соответствующие объекты.

В любом случае у вас это может быть и как-то по другому сделано.

Теперь собственно к сути. Когда я понял, что мне хочется отдать редактор в пользование людям, мне стало также ясно и то, что отдавать его с сохранением только в такую строчку, которую юзер может себе где-то заныкать — это не дело. И тогда я стал думать как быть. Своего сервера у меня не то, что нет: есть дешевый шаред хостинг, но нагружать его хранением уровнями я не хотел, он мог бы и не выдержать, или денег начать просить. Заводить свой сервер ради этого тоже не хотелось. Можно было ждать спонсора предлагать ему сделать, обсуждать его апи и т.д. — все очень заморочено и с большой вероятностью вообще не выйдет.

На всякий случай для слабых духом сообщаю: есть такой playtomic.com, бывший swfstats, там есть сервис по хранению уровней. И рейтингов к этим уровням, и все для броузинга по этим уровням. Пока бесплатно, но могут начать брать деньги в любой момент. Короче знайте, если не хотите делать сами — варианты есть :-)

Я же испугался возможной платности, к тому же было интересно сделать самому. Давно заглядывался на Google App Engine. По моим прикидкам нагрузка должна уложится в бесплатные квоты: особой популярности сохранения и игры в пользовательские уровни я не ожидаю. Да и вообще очень уж какой-то популярности своей игры не жду к сожалению, слишком много думать надо. Дайте мне другой народ, как говорится :-)

В общем зарегистрировался я на сайте. Спросили телефон, прислали смс. Скачал SDK. Заставили поставить python 2.5. Он перекрыл собой стоявший уже 2.6 :-( теперь все скрипты запускаются в 2.5. Я пока не разбирался что с этим делать. Но пару скриптов уже пришлось исправлять, т.к. использовались вкусняшки, которых нет в 2.5. Вот такой я ленивый.

SDK сразу включает в себя красивую панельку, из которой можно создать приложение, запустить сервер, загрузить приложение в гугл. Полез на сайт в помощь. Взял какой-то самый первый пример и переделал под себя. Читайте код и коменты.

from google.appengine.ext import webapp
from google.appengine.ext.webapp.util import run_wsgi_app
from google.appengine.ext import db
import random
import string
from datetime import datetime

#Описание полей таблицы базы данных, она у нас одна пока
class Levels(db.Model):
  code = db.StringProperty() # Уникальная часть URL. 5 случайных символов плюс id. Случайные символы нужны, чтоб нельзя было просто перебирать номера.
  dateAdded = db.DateTimeProperty() # дата добавления
  lastDatePlayed = db.DateTimeProperty() # дата игры, обновляется при каждой загрузке
  plays = db.IntegerProperty() # количество игр
  data = db.TextProperty() # собственно данные уровня

#Зовем каждый раз, когда нам нечего сказать. Возможно это и не так положено делать.
def Error404(response):
  response.set_status(404)
  #response.out.write("Nothing here!!!")
  return
  
#По коду (см.описание выше) находим уровень в бд. Отрезаем 5 символов и ищем по id, потом сравниваем 5 символов.
def GetLevelByCode(code):
  id = int(code[5:])
  level = Levels.get_by_id(id)
  if level is None or level.code != code:
    return
  else:
    return level
  
#Это форма для отладки сохранения/загрузки. Все прозрачно.    
class TestForm(webapp.RequestHandler):
  def get(self):
    self.response.out.write("""
<form action="/savelevel" method="post">
  <input type="text" name="data">
  
  <input type="submit" value="Send">
</form>

<form action="/loadlevel" method="post">
  <input type="text" name="code">
  
  <input type="submit" value="Send">
</form>
""")

#О, это большая хитрость. Чтобы можно было загружать контент из флеша, сервер должен это разрешить. 
class CrossDomainXML(webapp.RequestHandler):
  def get(self):
    self.response.out.write("""<?xml version="1.0"?><cross-domain-policy><allow-access-from domain="*" /></cross-domain-policy>""")    

#Класс, который используется для сохранения уровней. Его методы вызываются при запросе с url "/savelevel"
class SaveLevel(webapp.RequestHandler):
  #GET запросы не обслуживаем, чтоб школьники (и здесь они) из браузера не баловались
  def get(self):
    Error404(self.response)
  
  #POST запрос. Ожидается переменная data. Выдает код уровня на выход.
  def post(self):
  
    data = self.request.get("data")
  
    if len(data) == 0 or len(data) > 2000:
      return Error404(self.response)
  
    level = Levels()
    level.data = data
    level.dateAdded = datetime.now()   
    level.plays = 0
    level.put();
    level.code = "".join([random.choice(string.letters) for x in xrange(5)]) + str(level.key().id())
    level.put();
    self.response.out.write(level.code);
    
#Класс для загрузки уровней. URL - "/loadlevel"
class LoadLevel(webapp.RequestHandler):
  def get(self):
    Error404(self.response)
  
  #Смотрим переменную code, находим уровень, обновляем дату и количество игр, выдаем уровень на выход
  def post(self):
    code = self.request.get("code")
  
    if code is None or len(code) == 0:
      return Error404(self.response)
      
    level = GetLevelByCode(code)
    if level is None:
      return Error404(self.response)
    self.response.out.write(level.data);
    level.plays = level.plays + 1
    level.lastDatePlayed = datetime.now()
    level.put()
    
#Всякие настройки. Всё интуитивно понятно :-)
application = webapp.WSGIApplication(
                                     [
                                     ('/testform', TestForm),
                                     ('/savelevel', SaveLevel),
                                     ('/loadlevel', LoadLevel),
                                     ('/crossdomain.xml', CrossDomainXML)
                                     ],
                                     debug=True)
def main():
  random.seed()
  run_wsgi_app(application)

if __name__ == "__main__":
  main()

А в as3-проекте я сделал специальный класс-окошко, который делает запросы. Там используется мой класс SimpleUI, что он делает там везде понятно, показывать его не буду: он не хорош :-)

package  
{
        import flash.display.*;
        import flash.events.*;
        import flash.net.*;
        
        public class LevelsRequest extends Sprite
        {
                private var textObj:DisplayObject;
                private var loader:URLLoader;
                private var url:String;
                private var vars:Object;
                private var onDone:Function;
                private var onCancel:Function
                
                public function LevelsRequest(url:String, vars:Object, text:String, onDone:Function, onCancel:Function = null) 
                {
                        this.url = url;
                        this.vars = vars;
                        this.onDone = onDone;
                        this.onCancel = onCancel;
                        
                        textObj = SimpleUI.Text( { width:Main.appWidth, border: 5, text: text } );
                        
                        addChild(SimpleUI.Container( {
                                width: Main.appWidth,
                                height: Main.appHeight,
                                background: 0x808080,
                                alpha: 0.8,
                                children: [
                                        textObj, 
                                        SimpleUI.Button( { text: "Cancel", action: Cancel } )
                                        ]
                                }));
                                
                        var request:URLRequest = new URLRequest(Game.levelsDataURL + url);
                        
                        var urlVars:URLVariables = new URLVariables();
                        for (var name:String in vars)
                                urlVars[name] = vars[name];
                        
                        request.data = urlVars;
                        request.method = URLRequestMethod.POST;
                        loader = new URLLoader();
                        loader.addEventListener(Event.COMPLETE, OnLoaderComplete);
                        loader.addEventListener(IOErrorEvent.IO_ERROR, OnError);
                        loader.addEventListener(SecurityErrorEvent.SECURITY_ERROR, OnError);
                        loader.load(request);
                        
                        addEventListener(Event.REMOVED_FROM_STAGE, OnRemovedFromStage);
                }
                
                private function OnLoaderComplete(e:Event):void
                {
                        if(onDone != null)
                                onDone(loader.data);
                        if(parent)
                                parent.removeChild(this);
                }
                
                private function OnError(e:Event):void
                {
                        SimpleUI.SetText(textObj, "An error occured. Sorry :-( " + e.toString());
                }
                
                private function OnRemovedFromStage(e:Event):void
                {
                        try {
                                loader.close();
                        }
                        catch (e:*)
                        {}
                        removeEventListener(Event.REMOVED_FROM_STAGE, OnRemovedFromStage);
                        loader.removeEventListener(IOErrorEvent.IO_ERROR, OnError);
                        loader.removeEventListener(SecurityErrorEvent.SECURITY_ERROR, OnError);
                        loader.removeEventListener(Event.COMPLETE, OnLoaderComplete);
                }
                
                private function Cancel():void
                {
                        if (onCancel != null)
                                onCancel();
                        if(parent)
                                parent.removeChild(this);
                }
        }
        
}

Пример вызова этого класса такой:

//загрузка
function StartCustomGame(levelData:String):void {}
function ShowMainMenu():void {}
addChild(new LevelsRequest("/loadlevel", { code:levelcode }, "Loading level...", StartCustomGame, ShowMainMenu));

//сохранение
function ShowTextBoxWithURL(levelCode:String):void { /*здесь что-то типа MessageBox("sponsor.com/game?level="+levelCode) */}
var levelData:String;
addChild(new LevelsRequest("/savelevel", { data:levelData }, "Saving your level", ShowTextBoxWithURL);

Почти всё! Но есть маленькая проблема: как нам узнать, что пользователь хочет загрузить уровень? Можно уповать на то, что удастся договориться со спонсором и он сам распарсит URL и поместит код во flashVars, откуда мы его достанем. Но не будем ждать милостей от природы: на просторах интернета учат, что есть способ получить url страницы, на которой заэмбеден наш swf. Способ прост как три копейки:

var pageURL:String = ExternalInterface.call('eval', 'window.location.href');

Только в try/catch обернуть — и готово. Потом надо просто этот pageURL при старте флешки распарсить:

var re:RegExp = /loadlevel=([a-zA-Z0-9]+)/;
var result:Array = pageURL.match(re);
if (result == null || result.length != 2)
//нормальный запуск игры
else
//загрузка уровня, код которого в result[1]

За сим прощаюсь. Но не навсегда :-)

P.S. Полезное дополнение от Claymore:
Без участия спонсора может и не получится достать Url, в коде встраивания флешки доступ к выполнению скриптов должен быть разрешён

<param name="allowScriptAccess" value="always"></param>

И во флэшке не забываем прописывать

Security.allowDomain(имя_домена)