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

Packages that use Variable

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

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

Modifier and Type	Class	Description
final class	Variable	A variable is a signed asset that represents a feature of the story world state that can change.

Fields in edu.uky.cs.nil.tt.world declared as Variable

Modifier and Type	Field	Description
final Variable	Assignment.variable	The variable that is being assigned a value
final Variable	Effect.variable	The variable whose value will be modified

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

Modifier and Type	Method	Description
Variable	AssetBuilder.addVariable(Signature signature, String encoding, String description)	Defines a new variable.
Variable	World.getVariable(int id)	Returns the variable defined in this story world which has the given ID number.
Variable	World.getVariable(Signature signature)	Returns the variable defined in this story world which has the given signature.
Variable	World.getVariable(String name)	Returns the variable defined in this story world which has the given name.
Variable	World.requireVariable(int id)	Returns the variable defined in this story world which has the given ID number or throws an exception if it does not exist.
Variable	World.requireVariable(Signature signature)	Returns the variable defined in this story world which has the given signature or throws an exception if it does not exist.
Variable	World.requireVariable(String name)	Returns the variable defined in this story world which has the given name or throws an exception if it does not exist.
Variable	Variable.setDescription(String description)
protected Variable	Variable.setEncoding(String encoding)	Returns a new variable that is the same as this variable, except that its value encoding is the given value.
protected Variable	Variable.setID(int id)
protected Variable	Variable.setSignature(Signature signature)
Variable	Variable.substitute(Function<Object,Object> substitution)
Variable	World.validate(Variable variable)	If this story world contains a variable matching the name of the given variable, the variable 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 Variable

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

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

Modifier and Type	Method	Description
int	Variable.compareTo(Variable other)
boolean	World.contains(Variable variable)	Returns true if the given variable is defined in this story world.
Value	State.get(Variable variable)	Returns the value assigned to the given variable, or null if the variable does not exist in this state or is assigned a null value.
Value	LogicalWorld.getInitialValue(Variable variable)	Returns the value a given variable has when the story first begins.
Proposition	LogicalWorld.getVisibility(Variable variable)	Returns a logical proposition that defines when the player can see a varaiable's value.
boolean	LogicalWorld.isVisible(Role role, Variable variable, State state)	Checks whether the given role can see the value of the given variable in the given state.
void	LogicalWorld.setInitialValue(Variable variable, Value value)	Sets the value a given variable has when the story first begins.
void	LogicalWorld.setVisibility(Variable variable, Proposition visibility)	Sets the logical proposition that defines when the player can see the value of a variable.
Variable	World.validate(Variable variable)	If this story world contains a variable matching the name of the given variable, the variable from this story world world with that name is returned; otherwise, an exception is thrown.
Describer.Rule	Describer.Rule.variableIs(Variable variable)	Returns a new rule identical to this one, except that Describer.Key.VARIABLE must have the given value.

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

Modifier	Constructor	Description
	Assignment(Variable variable, Value value)	Constructs a new assignment from a variable and value with a blank description.
	Assignment(Variable variable, Value value, String description)	Constructs a new assignment from a variable, value, and description.
	Effect(Proposition condition, Variable variable, Expression value)	Constructs a new effect with a condition, variable, and value.
	Effect(Variable variable, Expression value)	Constructs a new effect with a variable and value and whose condition is null.