NetLogo
7.0.0-beta2
API
Generated with
NetLogo/org.nlogo/org.nlogo.agent/Agent

Agent

org.nlogo.agent.Agent
See theAgent companion object
abstract class Agent(val world: World) extends Agent, Comparable[Agent]

Attributes

Companion
object
Source
Agent.scala
Graph
Supertypes
trait Comparable[Agent]
trait Agent
class Object
trait Matchable
class Any
Known subtypes
trait AgentColors
trait Constraints
class Observer

Members list

Value members

Abstract methods

def agentBit: Int

Attributes

Source
Agent.scala
def classDisplayName: String

Returns a displayable name of this type of agent (Turtle, Link, Patch, Observer)

Returns a displayable name of this type of agent (Turtle, Link, Patch, Observer)

Attributes

Source
Agent.scala
def getBreedVariable(name: String): AnyRef

Attributes

Source
Agent.scala
def getLinkBreedVariable(name: String): AnyRef

Attributes

Source
Agent.scala
def getLinkVariable(vn: Int): AnyRef

Attributes

Source
Agent.scala
def getPatchAtOffsets(dx: Double, dy: Double): Patch

Attributes

Source
Agent.scala
def getPatchVariable(vn: Int): AnyRef

Attributes

Source
Agent.scala
def getTurtleOrLinkVariable(varName: String): AnyRef

Attributes

Source
Agent.scala
def getTurtleVariable(vn: Int): AnyRef

Attributes

Source
Agent.scala
def getVariable(vn: Int): AnyRef

Returns the value of the variable in the given position of the agent variable array

Returns the value of the variable in the given position of the agent variable array

Value parameters

vn

the index into the agent variable array

Attributes

Source
Agent.scala
def setBreedVariable(name: String, value: AnyRef): Unit

Attributes

Source
Agent.scala
def setLinkBreedVariable(name: String, value: AnyRef): Unit

Attributes

Source
Agent.scala
def setLinkVariable(vn: Int, value: AnyRef): Unit

Attributes

Source
Agent.scala
def setLinkVariable(vn: Int, value: Double): Unit

Attributes

Source
Agent.scala
def setPatchVariable(vn: Int, value: AnyRef): Unit

Attributes

Source
Agent.scala
def setPatchVariable(vn: Int, value: Double): Unit

Attributes

Source
Agent.scala
def setTurtleOrLinkVariable(varName: String, value: AnyRef): Unit

Attributes

Source
Agent.scala
def setTurtleVariable(vn: Int, value: AnyRef): Unit

Attributes

Source
Agent.scala
def setTurtleVariable(vn: Int, value: Double): Unit

Attributes

Source
Agent.scala
def setVariable(vn: Int, value: AnyRef): Unit

Sets the variable in the position vn of the agent variable array to value

Sets the variable in the position vn of the agent variable array to value

Value parameters

value

the new value for the variable

vn

the index into the agent variable array

Attributes

Throws
api.AgentException

If value is the wrong type for the given variable or if you try to change variables that cannot be changed

Source
Agent.scala
def variableName(vn: Int): String

Returns the name of the variable with the given index. Works for built-in, *-own, and breed variables.

Returns the name of the variable with the given index. Works for built-in, *-own, and breed variables.

Value parameters

vn

the index of the variable

Attributes

Source
Agent.scala

Concrete methods

override def compareTo(a: Agent): Int

Attributes

Definition Classes
Comparable
Source
Agent.scala
def id: Long

Returns the id number of this agent. The who number in the case of a turtle, index into the array in the case of patches

Returns the id number of this agent. The who number in the case of a turtle, index into the array in the case of patches

Attributes

Source
Agent.scala
def id_=(newId: Long): Unit

Attributes

Source
Agent.scala
def setId(newId: Long): Unit

Attributes

Source
Agent.scala
def setVariables(v: Array[AnyRef]): Unit

Attributes

Source
Agent.scala
def variables: Array[AnyRef]

Returns raw array of all agent variables. Warning: this method is liable to change return type in a future API version.

Returns raw array of all agent variables. Warning: this method is liable to change return type in a future API version.

Attributes

Source
Agent.scala
def variables_=(v: Array[AnyRef]): Unit

Attributes

Source
Agent.scala

Inherited and Abstract methods

def alpha: Int

0-255, 0 = invisible, 255 = opaque

0-255, 0 = invisible, 255 = opaque

Attributes

Inherited from:
Agent
Source
Agent.scala
def kind: AgentKind

Returns the kind of this agent (Turtle, Link, Patch, Observer).

Returns the kind of this agent (Turtle, Link, Patch, Observer).

Attributes

Inherited from:
Agent
Source
Agent.scala
def shape: String

Returns the name of the current shape, empty string in the case of patches.

Returns the name of the current shape, empty string in the case of patches.

Attributes

Inherited from:
Agent
Source
Agent.scala
def size: Double

Returns the size of this agent

Returns the size of this agent

Attributes

Inherited from:
Agent
Source
Agent.scala

Concrete fields

val world: World

Returns the world object associated with this agent

Returns the world object associated with this agent

Attributes

Source
Agent.scala

Inherited fields

var _id: Long

Attributes

Inherited from:
AgentJ (hidden)
Generated with