From 6f9136d109b785af68c1be91be99ea0fd0abf85f Mon Sep 17 00:00:00 2001 From: Ray Greenwell Date: Thu, 5 Oct 2006 00:30:15 +0000 Subject: [PATCH] A few comments. git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@93 c613c5cb-e716-0410-b11b-feb51c14d237 --- src/as/com/threerings/ezgame/EZGame.as | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/as/com/threerings/ezgame/EZGame.as b/src/as/com/threerings/ezgame/EZGame.as index 461a79e6..8f0bdd0c 100644 --- a/src/as/com/threerings/ezgame/EZGame.as +++ b/src/as/com/threerings/ezgame/EZGame.as @@ -53,6 +53,15 @@ public interface EZGame * Pick (do not remove) the specified number of elements from a collection, * and distribute them to a specific player or set them as a property * in the game data. + * + * @param collName the collection name. + * @param count the number of elements to pick + * @param msgOrPropName the name of the message or property + * that will contain the picked elements. + * @param playerIndex if -1 (or unset), the picked elements should be + * set on the gameObject as a property for all to see. + * If a playerIndex is specified, only that player will receive + * the elements as a message. */ // TODO: a way to specify exclusive picks vs. duplicate-OK picks? function pickFromCollection ( @@ -63,6 +72,15 @@ public interface EZGame * Deal (remove) the specified number of elements from a collection, * and distribute them to a specific player or set them as a property * in the game data. + * + * @param collName the collection name. + * @param count the number of elements to pick + * @param msgOrPropName the name of the message or property + * that will contain the picked elements. + * @param playerIndex if -1 (or unset), the picked elements should be + * set on the gameObject as a property for all to see. + * If a playerIndex is specified, only that player will receive + * the elements as a message. */ // TODO: figure out the method signature of the callback function dealFromCollection (