net.sf.gridarta.model.scripts

Interface ScriptArchUtils

All Known Implementing Classes:

AbstractScriptArchUtils, DefaultScriptArchUtils, DefaultScriptArchUtils, DefaultScriptArchUtils

public interface ScriptArchUtils

Method Summary

Modifier and Type	Method and Description
void	addEventsToJList(javax.swing.JList list, java.lang.Iterable<? extends GameObject<?,?,?>> gameObject) Set all ScriptedEvents to appear in the given JList This method should be fast because it may be executed when user clicks on map objects.
java.lang.String	getArchetypeNameForEventType(int eventType) Returns the archetype for an event type.
java.lang.String[]	getEventNames() Returns all event names.
int	indexToEventType(int index) Converts a combo box index to an event type.
java.lang.String	typeName(int eventType) Returns a human readable name for an event type.

Method Detail

typeName

@NotNull
java.lang.String typeName(int eventType)

Returns a human readable name for an event type.

Parameters:

eventType - the event type

Returns:

the event type name

getArchetypeNameForEventType

@NotNull
java.lang.String getArchetypeNameForEventType(int eventType)
                                                throws UndefinedEventArchetypeTypeException

Returns the archetype for an event type.

Parameters:

eventType - the event type

Returns:

the archetype name

Throws:

UndefinedEventArchetypeTypeException - if the event type is undefined

indexToEventType

int indexToEventType(int index)

Converts a combo box index to an event type.

Parameters:

index - the combo box index

Returns:

the event type

getEventNames

@NotNull
java.lang.String[] getEventNames()

Returns all event names.

Returns:

all event names; the array may be modified

addEventsToJList

void addEventsToJList(@NotNull
                      javax.swing.JList list,
                      @NotNull
                      java.lang.Iterable<? extends GameObject<?,?,?>> gameObject)

Set all ScriptedEvents to appear in the given JList This method should be fast because it may be executed when user clicks on map objects.

Parameters:

list - the JList

gameObject - the game object to operate on