Package net.sf.gridarta.model.scripts

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

All Known Implementing Classes:

AbstractScriptedEventFactory, DefaultScriptedEventFactory, DefaultScriptedEventFactory, DefaultScriptedEventFactory

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

Factory for creating ScriptedEvent instances.

Method Summary

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

Method Detail

newScriptedEvent

@NotNull
@NotNull ScriptedEvent<G,A,R> newScriptedEvent(int eventType,
                                                           @NotNull
                                                           @NotNull java.lang.String pluginName,
                                                           @NotNull
                                                           @NotNull java.lang.String scriptPath,
                                                           @NotNull
                                                           @NotNull java.lang.String options)
                                                    throws UndefinedEventArchetypeException

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
@NotNull ScriptedEvent<G,A,R> newScriptedEvent(G event)

Creates a new ScriptedEvent instance.

Parameters:

event - the event game object

Returns:

the new instance

newEventGameObject

@NotNull
G newEventGameObject(int eventType)
              throws UndefinedEventArchetypeException

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

Parameters:

eventType - the event type

Returns:

the new event game object

Throws:

UndefinedEventArchetypeException - if the event game object cannot be created