Gridarta Editor
AbstractScriptedEventFactory.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.model.scripts;
21 
28 import org.jetbrains.annotations.NotNull;
29 
34 public abstract class AbstractScriptedEventFactory<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements ScriptedEventFactory<G, A, R> {
35 
39  @NotNull
41 
46  @NotNull
48 
52  @NotNull
54 
63  this.scriptArchUtils = scriptArchUtils;
64  this.gameObjectFactory = gameObjectFactory;
65  this.archetypeSet = archetypeSet;
66  }
67 
68  @NotNull
69  @Override
70  public G newEventGameObject(final int eventType) throws UndefinedEventArchetypeException {
71  final String eventArchetypeName = scriptArchUtils.getArchetypeNameForEventType(eventType);
72  final R eventArchetype;
73  try {
74  eventArchetype = archetypeSet.getArchetype(eventArchetypeName);
75  } catch (final UndefinedArchetypeException ex) {
76  throw new UndefinedEventArchetypeNameException(eventArchetypeName, ex);
77  }
78  return gameObjectFactory.createGameObject(eventArchetype);
79  }
80 
81 }
net.sf.gridarta.model.scripts.ScriptedEventFactory
Factory for creating ScriptedEvent instances.
Definition: ScriptedEventFactory.java:31
net.sf.gridarta.model.gameobject.GameObjectFactory
Abstract factory for creating GameObject instances.
Definition: GameObjectFactory.java:31
net.sf.gridarta.model.archetypeset.ArchetypeSet.getArchetype
R getArchetype(@NotNull String archetypeName)
Returns an Archetype by its name.
net.sf.gridarta.model.scripts.AbstractScriptedEventFactory.newEventGameObject
G newEventGameObject(final int eventType)
Definition: AbstractScriptedEventFactory.java:70
net.sf.gridarta.model.scripts.AbstractScriptedEventFactory.AbstractScriptedEventFactory
AbstractScriptedEventFactory(@NotNull final ScriptArchUtils scriptArchUtils, @NotNull final GameObjectFactory< G, A, R > gameObjectFactory, @NotNull final ArchetypeSet< G, A, R > archetypeSet)
Creates a new instance.
Definition: AbstractScriptedEventFactory.java:62
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.archetype.UndefinedArchetypeException
Exception thrown if an Archetype does not exist.
Definition: UndefinedArchetypeException.java:28
net.sf.gridarta.model.scripts.UndefinedEventArchetypeNameException
This class implements an UndefinedEventArchetypeException that describes a missing archetype.
Definition: UndefinedEventArchetypeNameException.java:29
net.sf
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.model.scripts.ScriptArchUtils
Definition: ScriptArchUtils.java:26
net.sf.gridarta.model.scripts.ScriptArchUtils.getArchetypeNameForEventType
String getArchetypeNameForEventType(int eventType)
Returns the archetype for an event type.
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.model.scripts.UndefinedEventArchetypeException
This exception is thrown if an event game object cannot be created.
Definition: UndefinedEventArchetypeException.java:29
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.gameobject.GameObjectFactory.createGameObject
G createGameObject(@NotNull R archetype)
Creates a new GameObject from an Archetype.
net.sf.gridarta.model.archetypeset.ArchetypeSet
Interface that captures similarities between different ArchetypeSet implementations.
Definition: ArchetypeSet.java:37
net.sf.gridarta.model.scripts.AbstractScriptedEventFactory.archetypeSet
final ArchetypeSet< G, A, R > archetypeSet
The ArchetypeSet to use.
Definition: AbstractScriptedEventFactory.java:53
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.scripts.AbstractScriptedEventFactory.scriptArchUtils
final ScriptArchUtils scriptArchUtils
The ScriptArchUtils instance to use.
Definition: AbstractScriptedEventFactory.java:40
net.sf.gridarta.model.archetypeset
Definition: ArchetypeSet.java:20
net.sf.gridarta.model.scripts.AbstractScriptedEventFactory.gameObjectFactory
final GameObjectFactory< G, A, R > gameObjectFactory
The GameObjectFactory for creating GameObjects.
Definition: AbstractScriptedEventFactory.java:47
net.sf.gridarta.model.scripts.AbstractScriptedEventFactory
Abstract base class forScriptedEventFactory implementations.
Definition: AbstractScriptedEventFactory.java:34