Properly document our event.

git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@202 ed5b42cb-e716-0410-a449-f6a68f950b19
This commit is contained in:
Ray Greenwell
2007-04-19 23:12:53 +00:00
parent 488d47262b
commit 54290011ae
+12 -1
View File
@@ -57,6 +57,14 @@ import com.threerings.util.StringUtil;
import com.threerings.util.ValueEvent;
import com.threerings.util.Util;
/**
* Dispatched when the size of the media being loaded is known.
*
* @eventType com.threerings.flash.MediaContainer.SIZE_KNOWN
*/
[Event(name="mediaSizeKnown", type="com.threerings.util.ValueEvent")]
/**
* A wrapper class for all media that will be placed on the screen.
* Subject to change.
@@ -64,7 +72,10 @@ import com.threerings.util.Util;
public class MediaContainer extends Sprite
{
/** A ValueEvent we dispatch when our size is known.
* Value: [ width, height ]. */
* Value: [ width, height ].
*
* @eventType mediaSizeKnown
*/
public static const SIZE_KNOWN :String = "mediaSizeKnown";
/** A log instance that can be shared by sprites. */