Behold Vilya, Ring of Air and repository for our game and virtual worldly

extensions to the distributed environment provided by Narya. git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@1 c613c5cb-e716-0410-b11b-feb51c14d237
2006-06-23 17:58:11 +00:00
commit a4df87e52f
317 changed files with 45818 additions and 0 deletions
@@ -0,0 +1,67 @@
+//
+// $Id: ZoneService.java 4145 2006-05-24 01:24:24Z ray $
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
+// http://www.threerings.net/code/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.whirled.zone.client;
+
+import com.threerings.presents.client.Client;
+import com.threerings.presents.client.InvocationService;
+
+import com.threerings.crowd.data.PlaceConfig;
+import com.threerings.whirled.data.SceneModel;
+import com.threerings.whirled.data.SceneUpdate;
+
+import com.threerings.whirled.zone.data.ZoneSummary;
+
+/**
+ * Defines the client interface to the zone related invocation services
+ * (e.g. moving between zones).
+ */
+public interface ZoneService extends InvocationService
+{
+    /** Used to deliver responses to {@link #moveTo} requests. */
+    public static interface ZoneMoveListener extends InvocationListener
+    {
+        public void moveSucceeded (
+            int placeId, PlaceConfig config, ZoneSummary summary);
+
+        public void moveSucceededWithUpdates (
+            int placeId, PlaceConfig config, ZoneSummary summary,
+            SceneUpdate[] updates);
+
+        public void moveSucceededWithScene (
+            int placeId, PlaceConfig config, ZoneSummary summary,
+            SceneModel model);
+    }
+
+    /**
+     * Requests that that this client's body be moved to the specified
+     * scene in the specified zone.
+     *
+     * @param zoneId the zone id to which we want to move.
+     * @param sceneId the scene id to which we want to move.
+     * @param version the version number of the scene object that we have
+     * in our local repository.
+     * @param listener the object that will receive the callback when the
+     * request succeeds or fails.
+     */
+    public void moveTo (Client client, int zoneId, int sceneId,
+                        int version, ZoneMoveListener listener);
+}