Uses of Class
edu.uky.cs.nil.tt.world.Ending

Packages that use Ending

Package	Description
edu.uky.cs.nil.tt	Tandem Tales is a platform that enables short, paired storytelling exercises between two agents over a network.
edu.uky.cs.nil.tt.io	The IO (input/output) package defines the various message types that can be sent between a server and client and provide some utilities for serializing and deserializing objects as JSON.
edu.uky.cs.nil.tt.world	Story worlds define the objects, concepts, and actions that exist in a story, and story world models define the logic for when actions can happen, how actions change the current state of world, when endings happen, etc.

Uses of Ending in edu.uky.cs.nil.tt

Fields in edu.uky.cs.nil.tt declared as Ending

Modifier and Type	Field	Description
final Ending	Session.Result.ending	One of the endings defined by the story world, or null if this session did not reach one of the pre-defined endings

Methods in edu.uky.cs.nil.tt with parameters of type Ending

Modifier and Type	Method	Description
protected void	Client.onEnd(Ending ending)	This method is called once if the story reaches one of its pre-defined endings.

Uses of Ending in edu.uky.cs.nil.tt.io

Fields in edu.uky.cs.nil.tt.io declared as Ending

Modifier and Type	Field	Description
final Ending	Stop.ending	One of the pre-defined endings from the story world, or null if this session did not reach one of those endings

Constructors in edu.uky.cs.nil.tt.io with parameters of type Ending

Modifier	Constructor	Description
	Stop(Ending ending)	Constructs a stop message from a pre-defined story ending.

Uses of Ending in edu.uky.cs.nil.tt.world

Classes in edu.uky.cs.nil.tt.world that implement interfaces with type arguments of type Ending

Modifier and Type	Class	Description
final class	Ending	An ending is a signed asset that represents one of several possible ways a story can end.

Methods in edu.uky.cs.nil.tt.world that return Ending

Modifier and Type	Method	Description
Ending	AssetBuilder.addEnding(Signature signature, String description)	Defines a new ending.
protected Ending	LogicalWorld.getEnding(Role role, Turn[] history, State state)	Determines whether the story has ended and, if so, returns the ending.
Ending	Status.getEnding()	Returns the ending the session's story has reached, or null if the story has not yet ended.
Ending	World.getEnding(int id)	Returns the ending defined in this story world which has the given ID number.
Ending	World.getEnding(Signature signature)	Returns the ending defined in this story world which has the given signature.
Ending	World.getEnding(String name)	Returns the ending defined in this story world which has the given name.
Ending	World.requireEnding(int id)	Returns the ending defined in this story world which has the given ID number or throws an exception if it does not exist.
Ending	World.requireEnding(Signature signature)	Returns the ending defined in this story world which has the given signature or throws an exception if it does not exist.
Ending	World.requireEnding(String name)	Returns the ending defined in this story world which has the given name or throws an exception if it does not exist.
protected Ending	Ending.setCode(String code)	Returns a new ending that is the same as this ending, except this its code is the given value.
Ending	Ending.setDescription(String description)
protected Ending	Ending.setID(int id)
protected Ending	Ending.setSignature(Signature signature)
Ending	Ending.substitute(Function<Object,Object> substitution)
Ending	World.validate(Ending ending)	If this story world contains an ending matching the name of the given ending, the ending from this story world world with that name is returned; otherwise, an exception is thrown.

Methods in edu.uky.cs.nil.tt.world that return types with arguments of type Ending

Modifier and Type	Method	Description
List<Ending>	World.getEndings()	Returns an unmodifiable list of all endings defined in this story world ordered by the ID numbers.

Methods in edu.uky.cs.nil.tt.world with parameters of type Ending

Modifier and Type	Method	Description
int	Ending.compareTo(Ending other)
boolean	World.contains(Ending ending)	Returns true if the given ending is defined in this story world.
Describer.Rule	Describer.Rule.endingIs(Ending ending)	Returns a new rule identical to this one, except that Describer.Key.ENDING must have the given value.
protected Turn[]	LogicalWorld.getChoices(Role role, Turn[] history, State state, Ending ending)	Returns an array of choices available to a given role based on the current state of a story world, or null if no choices are available.
Proposition	LogicalWorld.getCondition(Ending ending)	Returns a logical proposition that defines when an ending should occur.
void	LogicalWorld.setCondition(Ending ending, Proposition condition)	Sets the logical proposition that defines when an ending should occur.
Ending	World.validate(Ending ending)	If this story world contains an ending matching the name of the given ending, the ending from this story world world with that name is returned; otherwise, an exception is thrown.

Constructors in edu.uky.cs.nil.tt.world with parameters of type Ending

Modifier	Constructor	Description
	Status(String world, Role role, Turn[] history, State state, Ending ending, Entity[] descriptions, Turn[] choices)	Constructs a status.