Package net.sf.gridarta.project

Interface ProjectFactory<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

All Known Subinterfaces:

EditorFactory<G,A,R>

All Known Implementing Classes:

DefaultEditorFactory, DefaultEditorFactory, DefaultEditorFactory

public interface ProjectFactory<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

A factory to create project-dependent objects.

Method Summary

Modifier and Type	Method	Description
int	getDoubleFaceOffset()	Returns the offset for drawing double faces.
boolean	getIncludeFaceNumbers()	Returns whether the face file contains face numbers.
java.lang.String	getScriptsDir()	Returns the default directory for editor scripts.
@Nullable java.lang.String	getSpellFile()	Returns the spell file name to load.
int	getSpellType()	Returns the archetype type for game object spells.
@NotNull AttributeRangeChecker<G,A,R>	loadAttributeRangeChecker(@NotNull ErrorViewCollector errorViewCollector, @NotNull GameObjectMatchers gameObjectMatchers, @NotNull ValidatorPreferences validatorPreferences)	Loads the attribute range checker for map validation.
@NotNull ArchetypeFactory<G,A,R>	newArchetypeFactory(@NotNull FaceObjectProviders faceObjectProviders, @NotNull AnimationObjects animationObjects)	Creates a new ArchetypeFactory instance.
AbstractArchetypeParser<G,A,R,?>	newArchetypeParser(@NotNull ErrorView errorView, GameObjectParser<G,A,R> gameObjectParser, AnimationObjects animationObjects, ArchetypeSet<G,A,R> archetypeSet, @NotNull GameObjectFactory<G,A,R> gameObjectFactory, @NotNull ProjectSettings projectSettings, @NotNull SmoothFaces smoothFaces)	Creates a new AbstractArchetypeParser instance.
@NotNull ArchetypeSet<G,A,R>	newArchetypeSet(@NotNull ProjectSettings projectSettings, @NotNull ArchetypeFactory<G,A,R> archetypeFactory)	Creates a new ArchetypeSet instance.
@NotNull GameObjectFactory<G,A,R>	newGameObjectFactory(@NotNull FaceObjectProviders faceObjectProviders, @NotNull AnimationObjects animationObjects, @NotNull ArchetypeTypeSet archetypeTypeSet)	Creates a new GameObjectFactory instance.
@NotNull GameObjectParserFactory<G,A,R>	newGameObjectParserFactory(@NotNull GameObjectFactory<G,A,R> gameObjectFactory, @NotNull ArchetypeSet<G,A,R> archetypeSet, @NotNull ArchetypeTypeSet archetypeTypeSet)	Creates a new GameObjectParserFactory instance.
@NotNull MapArchObjectFactory<A>	newMapArchObjectFactory(@NotNull ProjectSettings projectSettings)	Creates a new MapArchObjectFactory instance.
@NotNull MapArchObjectParserFactory<A>	newMapArchObjectParserFactory()	Creates a new MapArchObjectParserFactory instance.
@NotNull MapControlFactory<G,A,R>	newMapControlFactory(@NotNull MapWriter<G,A,R> mapWriter, @NotNull ProjectSettings projectSettings, @NotNull MapModelFactory<G,A,R> mapModelFactory)	Creates a new MapControlFactory instance.
@NotNull AbstractResources<G,A,R>	newResources(@NotNull GameObjectParser<G,A,R> gameObjectParser, @NotNull ArchetypeSet<G,A,R> archetypeSet, @NotNull AbstractArchetypeParser<G,A,R,?> archetypeParser, @NotNull FaceObjects faceObjects, @NotNull AnimationObjects animationObjects, @NotNull ArchFaceProvider archFaceProvider, @NotNull FaceObjectProviders faceObjectProviders, @NotNull SmoothFaces smoothFaces)	Creates a new AbstractResources instance.

Method Detail

getDoubleFaceOffset

int getDoubleFaceOffset()

Returns the offset for drawing double faces.

Returns:

the offset

getIncludeFaceNumbers

boolean getIncludeFaceNumbers()

Returns whether the face file contains face numbers.

Returns:

whether the face file contains face numbers

newArchetypeFactory

@NotNull
@NotNull ArchetypeFactory<G,A,R> newArchetypeFactory(@NotNull
                                                                 @NotNull FaceObjectProviders faceObjectProviders,
                                                                 @NotNull
                                                                 @NotNull AnimationObjects animationObjects)

Creates a new ArchetypeFactory instance.

Parameters:

faceObjectProviders - the face object providers for looking up faces

animationObjects - the animation objects for looking up animations

Returns:

the new instance

newGameObjectFactory

@NotNull
@NotNull GameObjectFactory<G,A,R> newGameObjectFactory(@NotNull
                                                                   @NotNull FaceObjectProviders faceObjectProviders,
                                                                   @NotNull
                                                                   @NotNull AnimationObjects animationObjects,
                                                                   @NotNull
                                                                   @NotNull ArchetypeTypeSet archetypeTypeSet)

Creates a new GameObjectFactory instance.

Parameters:

faceObjectProviders - the face object providers to use

animationObjects - the animation objects for looking up animations

archetypeTypeSet - the archetype type set for looking up archetype types

Returns:

the new instance

newArchetypeSet

@NotNull
@NotNull ArchetypeSet<G,A,R> newArchetypeSet(@NotNull
                                                         @NotNull ProjectSettings projectSettings,
                                                         @NotNull
                                                         @NotNull ArchetypeFactory<G,A,R> archetypeFactory)

