case class Entity(loc: Location, id: AST.Identifier, options: Seq[EntityOption] = Seq.empty[EntityOption], states: Seq[State] = Seq.empty[State], types: Seq[Type] = Seq.empty[Type], handlers: Seq[Handler] = Seq.empty[Handler], functions: Seq[Function] = Seq.empty[Function], invariants: Seq[Invariant] = Seq.empty[Invariant], includes: Seq[Include] = Seq.empty[Include], authors: Seq[AuthorInfo] = Seq.empty[AuthorInfo], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None) extends ContextDefinition with TypeContainer with WithTypes with WithOptions[EntityOption] with WithIncludes with WithAuthors with Product with Serializable
Definition of an Entity
- loc
The location in the input
- id
The name of the entity
- options
The options for the entity
- states
The state values of the entity
- types
Type definitions useful internally to the entity definition
- handlers
A set of event handlers
- functions
Utility functions defined for the entity
- invariants
Invariant properties of the entity
- brief
A brief description (one sentence) for use in documentation
- description
Optional description of the entity
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- Entity
- Serializable
- Product
- Equals
- WithAuthors
- WithIncludes
- WithOptions
- WithTypes
- TypeContainer
- ContextDefinition
- Definition
- Container
- BrieflyDescribedValue
- DescribedValue
- RiddlValue
- RiddlNode
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new Entity(loc: Location, id: AST.Identifier, options: Seq[EntityOption] = Seq.empty[EntityOption], states: Seq[State] = Seq.empty[State], types: Seq[Type] = Seq.empty[Type], handlers: Seq[Handler] = Seq.empty[Handler], functions: Seq[Function] = Seq.empty[Function], invariants: Seq[Invariant] = Seq.empty[Invariant], includes: Seq[Include] = Seq.empty[Include], authors: Seq[AuthorInfo] = Seq.empty[AuthorInfo], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None)
- loc
The location in the input
- id
The name of the entity
- options
The options for the entity
- states
The state values of the entity
- types
Type definitions useful internally to the entity definition
- handlers
A set of event handlers
- functions
Utility functions defined for the entity
- invariants
Invariant properties of the entity
- brief
A brief description (one sentence) for use in documentation
- description
Optional description of the entity
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val authors: Seq[AuthorInfo]
- Definition Classes
- Entity → WithAuthors
- val brief: Option[AST.LiteralString]
- Definition Classes
- Entity → BrieflyDescribedValue
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def collectMessages: Seq[Type]
- Definition Classes
- TypeContainer
- def containedDefinitions: Seq[AST.Definition]
- Definition Classes
- WithIncludes
- lazy val contents: Seq[AST.EntityDefinition]
- val description: Option[AST.Description]
- Definition Classes
- Entity → DescribedValue
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def format: String
Format the node to a string
Format the node to a string
- Definition Classes
- WithOptions → RiddlNode
- val functions: Seq[Function]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getOptionValue[OPT <: EntityOption](implicit arg0: ClassTag[OPT]): Option[Seq[AST.LiteralString]]
- Definition Classes
- WithOptions
- val handlers: Seq[Handler]
- def hasAuthors: Boolean
- Definition Classes
- WithAuthors → Definition
- def hasOption[OPT <: EntityOption](implicit arg0: ClassTag[OPT]): Boolean
- Definition Classes
- WithOptions
- def hasOptions: Boolean
- Definition Classes
- WithOptions → Definition
- def hasTypes: Boolean
- Definition Classes
- WithTypes → Definition
- val id: AST.Identifier
- Definition Classes
- Entity → Definition
- def identify: String
- Definition Classes
- Definition
- def identifyWithLoc: String
- Definition Classes
- Definition
- val includes: Seq[Include]
- Definition Classes
- Entity → WithIncludes
- val invariants: Seq[Invariant]
- def isContainer: Boolean
Determine if this node is a container or not
- def isEmpty: Boolean
determine if this node is empty or not.
determine if this node is empty or not. Non-containers are always empty
- Definition Classes
- Entity → WithOptions → Container → RiddlNode
- def isImplicit: Boolean
- Definition Classes
- Definition
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isRootContainer: Boolean
- Definition Classes
- Container
- final val kind: String
- Definition Classes
- Entity → Definition
- def kindId: String
- Definition Classes
- Definition
- val loc: Location
The location in the parse at which this RiddlValue occurs
The location in the parse at which this RiddlValue occurs
- Definition Classes
- Entity → RiddlValue
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def nonEmpty: Boolean
- Definition Classes
- RiddlNode
- Annotations
- @deprecatedOverriding()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- val options: Seq[EntityOption]
- Definition Classes
- Entity → WithOptions
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val states: Seq[State]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val types: Seq[Type]
- Definition Classes
- Entity → WithTypes → TypeContainer
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated