net.sf.gridarta.var.daimonin.model.scripts

Class DefaultScriptedEventFactory

java.lang.Object

net.sf.gridarta.model.scripts.AbstractScriptedEventFactory<GameObject,MapArchObject,Archetype>

net.sf.gridarta.var.daimonin.model.scripts.DefaultScriptedEventFactory

All Implemented Interfaces:

ScriptedEventFactory<GameObject,MapArchObject,Archetype>

public class DefaultScriptedEventFactory
extends AbstractScriptedEventFactory<GameObject,MapArchObject,Archetype>

Implements an AbstractScriptedEventFactory for creating Crossfire related instances.

Constructor Summary

Constructors

Constructor and Description
DefaultScriptedEventFactory(@NotNull ScriptArchUtils scriptArchUtils, @NotNull java.lang.String subtypeAttribute, @NotNull GameObjectFactory<GameObject,MapArchObject,Archetype> gameObjectFactory, @NotNull ScriptedEventEditor<GameObject,MapArchObject,Archetype> scriptedEventEditor, @NotNull ArchetypeSet<GameObject,MapArchObject,Archetype> archetypeSet) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
@NotNull GameObject	newEventGameObject(int eventType) Return a new event game object for a given event type.
@NotNull ScriptedEvent<GameObject,MapArchObject,Archetype>	newScriptedEvent(GameObject event) Creates a new ScriptedEvent instance.
@NotNull ScriptedEvent<GameObject,MapArchObject,Archetype>	newScriptedEvent(int eventType, @NotNull java.lang.String pluginName, @NotNull java.lang.String scriptPath, @NotNull java.lang.String options) Creates a new ScriptedEvent instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultScriptedEventFactory

public DefaultScriptedEventFactory(@NotNull
                                   @NotNull ScriptArchUtils scriptArchUtils,
                                   @NotNull
                                   @NotNull java.lang.String subtypeAttribute,
                                   @NotNull
                                   @NotNull GameObjectFactory<GameObject,MapArchObject,Archetype> gameObjectFactory,
                                   @NotNull
                                   @NotNull ScriptedEventEditor<GameObject,MapArchObject,Archetype> scriptedEventEditor,
                                   @NotNull
                                   @NotNull ArchetypeSet<GameObject,MapArchObject,Archetype> archetypeSet)

Creates a new instance.

Parameters:

scriptArchUtils - the script arch utils instance to use

subtypeAttribute - the attribute name for the subtype field

gameObjectFactory - the game object factory for creating game objects

scriptedEventEditor - the scripted event editor to use

archetypeSet - the archetype set to use

Method Detail

newScriptedEvent

@NotNull
public @NotNull ScriptedEvent<GameObject,MapArchObject,Archetype> newScriptedEvent(int eventType,
                                                                                            @NotNull
                                                                                            @NotNull java.lang.String pluginName,
                                                                                            @NotNull
                                                                                            @NotNull java.lang.String scriptPath,
                                                                                            @NotNull
                                                                                            @NotNull java.lang.String options)
                                                                                     throws UndefinedEventArchetypeException

Description copied from interface: ScriptedEventFactory

Creates a new ScriptedEvent instance.

Parameters:

eventType - type of the event

pluginName - name of the plugin

scriptPath - path to the file for this event

options - the options for this event

Returns:

the new instance

Throws:

UndefinedEventArchetypeException - In case there is no Archetype to create a ScriptedEvent.

newScriptedEvent

@NotNull
public @NotNull ScriptedEvent<GameObject,MapArchObject,Archetype> newScriptedEvent(GameObject event)

Description copied from interface: ScriptedEventFactory

Creates a new ScriptedEvent instance.

Parameters:

event - the event game object

Returns:

the new instance

newEventGameObject

@NotNull
public @NotNull GameObject newEventGameObject(int eventType)
                                                throws UndefinedEventArchetypeException

Description copied from interface: ScriptedEventFactory

Return a new event game object for a given event type.

Specified by:

newEventGameObject in interface ScriptedEventFactory<GameObject,MapArchObject,Archetype>

Overrides:

newEventGameObject in class AbstractScriptedEventFactory<GameObject,MapArchObject,Archetype>

Parameters:

eventType - the event type

Returns:

the new event game object

Throws:

UndefinedEventArchetypeException - if the event game object cannot be created