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

Packages that use Entity

Package	Description
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 Entity in edu.uky.cs.nil.tt.world

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

Modifier and Type	Class	Description
final class	Entity	An entity is an asset that represents a character, object, place, or idea in a story world.

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

Modifier and Type	Method	Description
Entity	AssetBuilder.addEntity(String name, String description)	Defines a new entity.
Entity	Entity.evaluate(State state)
Entity	World.getEntity(int id)	Returns the entity defined in this story world which has the given ID number.
Entity	World.getEntity(String name)	Returns the entity defined in this story world which has the given name.
protected Entity[]	LogicalWorld.getEntityDescriptions(Role role, Turn[] history, State state)	Returns an array of entities visible to a given role which have useful descriptions.
Entity	World.getPlayer()	Returns the entity the represents the player character in this story world.
Entity	World.requireEntity(int id)	Returns the entity defined in this story world which has the given ID number or throws an exception if it does not exist.
Entity	World.requireEntity(String name)	Returns the entity defined in this story world which has the given name or throws an exception if it does not exist.
protected Entity	Entity.setCode(String code)	Returns a new entity that is the same as this entity, except this its code is the given value.
Entity	Entity.setDescription(String description)
protected Entity	Entity.setID(int id)
Entity	Entity.substitute(Function<Object,Object> substitution)
Entity	Entity.toEntity()
default Entity	Value.toEntity()	If this value represents an Entity, this method returns that entity; all other values are converted to {code null}.
Entity	World.validate(Entity entity)	If this story world contains an entity matching the name of the given entity, the entity 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 Entity

Modifier and Type	Method	Description
Set<Entity>	Action.getConsenting()	Returns an unmodifiable set of entities in the story world representing the characters who need to agree to take the action.
List<Entity>	Status.getDescriptions()	Returns an unmodifiable list of all the entities that this role can current see.
List<Entity>	World.getEntities()	Returns an unmodifiable list of all entities defined in this story world ordered by the ID numbers.

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

Modifier and Type	Method	Description
Action	AssetBuilder.addAction(Signature signature, Entity[] consenting, String description)	Defines a new action.
int	Entity.compareTo(Entity other)
boolean	World.contains(Entity entity)	Returns true if the given entity is defined in this story world.
Describer.Rule	Describer.Rule.entityIs(Entity entity)	Returns a new rule identical to this one, except that Describer.Key.ENTITY must have the given value.
protected String	LogicalWorld.getEntityDescription(Role role, Turn[] history, State state, Entity entity)	Returns a longer, more helpful description of an entity based on the current state of a story world.
Proposition	LogicalWorld.getVisibility(Entity entity)	Returns a logical proposition that defines when the player can see an entity.
boolean	LogicalWorld.isVisible(Role role, Entity entity, State state)	Checks whether the given role can see the given entity in the given state.
void	LogicalWorld.setVisibility(Entity entity, Proposition visibility)	Sets the logical proposition that defines when the player can see an entity.
Entity	World.validate(Entity entity)	If this story world contains an entity matching the name of the given entity, the entity from this story world world with that name is returned; otherwise, an exception is thrown.

Method parameters in edu.uky.cs.nil.tt.world with type arguments of type Entity

Modifier and Type	Method	Description
protected Action	Action.setConsenting(Set<Entity> consenting)	Returns a new action that is the same as this action, except that its consenting characters is the given set.

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

Modifier	Constructor	Description
	Action(int id, Signature signature, Entity[] consenting, String description, String code)	Constructs a new action.
	Status(String world, Role role, Turn[] history, State state, Ending ending, Entity[] descriptions, Turn[] choices)	Constructs a status.

Constructor parameters in edu.uky.cs.nil.tt.world with type arguments of type Entity

Modifier	Constructor	Description
	LogicalWorld(String name, Collection<Entity> entities, Collection<Variable> variables, Collection<Action> actions, Collection<Ending> endings)	Constructs a logical world model with the given assets.
	World(String name, Collection<Entity> entities, Collection<Variable> variables, Collection<Action> actions, Collection<Ending> endings)	Constructs a story world from a unique name and sets of assets.
	WorldModel(String name, Collection<Entity> entities, Collection<Variable> variables, Collection<Action> actions, Collection<Ending> endings)	Constructs a story world model with the assets needed to construct a story world.