Creates a new ArchetypeSet instance.

Parameters:

projectSettings - the project settings to use

archetypeFactory - the archetype factory to use

Returns:

the new instance

newGameObjectParserFactory

@NotNull
@NotNull GameObjectParserFactory<G,A,R> newGameObjectParserFactory(@NotNull
                                                                               @NotNull GameObjectFactory<G,A,R> gameObjectFactory,
                                                                               @NotNull
                                                                               @NotNull ArchetypeSet<G,A,R> archetypeSet,
                                                                               @NotNull
                                                                               @NotNull ArchetypeTypeSet archetypeTypeSet)

Creates a new GameObjectParserFactory instance.

Parameters:

gameObjectFactory - the game object parser factory to use

archetypeSet - the archetype set for looking up archetypes

archetypeTypeSet - the archetype type set for sorting attributes on save

Returns:

the new instance

newArchetypeParser

AbstractArchetypeParser<G,A,R,?> newArchetypeParser(@NotNull
                                                                      @NotNull ErrorView errorView,
                                                                      GameObjectParser<G,A,R> gameObjectParser,
                                                                      AnimationObjects animationObjects,
                                                                      ArchetypeSet<G,A,R> archetypeSet,
                                                                      @NotNull
                                                                      @NotNull GameObjectFactory<G,A,R> gameObjectFactory,
                                                                      @NotNull
                                                                      @NotNull ProjectSettings projectSettings,
                                                                      @NotNull
                                                                      @NotNull SmoothFaces smoothFaces)

Creates a new AbstractArchetypeParser instance.

Parameters:

errorView - the error view for reporting errors

gameObjectParser - the game object parser to use

animationObjects - the animation objects to use

archetypeSet - the archetype set to use

gameObjectFactory - the game object factory to use

projectSettings - the project settings to use

smoothFaces - the smooth faces to use

Returns:

the new instance

newResources

@NotNull
@NotNull AbstractResources<G,A,R> newResources(@NotNull
                                                           @NotNull GameObjectParser<G,A,R> gameObjectParser,
                                                           @NotNull
                                                           @NotNull ArchetypeSet<G,A,R> archetypeSet,
                                                           @NotNull
                                                           @NotNull AbstractArchetypeParser<G,A,R,?> archetypeParser,
                                                           @NotNull
                                                           @NotNull FaceObjects faceObjects,
                                                           @NotNull
                                                           @NotNull AnimationObjects animationObjects,
                                                           @NotNull
                                                           @NotNull ArchFaceProvider archFaceProvider,
                                                           @NotNull
                                                           @NotNull FaceObjectProviders faceObjectProviders,
                                                           @NotNull
                                                           @NotNull SmoothFaces smoothFaces)

Creates a new AbstractResources instance.

Parameters:

gameObjectParser - the game object parser to use

archetypeSet - the archetype set to use

archetypeParser - the archetype parser to use

faceObjects - the face objects to use

animationObjects - the animation objects to use

archFaceProvider - the arch face provider to use

faceObjectProviders - the face object providers for looking up faces

smoothFaces - the smooth faces to use

Returns:

the new instance

newMapArchObjectParserFactory

@NotNull
@NotNull MapArchObjectParserFactory<A> newMapArchObjectParserFactory()

Creates a new MapArchObjectParserFactory instance.

Returns:

the new instance

newMapArchObjectFactory

@NotNull
@NotNull MapArchObjectFactory<A> newMapArchObjectFactory(@NotNull
                                                         @NotNull ProjectSettings projectSettings)

Creates a new MapArchObjectFactory instance.

Parameters:

projectSettings - the project settings to use

Returns:

the new instance

loadAttributeRangeChecker

@NotNull
@NotNull AttributeRangeChecker<G,A,R> loadAttributeRangeChecker(@NotNull
                                                                            @NotNull ErrorViewCollector errorViewCollector,
                                                                            @NotNull
                                                                            @NotNull GameObjectMatchers gameObjectMatchers,
                                                                            @NotNull
                                                                            @NotNull ValidatorPreferences validatorPreferences)

Loads the attribute range checker for map validation.

Parameters:

errorViewCollector - the error view collector to use

gameObjectMatchers - the defined game object matchers

validatorPreferences - the validator preferences to use

Returns:

the loaded attribute range checker

newMapControlFactory

@NotNull
@NotNull MapControlFactory<G,A,R> newMapControlFactory(@NotNull
                                                                   @NotNull MapWriter<G,A,R> mapWriter,
                                                                   @NotNull
                                                                   @NotNull ProjectSettings projectSettings,
                                                                   @NotNull
                                                                   @NotNull MapModelFactory<G,A,R> mapModelFactory)

Creates a new MapControlFactory instance.

Parameters:

mapWriter - the map writer to use

projectSettings - the project settings to use

mapModelFactory - the map model factory to use

Returns:

the new instance

getSpellType

int getSpellType()

Returns the archetype type for game object spells.

Returns:

the archetype type or 0 to not load game object spells

getSpellFile

@Nullable
@Nullable java.lang.String getSpellFile()

Returns the spell file name to load.

Returns:

the spell file name or null to not load numbered spells

getScriptsDir

java.lang.String getScriptsDir()

Returns the default directory for editor scripts.

Returns:

the directory