Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractAdapter<A> - Class in edu.uky.cs.nil.tt.io
-
An abstract adapter is used to configure a
GsonBuilderto read and write objects that share a common parent class, including abstract types like interfaces and abstract classes. - AbstractAdapter(Class) - Constructor for class edu.uky.cs.nil.tt.io.AbstractAdapter
-
Constructs a new abstract adapter for the given abstract type.
- accept(ServerSocket) - Method in class edu.uky.cs.nil.tt.Server
- action - Variable in class edu.uky.cs.nil.tt.world.Turn
-
The action that this turn is relevant to
- Action - Class in edu.uky.cs.nil.tt.world
- Action(int, Signature, Entity[], String, String) - Constructor for class edu.uky.cs.nil.tt.world.Action
-
Constructs a new action.
- ACTION - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The action being described or the
action of the turnbeing described - actionIs(Action) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.ACTIONmust have the given value. - actual - Variable in class edu.uky.cs.nil.tt.Session.Event
-
The actual state of the story world after the turn
- add(CommandParser.Command) - Method in class edu.uky.cs.nil.tt.CommandParser
-
Adds a new command to the list of command this parser can recognize.
- add(Describer.Rule) - Method in class edu.uky.cs.nil.tt.world.Describer
-
Adds a rule to the end of the list of rules that this describer can apply when describing an object.
- add(Describer.Verb) - Method in class edu.uky.cs.nil.tt.world.Describer
-
Adds a verb to this describer, or replaces an existing verb with the same base, if one exists.
- addAction(Signature, Entity[], String) - Method in class edu.uky.cs.nil.tt.world.AssetBuilder
-
Defines a new
action. - addAgent(String) - Method in class edu.uky.cs.nil.tt.Database
-
Adds a new agent entry to the database for a given agent name and writes the database to file.
- addEnding(Signature, String) - Method in class edu.uky.cs.nil.tt.world.AssetBuilder
-
Defines a new
ending. - addEntity(String, String) - Method in class edu.uky.cs.nil.tt.world.AssetBuilder
-
Defines a new
entity. - addVariable(Signature, String, String) - Method in class edu.uky.cs.nil.tt.world.AssetBuilder
-
Defines a new
variable. - addWorld(WorldModel) - Method in class edu.uky.cs.nil.tt.Database
-
Adds a new world entry to the database for a given world and writes the database to file.
- addWorld(File) - Method in class edu.uky.cs.nil.tt.Database
-
Deserializes a world model from a given file,
addsthe world model to the database, and writes the database to file. - agent - Variable in class edu.uky.cs.nil.tt.io.Connect.Available
-
The name of the agent waiting for a match
- Agent - Class in edu.uky.cs.nil.tt
- Agent(Server, SSLSocket, int) - Constructor for class edu.uky.cs.nil.tt.Agent
-
Constructs an agent.
- AGENT_TIMEOUT - Static variable in class edu.uky.cs.nil.tt.Settings
-
The amount of time in milliseconds an agent has to send an expected message before they will be disconnected for inactivity
- AgentEntry(String) - Constructor for class edu.uky.cs.nil.tt.Database.AgentEntry
-
Constructs a new agent database entry from a name.
- agents - Variable in class edu.uky.cs.nil.tt.io.Connect
-
A list of
entriesgiving the names and descriptions of the publicly listed agents available on this server - AND - Enum constant in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
-
An operator that is true just when all of its arguments are true (and is true if it has no arguments)
- append(Role, Report) - Method in class edu.uky.cs.nil.tt.Session
-
Adds a new report to this session, which records a response by one of the participants to a rating or survey question about the story.
- append(Session) - Method in class edu.uky.cs.nil.tt.Log
-
Generates a
random nameand writes the details of a completed storytellingsessionto a file with that name in the session file directory (if session are being recorded). - append(Turn, State, State) - Method in class edu.uky.cs.nil.tt.Session
-
Adds a new event to this session, which records a turn in the story, the actual and player perceived states after that turn, and the time it occurred.
- append(String) - Method in class edu.uky.cs.nil.tt.Log
-
Writes a system message to
standard outputand to the log file (if a log file is being used). - append(String, Log) - Static method in class edu.uky.cs.nil.tt.Log
-
Writes a system message to
standard outputand to the given server log, if it exists. - append(String, Throwable) - Method in class edu.uky.cs.nil.tt.Log
-
Writes a system message and the details of a
throwabletostandard error outputand to the log file (if a log file is being used) - append(String, Throwable, Log) - Static method in class edu.uky.cs.nil.tt.Log
-
Writes a system message and the details of a
throwabletostandard error outputand to the given server log, if it exists. - apply(State, State) - Method in class edu.uky.cs.nil.tt.world.Effect
-
If this effect's
conditionholds, this method applies this effect's change to a given state. - ARG_0 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The first
argument of the signatureof the object being described - ARG_1 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The second
argument of the signatureof the object being described - ARG_2 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The third
argument of the signatureof the object being described - ARG_3 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The fourth
argument of the signatureof the object being described - ARG_4 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The fifth
argument of the signatureof the object being described - ARG_5 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The sixth
argument of the signatureof the object being described - ARG_6 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The seventh
argument of the signatureof the object being described - ARG_7 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The eighth
argument of the signatureof the object being described - ARG_8 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The ninth
argument of the signatureof the object being described - ARG_9 - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The tenth
argument of the signatureof the object being described - Arguments - Class in edu.uky.cs.nil.tt
-
A list of command line arguments and various utility methods to parse keys and values.
- Arguments(String[]) - Constructor for class edu.uky.cs.nil.tt.Arguments
-
Constructs a new command line argument lists.
- Asset - Class in edu.uky.cs.nil.tt.world
-
An asset is any named object or concept in a
story world. - Asset(int, String, String) - Constructor for class edu.uky.cs.nil.tt.world.Asset
-
Constructs a new asset with the given ID number, name, and description.
- AssetBuilder - Class in edu.uky.cs.nil.tt.world
-
A tool for defining the
assetsused in astory world. - AssetBuilder() - Constructor for class edu.uky.cs.nil.tt.world.AssetBuilder
-
Constructs an empty asset builder.
- Assignment - Class in edu.uky.cs.nil.tt.world
- Assignment(Variable, Value) - Constructor for class edu.uky.cs.nil.tt.world.Assignment
-
Constructs a new assignment from a variable and value with a blank description.
- Assignment(Variable, Value, String) - Constructor for class edu.uky.cs.nil.tt.world.Assignment
-
Constructs a new assignment from a variable, value, and description.
- AUTHORS - Static variable in class edu.uky.cs.nil.tt.Settings
-
The people who contributed significantly to this project
- available - Variable in class edu.uky.cs.nil.tt.io.Connect
-
A list of
availableworld/agent pairs that lets an agent know whether a specific combination of a story world and agent is immediately available for play - Available(String, String) - Constructor for class edu.uky.cs.nil.tt.io.Connect.Available
-
Constructs an available world/agent pair from a world name and agent name.
B
- base - Variable in class edu.uky.cs.nil.tt.world.Describer.Verb
-
A basic, non-conjugated form of the verb, usually the infinitive minus the word "to", for example "be"
- bits(int) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Returns the number of bits needed to assign unique ID numbers to each of a given number of objects.
- BOOLEAN - Static variable in class edu.uky.cs.nil.tt.world.Encoding
-
An encoding for Boolean true and false values
C
- call() - Method in class edu.uky.cs.nil.tt.Client
- call() - Method in class edu.uky.cs.nil.tt.ClientFactory
- capitalize(String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Capitalizes the first letter of a string.
- checkUnused() - Method in class edu.uky.cs.nil.tt.Arguments
-
Throws an exception if any command line arguments have not yet been marked as used by the other methods provided by this list.
- Choice - Class in edu.uky.cs.nil.tt.io
-
The choice message is sent from an
agentto the {edu.uky.cs.nil.tt.Server server} to signal what turn the agent wants to take. - Choice(int) - Constructor for class edu.uky.cs.nil.tt.io.Choice
-
Constructs a choice message for a given choice index.
- Client - Class in edu.uky.cs.nil.tt
- Client(String) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with a given name, which has no preference for its role, world, or partner, reading the password and API key from the environment, and using the default network settings.
- Client(String, String, Role) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with a name, role, and world name, which has no preference for a partner, reading the password and API key from the environment, and using the default network settings.
- Client(String, String, Role, String) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with the given session preferences, reading the password and API key from the environment, and using the default network settings.
- Client(String, String, Role, String, String, int) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with the given session preferences and network details, reading the password and API key from the environment.
- Client(String, String, String, Role, String, String, String, int) - Constructor for class edu.uky.cs.nil.tt.Client
-
Constructs a client with the given session preferences, password, API key, and network details.
- ClientFactory - Class in edu.uky.cs.nil.tt
- ClientFactory() - Constructor for class edu.uky.cs.nil.tt.ClientFactory
-
Creates a new client factory with no upper limit on the number of clients that may run simultaneously.
- ClientFactory(int) - Constructor for class edu.uky.cs.nil.tt.ClientFactory
-
Creates a new client factory with an upper limit on the number of clients that it will create simultaneously.
- ClockThread - Class in edu.uky.cs.nil.tt
-
The clock thread regularly calls the server's
tickmethod. - ClockThread(Server) - Constructor for class edu.uky.cs.nil.tt.ClockThread
-
Constructs a clock thread for a given server.
- close() - Method in class edu.uky.cs.nil.tt.Client
- close() - Method in class edu.uky.cs.nil.tt.ClientFactory
- close() - Method in class edu.uky.cs.nil.tt.Log
- Command(String[], CommandParser.Operation) - Constructor for class edu.uky.cs.nil.tt.CommandParser.Command
-
Constructs a new command (including its human-readable description and its regular expression) from a sequence of keywords.
- Command(String, Pattern, CommandParser.Operation) - Constructor for class edu.uky.cs.nil.tt.CommandParser.Command
-
Constructs a new command from a description, regular expression, and operation to be executed when the command is parsed.
- CommandParser - Class in edu.uky.cs.nil.tt
-
A command parser listens (on
standard input) for and executes simple text commands, like modifying the server's database and shutting the server down. - CommandParser(Server) - Constructor for class edu.uky.cs.nil.tt.CommandParser
-
Constructs a new command parser for a server.
- CommandParser.Command - Class in edu.uky.cs.nil.tt
-
A command is a type of operation that can be parsed by a
command parserand executed on a server. - CommandParser.Operation - Interface in edu.uky.cs.nil.tt
-
An operation represents a single command that can be executed on a server based on a series of arguments that define how it behaves.
- comment - Variable in class edu.uky.cs.nil.tt.io.Report
-
A comment provided by the agent explaining their answer, or null if the question does not allow comments or the agent does not provide one
- comment - Variable in class edu.uky.cs.nil.tt.Session.Report
-
An optional free-text response given by the participant to explain the value they gave
- compareTo(Action) - Method in class edu.uky.cs.nil.tt.world.Action
- compareTo(Ending) - Method in class edu.uky.cs.nil.tt.world.Ending
- compareTo(Entity) - Method in class edu.uky.cs.nil.tt.world.Entity
- compareTo(Variable) - Method in class edu.uky.cs.nil.tt.world.Variable
- complete(String, String, float) - Method in class edu.uky.cs.nil.tt.Client
-
Makes an external call to a large language model API to complete a text prompt.
- condition - Variable in class edu.uky.cs.nil.tt.world.Effect
-
A condition which, if true, means this effect will occur
- configure(GsonBuilder) - Static method in class edu.uky.cs.nil.tt.io.Message
-
Configures a
GsonBuilderto encode and decodeMessageobjects as JSON. - configure(GsonBuilder) - Static method in class edu.uky.cs.nil.tt.Session
-
Configures a
GsonBuilderto encode and decode session objects. - configure(GsonBuilder) - Static method in interface edu.uky.cs.nil.tt.world.Expression
-
Configures a
GsonBuilderto encode and decodeExpressionobjects as JSON. - configure(GsonBuilder) - Static method in interface edu.uky.cs.nil.tt.world.Value
-
Configures a
GsonBuilderto encode and decodeValueobjects as JSON. - connect(String, int) - Method in class edu.uky.cs.nil.tt.Client
-
Establishes a secure socket to the server based on this client's network configuration.
- Connect - Class in edu.uky.cs.nil.tt.io
-
The connect message is sent from the {edu.uky.cs.nil.tt.Server server} to an
agentas soon as the agent connects to give details about which story worlds and agents are available for play. - Connect(List, List, Connect.Available[]) - Constructor for class edu.uky.cs.nil.tt.io.Connect
-
Constructs a new connect message with a given list of worlds and agents.
- Connect.Available - Class in edu.uky.cs.nil.tt.io
-
Advertises that a specific story world and agent pair is waiting for a match.
- consents(Role) - Method in class edu.uky.cs.nil.tt.world.Action
-
Returns true if the given story role controls one or more of the
consenting charactersfor this action. - Constant - Class in edu.uky.cs.nil.tt.world
-
A constant is a
logical valuethat always exists in allstory worlds, such a the Boolean concepts of True and False, numbers, and so on. - Constant(boolean) - Constructor for class edu.uky.cs.nil.tt.world.Constant
-
Constructs a new constant that represents a Boolean value.
- Constant(float) - Constructor for class edu.uky.cs.nil.tt.world.Constant
-
Constructs a new constant that represents a decimal number.
- Constant(int) - Constructor for class edu.uky.cs.nil.tt.world.Constant
-
Constructs a new constant that represents an integer.
- Constant(Void) - Constructor for class edu.uky.cs.nil.tt.world.Constant
-
Constructs a new constant equivalent to
Constant.NULL. - contains(Action) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns true if the given action is defined in this story world.
- contains(Ending) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns true if the given ending is defined in this story world.
- contains(Entity) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns true if the given entity is defined in this story world.
- contains(Variable) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns true if the given variable is defined in this story world.
- contains(String) - Method in class edu.uky.cs.nil.tt.Arguments
-
Tests whether a given key appears in the list of arguments.
- create() - Method in class edu.uky.cs.nil.tt.ClientFactory
-
This method creates and returns a new client of the type produced by this factory.
- create(Gson, TypeToken) - Method in class edu.uky.cs.nil.tt.io.AbstractAdapter
- create(Gson, TypeToken) - Method in class edu.uky.cs.nil.tt.io.GenericAdapter
- createServer() - Method in class edu.uky.cs.nil.tt.Server
- createSocket(Socket) - Method in class edu.uky.cs.nil.tt.Server
- current(Turn[]) - Static method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Determines whose turn it is based on the history of a session.
D
- database - Variable in class edu.uky.cs.nil.tt.Server
-
A set of story worlds and agent types supported by this server
- Database - Class in edu.uky.cs.nil.tt
-
A database is a
server's persistent store of information about thestory worldsandagentsavailable forsessions. - Database(File, Log) - Constructor for class edu.uky.cs.nil.tt.Database
-
Constructs a new empty database or deserializes it from a file.
- DATABASE_KEY - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The key used to specify that the server should read or save a database of story worlds and agents
- Database.AgentEntry - Class in edu.uky.cs.nil.tt
-
A
database entryfor anagent. - Database.Entry - Class in edu.uky.cs.nil.tt
-
A database entry represents an individual elements in the database, including its meta-data, such as its
titleanddescription. - Database.Listable - Class in edu.uky.cs.nil.tt
-
A listable
entryis one that can either be set as clearly publicly available (listed) or not clearly available (unlisted). - Database.WorldEntry - Class in edu.uky.cs.nil.tt
-
A
database entryfor astory world. - decode(Object) - Method in class edu.uky.cs.nil.tt.world.Encoding
-
Returns the object that produced the given encoding, or converts an easily recognizable object into the kind of object this encoding uses.
- decode(Object) - Method in class edu.uky.cs.nil.tt.world.Variable
- DEFAULT_DATABASE_FILE - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The default location of the database file, if one is not specified
- DEFAULT_LOG_FILE - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The default location of the log file, if one is not specified
- DEFAULT_PORT - Static variable in class edu.uky.cs.nil.tt.Client
-
The default network port the client will attempt to connect to if one is not explicitly provided in the constructor
- DEFAULT_PORT - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The default port the server will listen on, if one is not specified
- DEFAULT_PORT - Static variable in class edu.uky.cs.nil.tt.Settings
-
The default port the server will listen on, if one is not specified
- DEFAULT_SESSIONS_DIRECTORY - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The default location of the session log directory, if one is not specified
- DEFAULT_URL - Static variable in class edu.uky.cs.nil.tt.Client
-
The default URL the client will attempt to connect to if one is not explicitly provided in the constructor
- describe() - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns a long string describing every element of a story world model for use in debugging.
- Described - Interface in edu.uky.cs.nil.tt.world
-
A described object is associated with a human-readable natural language description.
- Describer - Class in edu.uky.cs.nil.tt.world
-
A tool for generating English descriptions of certain objects based on natural language templates.
- Describer() - Constructor for class edu.uky.cs.nil.tt.world.Describer
-
Constructs an empty describer with no verbs or rules.
- Describer.Key - Enum Class in edu.uky.cs.nil.tt.world
-
The names of elements which can be replaced in description templates
- Describer.Rule - Class in edu.uky.cs.nil.tt.world
-
A
describerrule has two parts: a context that defines when to apply it and a natural language template to use when this rule is applied. - Describer.Verb - Class in edu.uky.cs.nil.tt.world
-
A verb is an object used in the templates of a
describer. - deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class edu.uky.cs.nil.tt.io.AbstractAdapter
E
- edu.uky.cs.nil.tt - package 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 - package edu.uky.cs.nil.tt.io
-
The IO (input/output) package defines the various
messagetypes 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 - package edu.uky.cs.nil.tt.world
-
Story
worldsdefine the objects, concepts, and actions that exist in a story, and storyworld modelsdefine the logic for when actions can happen, how actions change the current state of world, when endings happen, etc. - Effect - Class in edu.uky.cs.nil.tt.world
- Effect(Proposition, Variable, Expression) - Constructor for class edu.uky.cs.nil.tt.world.Effect
-
Constructs a new effect with a condition, variable, and value.
- Effect(Variable, Expression) - Constructor for class edu.uky.cs.nil.tt.world.Effect
-
Constructs a new effect with a variable and value and whose condition is
null. - embed(String) - Method in class edu.uky.cs.nil.tt.Client
-
Makes an external call to a large language model API to embed a text string in the model's latent space.
- encode(Object) - Method in class edu.uky.cs.nil.tt.world.Encoding
-
Returns a string of
1's and0's that uniquely represents this object among other objects of the same type in the same story world. - encode(Object) - Method in class edu.uky.cs.nil.tt.world.Variable
-
Uses the variable's
value encodingtoencodethe given object. - Encoded - Interface in edu.uky.cs.nil.tt.world
-
An encoded object has a unique string of
1's and0's that uniquely distinguishes it object from others of the same type in the samestory world. - encoding - Variable in class edu.uky.cs.nil.tt.world.Variable
-
The name of the
encodingthis variable uses to encode its values - Encoding - Class in edu.uky.cs.nil.tt.world
- End - Class in edu.uky.cs.nil.tt.io
-
The end message is sent from the {edu.uky.cs.nil.tt.Server server} to an
agentto indicate that the session had ended and that they should now disconnect. - End(String) - Constructor for class edu.uky.cs.nil.tt.io.End
-
Constructs a new end message with the given session ID.
- ending - Variable in class edu.uky.cs.nil.tt.io.Stop
-
One of the
pre-defined endingsfrom the story world, or null if this session did not reach one of those endings - ending - Variable in class edu.uky.cs.nil.tt.Session.Result
-
One of the endings defined by the story world, or null if this session did not reach one of the pre-defined endings
- Ending - Class in edu.uky.cs.nil.tt.world
-
An ending is a
signed assetthat represents one of several possible ways a story can end. - Ending(int, Signature, String, String) - Constructor for class edu.uky.cs.nil.tt.world.Ending
-
Constructs a new ending.
- ENDING - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The ending being described
- endingIs(Ending) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.ENDINGmust have the given value. - Entity - Class in edu.uky.cs.nil.tt.world
-
An entity is an
assetthat represents a character, object, place, or idea in astory world. - Entity(int, String, String, String) - Constructor for class edu.uky.cs.nil.tt.world.Entity
-
Constructs a new entity.
- ENTITY - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The entity being described
- entityIs(Entity) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.ENTITYmust have the given value. - Entry(Database.Entry) - Constructor for class edu.uky.cs.nil.tt.Database.Entry
-
Constructs a database entry that copies the meta-data of an existing database entry.
- Entry(String) - Constructor for class edu.uky.cs.nil.tt.Database.Entry
-
Constructs a database entry from only a
name. - Entry(String, String, String) - Constructor for class edu.uky.cs.nil.tt.Database.Entry
-
Constructs a database entry with the given meta-data.
- ENVIRONMENT_VARIABLE_API_KEY - Static variable in class edu.uky.cs.nil.tt.Client
-
The name of the environment variable where the client expects to find the API key used to authenticate with the service that provides functions which require special external resources or computation.
- ENVIRONMENT_VARIABLE_PASSWORD - Static variable in class edu.uky.cs.nil.tt.Client
-
The name of the environment variable where the client expects to find the password this agent will use, unless the password is explicitly set by the agent's constructor.
- equals(Object) - Method in class edu.uky.cs.nil.tt.world.Asset
- equals(Object) - Method in class edu.uky.cs.nil.tt.world.Assignment
- equals(Object) - Method in class edu.uky.cs.nil.tt.world.Constant
- equals(Object) - Method in class edu.uky.cs.nil.tt.world.Effect
- equals(Object) - Method in class edu.uky.cs.nil.tt.world.Proposition
- equals(Object) - Method in class edu.uky.cs.nil.tt.world.Signature
- equals(Object) - Method in class edu.uky.cs.nil.tt.world.State
- EQUALS - Enum constant in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
-
An operator that requires at least 1 argument and is true just when all of its arguments are the same
- Error - Class in edu.uky.cs.nil.tt.io
-
The error message is sent from the {edu.uky.cs.nil.tt.Server server} to an
agentif one of the agent's messages causes a problem or is incorrectly formatted. - Error(Exception) - Constructor for class edu.uky.cs.nil.tt.io.Error
-
Constructs a new error message using
an exception's messageas the message. - Error(String) - Constructor for class edu.uky.cs.nil.tt.io.Error
-
Constructs a new error message.
- evaluate(Expression[], State) - Method in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
-
Evaluates the truth value of a proposition whose operator is this operator and whose arguments are the given arguments in a given state.
- evaluate(State) - Method in class edu.uky.cs.nil.tt.world.Entity
- evaluate(State) - Method in interface edu.uky.cs.nil.tt.world.Expression
-
Returns the value of this logical expression in the given state.
- evaluate(State) - Method in class edu.uky.cs.nil.tt.world.Proposition
-
Returns the value of this logical expression in the given state.
- evaluate(State) - Method in interface edu.uky.cs.nil.tt.world.Value
-
Returns the value of this logical expression in the given state.
- evaluate(State) - Method in class edu.uky.cs.nil.tt.world.Variable
- execute(CheckedRunnable) - Method in class edu.uky.cs.nil.tt.Server
- execute(Server, String[]) - Method in interface edu.uky.cs.nil.tt.CommandParser.Operation
-
Executes the command on the given server and configured by the given arguments.
- Expression - Interface in edu.uky.cs.nil.tt.world
F
- FAIL - Enum constant in enum class edu.uky.cs.nil.tt.world.Turn.Type
-
Used to reject a proposed action
- FALSE - Static variable in class edu.uky.cs.nil.tt.world.Constant
-
A constant representing Boolean false
- FALSE - Static variable in class edu.uky.cs.nil.tt.world.Proposition
-
A proposition that is always
false - format - Variable in class edu.uky.cs.nil.tt.CommandParser.Command
-
A human-readable description of the command's format
G
- GAME_MASTER - Enum constant in enum class edu.uky.cs.nil.tt.Role
-
The game master role, who controls all characters except the player character and the environment
- GenericAdapter<G> - Class in edu.uky.cs.nil.tt.io
-
A generic adapter is used to configure a
GsonBuilderto write all subclasses of a given superclass as that superclass. - GenericAdapter(Class) - Constructor for class edu.uky.cs.nil.tt.io.GenericAdapter
-
Constructs a new generic adapter which will write all subclasses of the given class as that class.
- get(Variable) - Method in class edu.uky.cs.nil.tt.world.State
-
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.
- get(String) - Static method in class edu.uky.cs.nil.tt.world.Encoding
-
Returns the encoding method with a given name.
- getAction(int) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the action defined in this story world which has the given
ID number. - getAction(Signature) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the action defined in this story world which has the given signature.
- getAction(String) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the action defined in this story world which has the given
name. - getActions() - Method in class edu.uky.cs.nil.tt.world.World
-
Returns an unmodifiable list of all actions defined in this story world ordered by the ID numbers.
- getAgent() - Method in class edu.uky.cs.nil.tt.io.Message
-
Returns the
Agentwho sent this message, or null if this message was sent by the server. - getAgent(String) - Method in class edu.uky.cs.nil.tt.Database
-
Returns the entry for the agent with the given name or null if the database has no agent that name.
- getArguments() - Method in class edu.uky.cs.nil.tt.world.Proposition
-
Returns an unmodifiable list of this proposition's arguments, the other expressions that make up this proposition and which are considered when evaluating the truth value of this proposition.
- getArguments() - Method in class edu.uky.cs.nil.tt.world.Signature
-
Returns an unmodifiable list of this signature's arguments.
- getAssignments() - Method in class edu.uky.cs.nil.tt.world.State
-
Returns an unmodifiable list of assignments of a value to each variable in the state.
- getAvailable() - Method in class edu.uky.cs.nil.tt.Server
-
Returns a list of story world/agent pairs that are currently waiting and could be matched immediately.
- getChoices() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the current list of turns this agent can take in their session (which may be empty), or null if this agent has not yet been matched.
- getChoices() - Method in class edu.uky.cs.nil.tt.Client
-
If it is currently this client's turn to act, this method returns the list of
turnsthey can take next. - getChoices() - Method in class edu.uky.cs.nil.tt.world.Status
- getChoices(Role, Turn[], State, Ending) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
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.
- getCode() - Method in class edu.uky.cs.nil.tt.world.Action
- getCode() - Method in class edu.uky.cs.nil.tt.world.Assignment
- getCode() - Method in interface edu.uky.cs.nil.tt.world.Encoded
-
Returns a string of
1's and0's that uniquely represents this object among other objects of the same type in the same story world. - getCode() - Method in class edu.uky.cs.nil.tt.world.Ending
- getCode() - Method in class edu.uky.cs.nil.tt.world.Entity
- getCode() - Method in class edu.uky.cs.nil.tt.world.State
- getCode() - Method in class edu.uky.cs.nil.tt.world.Turn
- getCommands() - Method in class edu.uky.cs.nil.tt.CommandParser
-
Returns a list of all of the command this parser can recognize.
- getCondition(Ending) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns a logical proposition that defines when an ending should occur.
- getConnected() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns true if this agent is still being managed in some way by the server.
- getConsenting() - Method in class edu.uky.cs.nil.tt.world.Action
-
Returns an unmodifiable set of entities in the story world representing the characters who need to agree to take the action.
- getDescriber() - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns the describer this world model uses to describe its objects.
- getDescription() - Method in class edu.uky.cs.nil.tt.Database.Entry
-
Returns this entry's description, which is a longer explanation of what this entity provides meant to help human users decide if they are interested in this entity.
- getDescription() - Method in class edu.uky.cs.nil.tt.world.Asset
- getDescription() - Method in class edu.uky.cs.nil.tt.world.Assignment
- getDescription() - Method in interface edu.uky.cs.nil.tt.world.Described
-
Returns a human-readable natural language description of the object.
- getDescription() - Method in class edu.uky.cs.nil.tt.world.State
- getDescription() - Method in class edu.uky.cs.nil.tt.world.Turn
- getDescription(Object, Role) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns a phrase or sentence to describe an object to the given role using this world models'
describer. - getDescriptions() - Method in class edu.uky.cs.nil.tt.world.Status
- getEffects(Action) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns an array of effects which express how an action modifies the state of a story world when it happens.
- getEnding() - Method in class edu.uky.cs.nil.tt.world.Status
-
Returns the ending the session's story has reached, or null if the story has not yet ended.
- getEnding(int) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the ending defined in this story world which has the given
ID number. - getEnding(Role, Turn[], State) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Determines whether the story has ended and, if so, returns the ending.
- getEnding(Signature) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the ending defined in this story world which has the given signature.
- getEnding(String) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the ending defined in this story world which has the given
name. - getEndings() - Method in class edu.uky.cs.nil.tt.world.World
-
Returns an unmodifiable list of all endings defined in this story world ordered by the ID numbers.
- getEntities() - Method in class edu.uky.cs.nil.tt.world.World
-
Returns an unmodifiable list of all entities defined in this story world ordered by the ID numbers.
- getEntity(int) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the entity defined in this story world which has the given
ID number. - getEntity(String) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the entity defined in this story world which has the given
name. - getEntityDescription(Role, Turn[], State, Entity) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns a longer, more helpful description of an entity based on the current state of a story world.
- getEntityDescriptions(Role, Turn[], State) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns an array of entities
visibleto a given role which haveuseful descriptions. - getEvents() - Method in class edu.uky.cs.nil.tt.Session
-
Returns an unmodifiable list of all events
appendedto this session so far. - getGM() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the
game masterfor this agent's session (which might be this agent or their partner), or null if this agent has not yet been matched. - getHistory() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the list of all
turnsthat have been taken so far in this client's session that this client has observed. - getHistory() - Method in class edu.uky.cs.nil.tt.world.Status
-
Returns an unmodifiable list of all turns that have happened so far in the session.
- getID() - Method in class edu.uky.cs.nil.tt.world.Asset
- getID() - Method in interface edu.uky.cs.nil.tt.world.Unique
-
Returns this object's unique, sequential, integer ID number that distinguishes it from other objects of the same type in the same story world.
- getInitialValue(Variable) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns the value a given variable has when the story first begins.
- getLimit() - Method in class edu.uky.cs.nil.tt.Database.AgentEntry
-
Returns the maximum number of agents with this entry's name that may be participating in sessions simultaneously.
- getListed() - Method in class edu.uky.cs.nil.tt.Database.Listable
-
Returns whether this entry should advertise itself as being available (listed) or whether this entry should not advertise that is is available (unlisted).
- getListedAgents() - Method in class edu.uky.cs.nil.tt.Database
- getListedWorlds() - Method in class edu.uky.cs.nil.tt.Database
- getName() - Method in class edu.uky.cs.nil.tt.Agent
- getName() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the client's name.
- getName() - Method in class edu.uky.cs.nil.tt.Database.Entry
- getName() - Method in interface edu.uky.cs.nil.tt.Named
-
Returns this object's unique name that distinguishes it from other objects of the same type in the same context.
- getName() - Method in class edu.uky.cs.nil.tt.world.Asset
-
Returns the asset's name, which is unique among other assets of the same type in the story world.
- getName() - Method in class edu.uky.cs.nil.tt.world.Encoding
- getName() - Method in class edu.uky.cs.nil.tt.world.World
- getPartner() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the other agent in this agent's session, or null if this agent has not yet been matched.
- getPartner() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the name of the partner this client wants to play with.
- getPartner() - Method in enum class edu.uky.cs.nil.tt.Role
-
Returns the partner of this role.
- getPhrase(Object) - Method in class edu.uky.cs.nil.tt.world.Describer
-
Applies this describer's rules to generate a natural language description of the given object for a session's
game master. - getPhrase(Object, Role) - Method in class edu.uky.cs.nil.tt.world.Describer
-
Applies this describer's rules to generate a natural language description of the given object for a given role.
- getPlayer() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the
playerfor this agent's session (which might be this agent or their partner), or null if this agent has not yet been matched. - getPlayer() - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the entity the represents the
playercharacter in this story world. - getPrecondition(Action) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns a logical proposition that defines when an action can be taken.
- getRandomName() - Static method in class edu.uky.cs.nil.tt.Utilities
-
Randomly generates a valid
name. - getRandomWorld() - Method in class edu.uky.cs.nil.tt.Database
-
Returns a randomly chosen
listedworld entry. - getReports() - Method in class edu.uky.cs.nil.tt.Session
-
Returns an unmodifiable list of all reports
appendedto this session so far. - getResult() - Method in class edu.uky.cs.nil.tt.Session
-
Returns the result of this session, or null if this session does not yet have a result.
- getRole() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the role this agent is playing in its session, or null if the agent has not yet been matched.
- getRole() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the role this client wants to play or is currently playing in its session.
- getRule(Map) - Method in class edu.uky.cs.nil.tt.world.Describer
-
Returns the first rule from this describer that
matchesa given context. - getRules() - Method in class edu.uky.cs.nil.tt.world.Describer
-
Returns an unmodifiable list of all the rules used by this describer, in the order they will be checked to see if they apply.
- getSentence(Object) - Method in class edu.uky.cs.nil.tt.world.Describer
-
Applies this describer's rules to generate a natural language description of the given object for a session's
game master, with the first letter capitalized and ending in a period. - getSentence(Object, Role) - Method in class edu.uky.cs.nil.tt.world.Describer
-
Applies this describer's rules to generate a natural language description of the given object for a given role, with the first letter capitalized and ending in a period.
- getSession() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the session this agent is participating in, or null if this agent has not yet been matched.
- getSession() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the ID of this client's session.
- getState() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the current state of the story world for this agent's session, as perceived by this agent, or null if this agent has not yet been matched.
- getState() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the current
stateof the story world. - getState() - Method in class edu.uky.cs.nil.tt.world.Status
-
Returns a state that gives the current value of all the story world's
variables. - getStatus() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the current status of the story for this agent's session, or null if this agent has not yet been matched.
- getStatus(Role, Turn[], State, State) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Calculates the ending (if any), entity descriptions, and turns available to include in a status.
- getStopped() - Method in class edu.uky.cs.nil.tt.Agent
-
Checks whether this agent has been sent a
stopmessage yet. - getStopped() - Method in class edu.uky.cs.nil.tt.Server
-
Returns true if this server has been
instructed to begin shutting down. - getTitle() - Method in class edu.uky.cs.nil.tt.Database.Entry
-
Returns this entry's title, which is a short name meant to be reader by human users.
- getUsage() - Method in class edu.uky.cs.nil.tt.CommandParser
-
Returns a documentation string showing how to use the commands this parser can recognize.
- getValue(String, String) - Method in class edu.uky.cs.nil.tt.Arguments
-
Returns the value immediately after a given key, or a default value if the key has no value, or null if the key does not appear.
- getVariable(int) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the variable defined in this story world which has the given
ID number. - getVariable(Signature) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the variable defined in this story world which has the given signature.
- getVariable(String) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the variable defined in this story world which has the given
name. - getVariables() - Method in class edu.uky.cs.nil.tt.world.World
-
Returns an unmodifiable list of all variables defined in this story world ordered by the ID numbers.
- getVerb(String) - Method in class edu.uky.cs.nil.tt.world.Describer
-
Returns the verb with the given
base. - getVerbs() - Method in class edu.uky.cs.nil.tt.world.Describer
-
Returns all the verbs used by this describer.
- getVisibility(Action) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns a logical proposition that defines when the
playerwould see an action happen. - getVisibility(Entity) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns a logical proposition that defines when the
playercan see an entity. - getVisibility(Variable) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Returns a logical proposition that defines when the
playercan see a varaiable's value. - getWorld() - Method in class edu.uky.cs.nil.tt.Agent
-
Returns the story world model in which this agent's session takes place, or null if the agent has not yet been matched.
- getWorld() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the
story worldin which this client's session is taking place. - getWorld() - Method in class edu.uky.cs.nil.tt.Database.WorldEntry
-
Returns this entry world's model.
- getWorld(String) - Method in class edu.uky.cs.nil.tt.Database
-
Returns the entry for the world model with the given name or null if the database has no world model with that name.
- getWorldName() - Method in class edu.uky.cs.nil.tt.Client
-
Returns the name of the story world this client will play in or is currently playing in.
- gm - Variable in class edu.uky.cs.nil.tt.Session
-
The system name of the agent in the game master role
H
- hashCode() - Method in class edu.uky.cs.nil.tt.world.Asset
- hashCode() - Method in class edu.uky.cs.nil.tt.world.Assignment
- hashCode() - Method in class edu.uky.cs.nil.tt.world.Constant
- hashCode() - Method in class edu.uky.cs.nil.tt.world.Effect
- hashCode() - Method in class edu.uky.cs.nil.tt.world.Proposition
- hashCode() - Method in class edu.uky.cs.nil.tt.world.Signature
- hashCode() - Method in class edu.uky.cs.nil.tt.world.State
- HELP_KEY - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The key used to print the usage instructions
I
- id - Variable in class edu.uky.cs.nil.tt.Agent
-
A unique, sequential ID number assigned to this agent
- id - Variable in class edu.uky.cs.nil.tt.world.Asset
-
This asset's ID number, which is unique among other assets of the same type
- index - Variable in class edu.uky.cs.nil.tt.io.Choice
-
The index of a turn from the most recent
status updatesent to the agent, starting at 0 - isAvailable(Role, Action, State) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Checks whether the given action is available is available to the given role in the given state.
- isPlayer() - Method in class edu.uky.cs.nil.tt.world.Entity
-
Returns true if this entity represents the player character in its story world.
- isVisible(Role, Action, State) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Checks whether the given action would be seen by the given role if it happened in the given state.
- isVisible(Role, Entity, State) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Checks whether the given role can see the given entity in the given state.
- isVisible(Role, Variable, State) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Checks whether the given role can see the value of the given variable in the given state.
- item - Variable in class edu.uky.cs.nil.tt.io.Report
-
The name or ID of the survey question
- item - Variable in class edu.uky.cs.nil.tt.Session.Report
-
The name of the item or question the participant is responding to
J
- Join - Class in edu.uky.cs.nil.tt.io
-
The join message is the first message sent from an
agentto the {edu.uky.cs.nil.tt.Server server} to provide the agent's credentials and its preferences for what story world, role, and partner they want for their session. - Join(String, String, String, Role, String) - Constructor for class edu.uky.cs.nil.tt.io.Join
-
Constructs a new join message with an agent's credentials and preferences.
L
- Listable(String) - Constructor for class edu.uky.cs.nil.tt.Database.Listable
-
Constructs a listable entry with a given name.
- log - Variable in class edu.uky.cs.nil.tt.Server
-
Used to record system messages and data from completed sessions
- Log - Class in edu.uky.cs.nil.tt
-
A log is used to record system messages and session data.
- Log(File, File) - Constructor for class edu.uky.cs.nil.tt.Log
-
Constructs a new server log.
- LOG_KEY - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The key used to specify that server messages should be logged to file
- Logical - Interface in edu.uky.cs.nil.tt.world
-
A logical object is anything that is itself a predicate logic formula or contains a predicate logic formula.
- LogicalWorld - Class in edu.uky.cs.nil.tt.world
-
A logical
world modelimplements the internal logic of a story world usinglogical propositionsand describes its elements using a rule-baseddescriber. - LogicalWorld(AssetBuilder) - Constructor for class edu.uky.cs.nil.tt.world.LogicalWorld
-
Constructs a logical world model from the assets defined in an asset builder.
- LogicalWorld(String, Collection, Collection, Collection, Collection) - Constructor for class edu.uky.cs.nil.tt.world.LogicalWorld
-
Constructs a logical world model with the given assets.
M
- main(String[]) - Static method in class edu.uky.cs.nil.tt.ServerMain
-
Configure and run a server based on Java arguments passed from the terminal.
- main(String[]) - Static method in class edu.uky.cs.nil.tt.Test
- main(String[]) - Static method in class edu.uky.cs.nil.tt.TutorialWorldFactory
-
Creates the example logical story world, serializes it to file, and prints a description of the world.
- makeMatch() - Method in class edu.uky.cs.nil.tt.Server
-
This method finds a single pair of compatible agents who are waiting for a session and, if one is found, starts a session for them.
- makeMatches() - Method in class edu.uky.cs.nil.tt.Server
-
This method tries to find pairs of compatible agents who are waiting for sessions and, if any are found, starts sessions for them.
- makeWorld() - Static method in class edu.uky.cs.nil.tt.TutorialWorldFactory
-
Creates an example
logical story world modelfrom scratch, demonstrating how to use tools like theasset builderanddescriber. - matches(Join) - Method in class edu.uky.cs.nil.tt.io.Join
-
Returns true if this join request is compatible with another, meaning a session could be created between the agents who sent the messages.
- matches(Map) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Tests whether the context of this rule matches the context of the object a describer is currently trying to describe.
- maxClients - Variable in class edu.uky.cs.nil.tt.ClientFactory
-
The maximum number of
clientsthat this factory will create to run simultaneously - message - Variable in class edu.uky.cs.nil.tt.io.Error
-
A message explaining the error
- message - Variable in class edu.uky.cs.nil.tt.io.Stop
-
A message explaining how the session ended
- message - Variable in class edu.uky.cs.nil.tt.Session.Result
-
A message explaining the reason or way the session ended
- Message - Class in edu.uky.cs.nil.tt.io
-
A message is information sent to or from a
serverin JSON format. - Message() - Constructor for class edu.uky.cs.nil.tt.io.Message
-
Constructs a message.
N
- name - Variable in class edu.uky.cs.nil.tt.io.Join
-
The new agent's name
- name - Variable in class edu.uky.cs.nil.tt.world.Asset
-
This asset's name, which is unique among other assets of the same type
- name - Variable in class edu.uky.cs.nil.tt.world.Encoding
-
The unique name of this encoding method
- name - Variable in class edu.uky.cs.nil.tt.world.Signature
-
The signature's name
- name - Variable in class edu.uky.cs.nil.tt.world.World
-
The unique name of this story world
- NAME - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The name of the
named objectbeing described or thename part of the signatureof the object being described if the object is asigned asset - NAME - Static variable in class edu.uky.cs.nil.tt.Settings
-
The name of this project
- NAME_ALLOWED_CHARACTERS - Static variable in class edu.uky.cs.nil.tt.Settings
-
The characters that can be legally used in a
name - NAME_MAX_LENGTH - Static variable in class edu.uky.cs.nil.tt.Settings
-
The maximum number of characters allowed in a
name - Named - Interface in edu.uky.cs.nil.tt
-
A named object has a unique name that specifically distinguishes it from other objects of the same type in the same context.
- nameIs(String) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.NAMEmust have the given value. - NOT - Enum constant in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
-
An operator that requires exactly 1 argument and is true just when its argument is false and false just when its argument is true
- NULL - Static variable in class edu.uky.cs.nil.tt.world.Constant
-
A constant representing nothing or the absence of a value
O
- onChoice(Choice) - Method in class edu.uky.cs.nil.tt.Agent
- onChoice(Status) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called each time it is this client's turn to make a choice in the story.
- onChoice(Status) - Method in class edu.uky.cs.nil.tt.Test.RandomClient
- onClose() - Method in class edu.uky.cs.nil.tt.Agent
- onClose() - Method in class edu.uky.cs.nil.tt.Client
-
This method is called once if the client was
closed, if it was interrupted, or if the socket was disconnected. - onClose() - Method in class edu.uky.cs.nil.tt.ClientFactory
-
This method is called once after this factory stops creating new clients and has begun shutting down.
- onClose() - Method in class edu.uky.cs.nil.tt.Server
- onConnect() - Method in class edu.uky.cs.nil.tt.Agent
- onConnect(Connect) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called after the client connects to the server and the server sends the list of available worlds and agents.
- onDisconnect() - Method in class edu.uky.cs.nil.tt.Agent
- onDisconnect() - Method in class edu.uky.cs.nil.tt.Client
-
If the client ever established its connection to the server, this method is called once right before the
Client.call()method returns or throws an exception. - onEnd(Session, Agent, Agent) - Method in class edu.uky.cs.nil.tt.Server
-
This method is called each time a
sessionends. - onEnd(Ending) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called once if the story reaches one of its
pre-defined endings. - onError(String) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called if the server reports an
errorto this client. - onException(Exception) - Method in class edu.uky.cs.nil.tt.Server
- onJoin(Join) - Method in class edu.uky.cs.nil.tt.Agent
-
This method is called each time a
joinmessage is received to establish the agent's identity and preferences. - onJoin(Join) - Method in class edu.uky.cs.nil.tt.Server
- onReport(Report) - Method in class edu.uky.cs.nil.tt.Agent
-
This method is called each time a
reportmessage is received to record the agent's responses. - onStart() - Method in class edu.uky.cs.nil.tt.ClientFactory
-
This method is called once when this factory begins running.
- onStart(Session, Agent, Agent) - Method in class edu.uky.cs.nil.tt.Agent
- onStart(World, Agent, Agent) - Method in class edu.uky.cs.nil.tt.Server
- onStart(World, Role, State) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called once when the client's session starts.
- onStop() - Method in class edu.uky.cs.nil.tt.ClientFactory
-
This method is called once at the end of this factory's shutdown process after all clients have stopped running.
- onStop() - Method in class edu.uky.cs.nil.tt.Server
- onStop(Stop) - Method in class edu.uky.cs.nil.tt.Agent
-
This method is called either when a
stopmessage is received or when a session is stopped by an agent's partner or the server. - onStop(String) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called once when the client's session ends.
- onTurn(Turn) - Method in class edu.uky.cs.nil.tt.Agent
-
This method is called each time a new turn is taken in the this agent's session.
- onUpdate(Status) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called each time the story world changes as a result of a turn the client observes.
- onWarning(String) - Method in class edu.uky.cs.nil.tt.Client
-
This method is called if this client encounters a problem which does not immediately require it to close but which may cause problems.
- operation - Variable in class edu.uky.cs.nil.tt.CommandParser.Command
-
The operation to execute if this command is parsed
- operator - Variable in class edu.uky.cs.nil.tt.world.Proposition
-
An operator defines the type and behavior of a proposition
- OR - Enum constant in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
-
An operator that is true just when one of its arguments is true (and is false if it has no arguments)
P
- parse(String) - Method in class edu.uky.cs.nil.tt.CommandParser
-
Attempts to parse and execute a command from a string, typically one typed into
standard input. - partner - Variable in class edu.uky.cs.nil.tt.io.Join
-
The name of the partner this new agent wants to play with, or null if they are willing to play with any partner
- PASS - Enum constant in enum class edu.uky.cs.nil.tt.world.Turn.Type
-
Used when one participant does not want to act and wants to allow their partner to act instead
- PASS_LIMIT - Static variable in class edu.uky.cs.nil.tt.Settings
-
The number of passed turn in a row which causes a session to be automatically stopped
- password - Variable in class edu.uky.cs.nil.tt.io.Join
-
The new agent's password, which must be provided if the agent is using a
Join.namethat is reserved on this server, or which should be null if the agent is not using a reserved name - pattern - Variable in class edu.uky.cs.nil.tt.CommandParser.Command
-
A regular expression used to detect if this command is being invoked
- perceived - Variable in class edu.uky.cs.nil.tt.Session.Event
-
The state of the story world as perceived by the player after the turn
- player - Variable in class edu.uky.cs.nil.tt.Session
-
The system name of the agent in the player role
- PLAYER - Enum constant in enum class edu.uky.cs.nil.tt.Role
-
The player role, who controls one characters, often the main character of the story
- port - Variable in class edu.uky.cs.nil.tt.Server
-
The network port on which the server listens for new connections
- PORT_KEY - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The key used to specify on which port the server should listen
- PROPOSE - Enum constant in enum class edu.uky.cs.nil.tt.world.Turn.Type
-
Used when one participant wants to suggest taking an action that requires the approval of their partner
- Proposition - Class in edu.uky.cs.nil.tt.world
-
A proposition is a
logical expressionthat can be either true or false. - Proposition(Proposition.Operator, Expression...) - Constructor for class edu.uky.cs.nil.tt.world.Proposition
-
Constructs a new proposition from an operator and arguments.
- Proposition.Operator - Enum Class in edu.uky.cs.nil.tt.world
-
An operator defines the behavior of a
proposition.
R
- RandomClient() - Constructor for class edu.uky.cs.nil.tt.Test.RandomClient
- RandomClient(String) - Constructor for class edu.uky.cs.nil.tt.Test.RandomClient
- read() - Method in class edu.uky.cs.nil.tt.Database.WorldEntry
-
Deserializes this entry's world model from the
filewhere the world model is stored. - read(File) - Static method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Reads a serialized logical world model from a file.
- read(Reader) - Static method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Reads a serialized logical world model from some input source.
- receive() - Method in class edu.uky.cs.nil.tt.Client
-
This method blocks until the client receives a message from the server and then returns that message.
- receive(Class) - Method in class edu.uky.cs.nil.tt.Client
-
This method blocks until the client receives a message of a given type from the server.
- receive(String) - Method in class edu.uky.cs.nil.tt.Agent
- removeAgent(String) - Method in class edu.uky.cs.nil.tt.Database
-
Removes the entry from this database for the agent with the given name (if one exists) and writes the database to file.
- removeWorld(String) - Method in class edu.uky.cs.nil.tt.Database
-
Removes the entry from this database for the world model with the given name (if one exists) and writes the database to file.
- Report - Class in edu.uky.cs.nil.tt.io
-
The report message is sent from an
agentto the {edu.uky.cs.nil.tt.Server server} to indicate the value of a question on a survey about the session they are playing. - Report(String, String, String) - Constructor for class edu.uky.cs.nil.tt.io.Report
-
Constructs a new report message.
- requireAction(int) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the action defined in this story world which has the given
ID numberor throws an exception if it does not exist. - requireAction(Signature) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the action defined in this story world which has the given signature or throws an exception if it does not exist.
- requireAction(String) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the action defined in this story world which has the given
nameor throws an exception if it does not exist. - requireAgent(String) - Method in class edu.uky.cs.nil.tt.Database
-
Returns the entry for the agent with the given name or throws an exception if no such entry exists.
- requireAllNonNull(Object[], String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Throws an exception if any index in an array is null.
- requireEnding(int) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the ending defined in this story world which has the given
ID numberor throws an exception if it does not exist. - requireEnding(Signature) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the ending defined in this story world which has the given signature or throws an exception if it does not exist.
- requireEnding(String) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the ending defined in this story world which has the given
nameor throws an exception if it does not exist. - requireEntity(int) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the entity defined in this story world which has the given
ID numberor throws an exception if it does not exist. - requireEntity(String) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the entity defined in this story world which has the given
nameor throws an exception if it does not exist. - requireEquals(T, Object) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Returns the first object if both objects are
equal; otherwise, throws an exception. - requireExactly(long, long, String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Throws an exception if a given number is anything other than a specific value.
- requireGreaterThan(long, long, String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Throws an exception if a number is not greater than a given lower bound.
- requireLessThanOrEqualTo(long, long, String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Throws an exception if a number is not less than or equal to a given upper bound.
- requireName(String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Throws an exception if a string does not meet the requirements for a
name. - requireNonNegative(long, String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Throws an exception if a number is negative.
- requireNonNull(Object, String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Throws an exception if the given object is null.
- requireType(Object, Class, String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
If a given object is of the given type, this method casts the object to that type; otherwise, it throws an exception.
- requireVariable(int) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the variable defined in this story world which has the given
ID numberor throws an exception if it does not exist. - requireVariable(Signature) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the variable defined in this story world which has the given signature or throws an exception if it does not exist.
- requireVariable(String) - Method in class edu.uky.cs.nil.tt.world.World
-
Returns the variable defined in this story world which has the given
nameor throws an exception if it does not exist. - requireWorld(String) - Method in class edu.uky.cs.nil.tt.Database
-
Returns the entry for the world model with the given name or throws an exception if no such entry exists.
- role - Variable in class edu.uky.cs.nil.tt.io.Join
-
The role this new agent wants to have in their session, or null if they are willing to play either role
- role - Variable in class edu.uky.cs.nil.tt.io.Start
-
The role the recipient of this message will have in the session
- role - Variable in class edu.uky.cs.nil.tt.io.Stop
-
The participant who ended the session, or null if the session reached a pre-defined ending or was ended by the server
- role - Variable in class edu.uky.cs.nil.tt.Session.Report
-
The role who sent this report
- role - Variable in class edu.uky.cs.nil.tt.Session.Result
-
The role who caused the ending
- role - Variable in class edu.uky.cs.nil.tt.world.Status
-
The role of the participant to whom this status is being described
- role - Variable in class edu.uky.cs.nil.tt.world.Turn
-
The role of the participant taking this turn
- Role - Enum Class in edu.uky.cs.nil.tt
-
Represents the two roles in a collaborative storytelling
session: the Player, who typically controls a single character, and the Game Master, who controls all other characters and the environment. - ROLE - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The
role who takes the turnbeing described - ROLE - Static variable in class edu.uky.cs.nil.tt.world.Encoding
-
And encoding for session
Rolevalues - roleIs(Role) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.ROLEmust have the given value. - Rule() - Constructor for class edu.uky.cs.nil.tt.world.Describer.Rule
-
Constructs a new empty rule with no template and no context.
- Rule(String) - Constructor for class edu.uky.cs.nil.tt.world.Describer.Rule
-
Constructs a new rule with a template and no context.
- Rule(Map, String) - Constructor for class edu.uky.cs.nil.tt.world.Describer.Rule
-
Constructs a new rule from a context map and a natural language template.
- run() - Method in class edu.uky.cs.nil.tt.ClockThread
- run() - Method in class edu.uky.cs.nil.tt.CommandParser
S
- second - Variable in class edu.uky.cs.nil.tt.world.Describer.Verb
-
The verb conjugated in second person present tense, for example "are"
- send(Message) - Method in class edu.uky.cs.nil.tt.Agent
-
Encodes a message as JSON and sends it to the client via this agent's socket.
- send(Message) - Method in class edu.uky.cs.nil.tt.Client
-
This method sends a message to the server.
- server - Variable in class edu.uky.cs.nil.tt.Agent
-
The server which manages this agent
- Server - Class in edu.uky.cs.nil.tt
- Server(File, File, File, int) - Constructor for class edu.uky.cs.nil.tt.Server
-
Constructs a server from its various components.
- ServerMain - Class in edu.uky.cs.nil.tt
-
The main entry point for the Tandem Tales server.
- session - Variable in class edu.uky.cs.nil.tt.io.End
-
The ID of the session, or null if the session was not logged
- Session - Class in edu.uky.cs.nil.tt
- Session(World, String, String) - Constructor for class edu.uky.cs.nil.tt.Session
-
Constructs a new session from a story world and the names of the game master and player agents.
- Session.Event - Class in edu.uky.cs.nil.tt
-
An event represents a single
turnduring a storytelling session as well as the actual state of the story world after the turn and the state of the world as perceived by the player. - Session.Report - Class in edu.uky.cs.nil.tt
-
A report occurs when one participant in a session sends their response to a question about the narrative.
- Session.Result - Class in edu.uky.cs.nil.tt
-
A result explains how the session ended.
- Session.Timestamped - Class in edu.uky.cs.nil.tt
-
A timestamped object records the moment at which it was created.
- SESSIONS_KEY - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
The key used to specify that sessions should be logged to file
- set(Assignment) - Method in class edu.uky.cs.nil.tt.world.State
-
Returns a new state object that is identical to this one, except with the variable in the given assignment set to the given value.
- setAgent(Agent) - Method in class edu.uky.cs.nil.tt.io.Message
-
Sets the
Agentwho sent this message. - setAgentDescription(String, String) - Method in class edu.uky.cs.nil.tt.Database
-
Sets the
descriptionof an agent's entry and writes the database to file. - setAgentLimit(String, int) - Method in class edu.uky.cs.nil.tt.Database
-
Sets the
limiton how many agents with the given name may be in sessions simultaneously and writes the database to file. - setAgentListed(String, boolean) - Method in class edu.uky.cs.nil.tt.Database
-
Sets whether a given agent's entry is
listedand writes the database to file. - setAgentPassword(String, String) - Method in class edu.uky.cs.nil.tt.Database
-
Sets the
passwordof an agent's entry and writes the database to file. - setAgentTitle(String, String) - Method in class edu.uky.cs.nil.tt.Database
-
Sets the
titleof an agent's entry and writes the database to file. - setCode(String) - Method in class edu.uky.cs.nil.tt.world.Action
-
Returns a new action that is the same as this action, except this its
codeis the given value. - setCode(String) - Method in class edu.uky.cs.nil.tt.world.Ending
-
Returns a new ending that is the same as this ending, except this its
codeis the given value. - setCode(String) - Method in class edu.uky.cs.nil.tt.world.Entity
-
Returns a new entity that is the same as this entity, except this its
codeis the given value. - setCondition(Ending, Proposition) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Sets the logical proposition that defines when an ending should occur.
- setConsenting(Set) - Method in class edu.uky.cs.nil.tt.world.Action
-
Returns a new action that is the same as this action, except that its consenting characters is the given set.
- setDescriber(Describer) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Sets the describer used by this world model to describe its objects.
- setDescription(String) - Method in class edu.uky.cs.nil.tt.Database.Entry
-
Sets the
descriptionof this entry. - setDescription(String) - Method in class edu.uky.cs.nil.tt.world.Action
- setDescription(String) - Method in class edu.uky.cs.nil.tt.world.Asset
-
Returns a new asset that is the same as this asset, except that its
descriptionis the given value. - setDescription(String) - Method in class edu.uky.cs.nil.tt.world.Assignment
-
Returns a new assignment that is the same as this assignment, except that its
descriptionis the given value. - setDescription(String) - Method in class edu.uky.cs.nil.tt.world.Ending
- setDescription(String) - Method in class edu.uky.cs.nil.tt.world.Entity
- setDescription(String) - Method in class edu.uky.cs.nil.tt.world.State
-
Returns a new state that is the same as this state, except this its
descriptionis the given value. - setDescription(String) - Method in class edu.uky.cs.nil.tt.world.Turn
-
Returns a new turn that is the same as this turn, except this its
descriptionis the given value. - setDescription(String) - Method in class edu.uky.cs.nil.tt.world.Variable
- setEffects(Action, Effect...) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Sets the arrays of effects which express how an action modifies the state of a story world when it happens.
- setEncoding(String) - Method in class edu.uky.cs.nil.tt.world.Variable
-
Returns a new variable that is the same as this variable, except that its value encoding is the given value.
- setID(int) - Method in class edu.uky.cs.nil.tt.world.Action
- setID(int) - Method in class edu.uky.cs.nil.tt.world.Asset
-
Returns a new asset that is the same as this asset, except that its ID number is the given value.
- setID(int) - Method in class edu.uky.cs.nil.tt.world.Ending
- setID(int) - Method in class edu.uky.cs.nil.tt.world.Entity
- setID(int) - Method in class edu.uky.cs.nil.tt.world.Variable
- setInitialValue(Variable, Value) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Sets the value a given variable has when the story first begins.
- setLimit(int) - Method in class edu.uky.cs.nil.tt.Database.AgentEntry
-
Sets the maximum number of agents with this entry's name that may be participating in sessions simultaneously.
- setListed(boolean) - Method in class edu.uky.cs.nil.tt.Database.Listable
-
Sets whether this entry is
listed. - setName(String) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the name this client will use.
- setName(String) - Method in class edu.uky.cs.nil.tt.world.AssetBuilder
-
Constructs a new asset builder with a given world name.
- setPartner(String) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the name of the partner this client wants to play in its session.
- setPassword(String) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the password this client will use.
- setPassword(String) - Method in class edu.uky.cs.nil.tt.Database.AgentEntry
-
Sets this agent's password.
- setPath(String) - Method in class edu.uky.cs.nil.tt.Database.WorldEntry
-
Sets the URL of the file where this entry's world model is serialized.
- setPrecondition(Action, Proposition) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Sets the logical proposition that defines when an action can be taken.
- setResult(Stop) - Method in class edu.uky.cs.nil.tt.Session
-
Sets the result of this session based on the message which caused the session to end.
- setRole(Role) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the role this client wants to play in its session.
- setSignature(Signature) - Method in class edu.uky.cs.nil.tt.world.Action
- setSignature(Signature) - Method in class edu.uky.cs.nil.tt.world.Ending
- setSignature(Signature) - Method in class edu.uky.cs.nil.tt.world.SignedAsset
-
Returns a new signed asset that is the same as this asset, except that its signature and name are the given value.
- setSignature(Signature) - Method in class edu.uky.cs.nil.tt.world.Variable
- Settings - Class in edu.uky.cs.nil.tt
-
Constants and other project-wide settings.
- setTitle(String) - Method in class edu.uky.cs.nil.tt.Database.Entry
-
Sets the
titleof this entry. - setVisibility(Action, Proposition) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Sets the logical proposition that defines when the
playercan see an action happen. - setVisibility(Entity, Proposition) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Sets the logical proposition that defines when the
playercan see an entity. - setVisibility(Variable, Proposition) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Sets the logical proposition that defines when the
playercan see the value of a variable. - setWorld(WorldModel) - Method in class edu.uky.cs.nil.tt.Database.WorldEntry
-
Sets this entry's
world model. - setWorldDescription(String, String) - Method in class edu.uky.cs.nil.tt.Database
-
Sets the
descriptionof a world model's entry and writes the database to file. - setWorldListed(String, boolean) - Method in class edu.uky.cs.nil.tt.Database
-
Sets whether a given world model's entry is
listedand writes the database to file. - setWorldName(String) - Method in class edu.uky.cs.nil.tt.Client
-
Sets the name of the story world this client wants to play in.
- setWorldTitle(String, String) - Method in class edu.uky.cs.nil.tt.Database
-
Sets the
titleof a world model's entry and writes the database to file. - signature - Variable in class edu.uky.cs.nil.tt.world.SignedAsset
-
The asset's unique signature
- Signature - Class in edu.uky.cs.nil.tt.world
- Signature(String, Value...) - Constructor for class edu.uky.cs.nil.tt.world.Signature
-
Constructs a new signature from a name and an array of arguments.
- SignedAsset - Class in edu.uky.cs.nil.tt.world
-
A signed asset is an
assetwhich has a uniquesignatureamong all other assets of that type in astory world. - SignedAsset(int, Signature, String) - Constructor for class edu.uky.cs.nil.tt.world.SignedAsset
-
Constructs a new signed asset.
- start(Role) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
- start(Role) - Method in class edu.uky.cs.nil.tt.world.WorldModel
-
Returns the initial state of the story world for a given role as a status object.
- Start - Class in edu.uky.cs.nil.tt.io
-
The start message is sent from the {edu.uky.cs.nil.tt.Server server} to an
agentwhen a partner has been found and their session begins. - Start(World, Role) - Constructor for class edu.uky.cs.nil.tt.io.Start
-
Constructs a new start message with the given story world the session will take place in.
- State - Class in edu.uky.cs.nil.tt.world
- State(World) - Constructor for class edu.uky.cs.nil.tt.world.State
-
Constructs a state that assigns default values to every variable in a story world.
- status - Variable in class edu.uky.cs.nil.tt.io.Update
-
An object describing the history of the story so far, the current state of the story world, and what turns are available for the agent to take, if any
- Status - Class in edu.uky.cs.nil.tt.world
-
A status contains the full history of a
sessionin astory world, a description of its currentstate, and a list ofturnsthat can be taken next (if any). - Status(String, Role, Turn[], State, Ending, Entity[], Turn[]) - Constructor for class edu.uky.cs.nil.tt.world.Status
-
Constructs a status.
- Stop - Class in edu.uky.cs.nil.tt.io
- Stop(Role) - Constructor for class edu.uky.cs.nil.tt.io.Stop
-
Constructs a stop message for the role who stopped the session before it reached a pre-defined ending.
- Stop(Ending) - Constructor for class edu.uky.cs.nil.tt.io.Stop
-
Constructs a stop message from a pre-defined story ending.
- Stop(String) - Constructor for class edu.uky.cs.nil.tt.io.Stop
-
Constructs a stop message with a string explaining how the session ended before it reached a pre-definded ending.
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Action
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Asset
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Assignment
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Constant
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Effect
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Ending
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Entity
- substitute(Function) - Method in interface edu.uky.cs.nil.tt.world.Expression
- substitute(Function) - Method in interface edu.uky.cs.nil.tt.world.Logical
-
Returns a logical object identical to this one, except that its logical elements have been replaced according to the given substitution.
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Proposition
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Signature
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.SignedAsset
- substitute(Function) - Method in interface edu.uky.cs.nil.tt.world.Value
- substitute(Function) - Method in class edu.uky.cs.nil.tt.world.Variable
- SUCCEED - Enum constant in enum class edu.uky.cs.nil.tt.world.Turn.Type
-
Used when one participant agrees to take a proposed action, or when a participant can take an action that does not require approval
T
- template - Variable in class edu.uky.cs.nil.tt.world.Describer.Rule
-
The natural language template to be used when this rule is applied
- test(State) - Method in class edu.uky.cs.nil.tt.world.Proposition
- Test - Class in edu.uky.cs.nil.tt
- Test() - Constructor for class edu.uky.cs.nil.tt.Test
- Test.RandomClient - Class in edu.uky.cs.nil.tt
- third - Variable in class edu.uky.cs.nil.tt.world.Describer.Verb
-
The verb conjugated in the third person present tense, for example "is"
- tick() - Method in class edu.uky.cs.nil.tt.Agent
-
This method is called regularly by the Server to check things that are time-sensative but not triggered by events, such as disconnecting agents who have taken too long to send a message.
- tick() - Method in class edu.uky.cs.nil.tt.Server
-
This method is called regularly by the
clock threadto check things that are time-sensative but not triggered by events, such as disconnecting agents who have taken too long to send a message. - TICK_SPEED - Static variable in class edu.uky.cs.nil.tt.Settings
-
The amount of time in milliseconds between
clock threadticks - time - Variable in class edu.uky.cs.nil.tt.Session.Timestamped
-
The time this object was created, as the number of milliseconds from the epoch (1970-01-01T00:00:00Z) in Coordinated Universal Time (UTC)
- Timestamped() - Constructor for class edu.uky.cs.nil.tt.Session.Timestamped
-
Constructs a new timestamped object and records the moment at which it was created.
- TITLE - Static variable in class edu.uky.cs.nil.tt.Settings
-
A full title, including name, version number, and authors
- to(Role) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.TOmust have the given value. - TO - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The
rolefor whom this description is being generated - toBoolean() - Method in class edu.uky.cs.nil.tt.world.Constant
- toBoolean() - Method in interface edu.uky.cs.nil.tt.world.Value
-
If this value represents a Boolean, this method convert it into a Java
boolean; all other values are converted tofalse. - toEntity() - Method in class edu.uky.cs.nil.tt.world.Entity
- toEntity() - Method in interface edu.uky.cs.nil.tt.world.Value
-
If this value represents an
Entity, this method returns that entity; all other values are converted to {code null}. - toInteger(String) - Static method in class edu.uky.cs.nil.tt.Utilities
-
Parsesa string into an integer or throws an exception if the string cannot be parsed. - toNumber() - Method in class edu.uky.cs.nil.tt.world.Constant
- toNumber() - Method in interface edu.uky.cs.nil.tt.world.Value
-
If this value represents a number, this method convert it into a Java
double; all other values are converted toDouble.NaN. - toString() - Method in class edu.uky.cs.nil.tt.Agent
- toString() - Method in class edu.uky.cs.nil.tt.Client
- toString() - Method in class edu.uky.cs.nil.tt.ClientFactory
- toString() - Method in class edu.uky.cs.nil.tt.Database.Entry
- toString() - Method in class edu.uky.cs.nil.tt.io.Choice
- toString() - Method in class edu.uky.cs.nil.tt.io.Connect.Available
- toString() - Method in class edu.uky.cs.nil.tt.io.Connect
- toString() - Method in class edu.uky.cs.nil.tt.io.End
- toString() - Method in class edu.uky.cs.nil.tt.io.Error
- toString() - Method in class edu.uky.cs.nil.tt.io.Join
- toString() - Method in class edu.uky.cs.nil.tt.io.Report
- toString() - Method in class edu.uky.cs.nil.tt.io.Start
- toString() - Method in class edu.uky.cs.nil.tt.io.Stop
- toString() - Method in class edu.uky.cs.nil.tt.io.Update
- toString() - Method in class edu.uky.cs.nil.tt.Session.Event
- toString() - Method in class edu.uky.cs.nil.tt.Session.Report
- toString() - Method in class edu.uky.cs.nil.tt.Session.Result
- toString() - Method in class edu.uky.cs.nil.tt.Session
- toString() - Method in class edu.uky.cs.nil.tt.world.Asset
- toString() - Method in class edu.uky.cs.nil.tt.world.Assignment
- toString() - Method in class edu.uky.cs.nil.tt.world.Constant
- toString() - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
- toString() - Method in class edu.uky.cs.nil.tt.world.Describer
- toString() - Method in class edu.uky.cs.nil.tt.world.Describer.Verb
- toString() - Method in class edu.uky.cs.nil.tt.world.Effect
- toString() - Method in class edu.uky.cs.nil.tt.world.Encoding
- toString() - Method in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
- toString() - Method in class edu.uky.cs.nil.tt.world.Proposition
- toString() - Method in class edu.uky.cs.nil.tt.world.Signature
- toString() - Method in class edu.uky.cs.nil.tt.world.State
- toString() - Method in class edu.uky.cs.nil.tt.world.Status
- toString() - Method in class edu.uky.cs.nil.tt.world.Turn
- toString() - Method in class edu.uky.cs.nil.tt.world.World
- toString(Effect[]) - Static method in class edu.uky.cs.nil.tt.world.Effect
-
Converts an array of effects to a string, similar in format to a
conjunction. - transition(Status, State, Turn) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
- transition(Status, State, Turn) - Method in class edu.uky.cs.nil.tt.world.WorldModel
-
Given the current status of a story world (actual or perceived), the actual current status of a story world, and a turn, this method simulates that turn and returns the new perceived status of the story world.
- TRUE - Static variable in class edu.uky.cs.nil.tt.world.Constant
-
A constant representing Boolean true
- TRUE - Static variable in class edu.uky.cs.nil.tt.world.Proposition
-
A proposition that is always
true - turn - Variable in class edu.uky.cs.nil.tt.Session.Event
-
The turn which occurred, or null if this event records the initial state of the story world
- Turn - Class in edu.uky.cs.nil.tt.world
- Turn(Role, Turn.Type, Action) - Constructor for class edu.uky.cs.nil.tt.world.Turn
-
Constructs a turn with no description and automatically computes its
code. - Turn(Role, Turn.Type, Action, String) - Constructor for class edu.uky.cs.nil.tt.world.Turn
-
Constructs a turn and automatically computes its
code. - Turn(Role, World) - Constructor for class edu.uky.cs.nil.tt.world.Turn
-
Constructs a
passturn for a given story world. - TURN_TYPE - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The
type of turnobject being described - TURN_TYPE - Static variable in class edu.uky.cs.nil.tt.world.Encoding
-
And encoding for
Turn.Typevalues - Turn.Type - Enum Class in edu.uky.cs.nil.tt.world
-
The kind of turn being taken
- turnIs(Turn.Type) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.TURN_TYPEmust have the given value. - TutorialWorldFactory - Class in edu.uky.cs.nil.tt
-
A example of how to create a
logical story world model. - type - Variable in class edu.uky.cs.nil.tt.io.GenericAdapter
-
The class of object whose subclasses will always be written as if they were this class
- type - Variable in class edu.uky.cs.nil.tt.world.Turn
-
The kind of turn being taken
- TYPE - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The type of object being described.
- TYPE_NAME - Static variable in class edu.uky.cs.nil.tt.io.AbstractAdapter
-
The name of the JSON key whose value will be the object's runtime type
- typeIs(Class) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.TYPEmust have the given value.
U
- Unique - Interface in edu.uky.cs.nil.tt.world
-
A unique object has a sequential integer ID that specifically distinguishes it from other objects of the same type in the same
story world. - UNSIGNED_INTEGER - Static variable in class edu.uky.cs.nil.tt.world.Encoding
-
The prefixed used by all
unsigned integer encodings - Update - Class in edu.uky.cs.nil.tt.io
-
The updates message is sent from the {edu.uky.cs.nil.tt.Server server} to an
agenteach time a turn is taken and the state of the story world changes. - Update(Status) - Constructor for class edu.uky.cs.nil.tt.io.Update
-
Constructs a new update message with the story world's current status.
- USAGE - Static variable in class edu.uky.cs.nil.tt.ServerMain
-
Usage instructions for the server executable
- Utilities - Class in edu.uky.cs.nil.tt
-
A collection of utility methods used throughout this project.
V
- validate(A) - Method in class edu.uky.cs.nil.tt.world.World
-
If this story world contains an asset matching the name of the given asset, the asset from this story world world with that name is returned; otherwise, an exception is thrown.
- validate(Action) - Method in class edu.uky.cs.nil.tt.world.World
-
If this story world contains an action matching the name of the given action, the action from this story world world with that name is returned; otherwise, an exception is thrown.
- validate(Ending) - Method in class edu.uky.cs.nil.tt.world.World
-
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.
- validate(Entity) - Method in class edu.uky.cs.nil.tt.world.World
-
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.
- validate(Expression[]) - Method in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
-
Checks whether this operator can be applied to the given arguments.
- validate(Variable) - Method in class edu.uky.cs.nil.tt.world.World
-
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.
- value - Variable in class edu.uky.cs.nil.tt.io.Report
-
The answer the agent gives to the survey question
- value - Variable in class edu.uky.cs.nil.tt.Session.Report
-
The value given by the participant for the item or question
- value - Variable in class edu.uky.cs.nil.tt.world.Assignment
-
The value assigned to the variable
- value - Variable in class edu.uky.cs.nil.tt.world.Constant
-
The Java object associated with this constant
- value - Variable in class edu.uky.cs.nil.tt.world.Effect
-
The value or expression whose value will be assigned to the variable
- Value - Interface in edu.uky.cs.nil.tt.world
-
A value is a
logical expressionwhichevaluatesto itself. - VALUE - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The
value of the assignmentbeing described - valueIs(Value) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.VALUEmust have the given value. - valueOf(String) - Static method in enum class edu.uky.cs.nil.tt.Role
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class edu.uky.cs.nil.tt.world.Turn.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class edu.uky.cs.nil.tt.Role
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class edu.uky.cs.nil.tt.world.Proposition.Operator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class edu.uky.cs.nil.tt.world.Turn.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- variable - Variable in class edu.uky.cs.nil.tt.world.Assignment
-
The variable that is being assigned a value
- variable - Variable in class edu.uky.cs.nil.tt.world.Effect
-
The variable whose value will be modified
- Variable - Class in edu.uky.cs.nil.tt.world
- Variable(int, Signature, String, String) - Constructor for class edu.uky.cs.nil.tt.world.Variable
-
Constructs a new variable.
- VARIABLE - Enum constant in enum class edu.uky.cs.nil.tt.world.Describer.Key
-
The variable being described or the
variable of the assignmentbeing described - variableIs(Variable) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that
Describer.Key.VARIABLEmust have the given value. - Verb(String, String) - Constructor for class edu.uky.cs.nil.tt.world.Describer.Verb
-
Constructs a verb from its second person and third person forms, using the second person form as the base.
- Verb(String, String, String) - Constructor for class edu.uky.cs.nil.tt.world.Describer.Verb
-
Constructs a new verb with its base, second person, and third person forms.
- verify() - Method in class edu.uky.cs.nil.tt.io.Choice
- verify() - Method in class edu.uky.cs.nil.tt.io.Connect
- verify() - Method in class edu.uky.cs.nil.tt.io.End
- verify() - Method in class edu.uky.cs.nil.tt.io.Error
- verify() - Method in class edu.uky.cs.nil.tt.io.Join
- verify() - Method in class edu.uky.cs.nil.tt.io.Message
-
Checks that this message is correctly configured and throws an exception if not.
- verify() - Method in class edu.uky.cs.nil.tt.io.Report
- verify() - Method in class edu.uky.cs.nil.tt.io.Start
- verify() - Method in class edu.uky.cs.nil.tt.io.Stop
- verify() - Method in class edu.uky.cs.nil.tt.io.Update
- verify(String) - Method in class edu.uky.cs.nil.tt.Database.AgentEntry
-
Checks whether a given password matches this agent's password.
- version - Variable in class edu.uky.cs.nil.tt.io.Connect
-
The server's software version
- VERSION - Static variable in class edu.uky.cs.nil.tt.Settings
-
The current version of this project
W
- when(Describer.Key, Object) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule that is identical to this rule, except with the requirement that the given key must have the given value for this rule to be applied by a describer.
- world - Variable in class edu.uky.cs.nil.tt.io.Connect.Available
-
The name of the story world the waiting agent wants to play in
- world - Variable in class edu.uky.cs.nil.tt.io.Join
-
The name of the story world this new agent wants to play in, or null if they are willing to play in any story world
- world - Variable in class edu.uky.cs.nil.tt.io.Start
-
The story world in which the session will take place
- world - Variable in class edu.uky.cs.nil.tt.Session
-
The world in which the session took place
- World - Class in edu.uky.cs.nil.tt.world
- World(AssetBuilder) - Constructor for class edu.uky.cs.nil.tt.world.World
-
Constructs a story world from the assets defined in an asset builder.
- World(String, Collection, Collection, Collection, Collection) - Constructor for class edu.uky.cs.nil.tt.world.World
-
Constructs a story world from a unique name and sets of assets.
- WorldEntry(WorldModel) - Constructor for class edu.uky.cs.nil.tt.Database.WorldEntry
-
Constructs a new world database entry from a world model, using the
world's name. - WorldModel - Class in edu.uky.cs.nil.tt.world
-
A world model is an implementation of a
story worldthat contains the necessary logic to simulate howturnschange the story state. - WorldModel(AssetBuilder) - Constructor for class edu.uky.cs.nil.tt.world.WorldModel
-
Constructs a story world model from the assets defined in an asset builder.
- WorldModel(World) - Constructor for class edu.uky.cs.nil.tt.world.WorldModel
-
Constructs a story world model using the assets defined in an existing world.
- WorldModel(String, Collection, Collection, Collection, Collection) - Constructor for class edu.uky.cs.nil.tt.world.WorldModel
-
Constructs a story world model with the assets needed to construct a
story world. - worlds - Variable in class edu.uky.cs.nil.tt.io.Connect
-
A list of
entriesgiving the names and descriptions of the publicly listed worlds available on this server - write() - Method in class edu.uky.cs.nil.tt.Database
-
Writes this database to file.
- write(File) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Serializes this logical world model to a file.
- write(Writer) - Method in class edu.uky.cs.nil.tt.world.LogicalWorld
-
Serializes this logical world model to an output stream.
- write(String) - Method in class edu.uky.cs.nil.tt.world.Describer.Rule
-
Returns a new rule identical to this one, except that its
natural language templatewill be the given value.
All Classes and Interfaces|All Packages|Constant Field Values