Mike Thomas
57f020afb8
git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@970 ed5b42cb-e716-0410-a449-f6a68f950b19
67 lines
2.4 KiB
ActionScript
67 lines
2.4 KiB
ActionScript
//
|
|
// Nenya library - tools for developing networked games
|
|
// Copyright (C) 2002-2010 Three Rings Design, Inc., All Rights Reserved
|
|
// http://www.threerings.net/code/nenya/
|
|
//
|
|
// 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.cast {
|
|
|
|
/**
|
|
* Makes available a collection of character components and associated metadata. Character
|
|
* components are animated sequences that can be composited together to create a complete
|
|
* character visualization (imagine interchanging pairs of boots, torsos, hats, etc.).
|
|
*/
|
|
public interface ComponentRepository
|
|
{
|
|
/**
|
|
* Returns the {@link CharacterComponent} object for the given component identifier.
|
|
*/
|
|
function getComponent (componentId :int) :CharacterComponent;
|
|
|
|
/**
|
|
* Returns the {@link CharacterComponent} object with the given component class and name.
|
|
*/
|
|
function getComponentByName (className :String, compName :String) :CharacterComponent;
|
|
|
|
/**
|
|
* Returns the {@link ComponentClass} with the specified name or null if none exists with that
|
|
* name.
|
|
*/
|
|
function getComponentClass (className :String) :ComponentClass;
|
|
|
|
/**
|
|
* Iterates over the {@link ComponentClass} instances representing all available character
|
|
* component classes.
|
|
*/
|
|
function getComponentClasses () :Array;
|
|
|
|
/**
|
|
* Iterates over the {@link ActionSequence} instances representing every available action
|
|
* sequence.
|
|
*/
|
|
function getActionSequences () :Array;
|
|
|
|
/**
|
|
* Iterates over the component ids of all components in the specified class.
|
|
*/
|
|
function getComponentIds (compClass :ComponentClass) :Array;
|
|
|
|
/**
|
|
* Loads up all the specified components and calls notify() when done.
|
|
*/
|
|
function load (compIds :Array, notify :Function) :void;
|
|
}
|
|
} |