agentscope.environment.event module

The events which can be bound to envs.

class Event(name: str, args: dict | None = None, returns: Any | None = None)

基类：object

A class representing the information of an event.

It contains the name of the event, the arguments of the event, and the returns of the event.

property args: dict

Return the arguments of the event.

property name: str

Return the name of the event.

property returns: Any

Return the returns of the event.

class Getable

基类：ABC

Representing an env whose value can be gotten.

abstract get() → Any

Get the value of the env.

返回:

The value of the env.

返回类型:

Any

class Holdable

基类：ABC

A class representing an env can be held,and during the holding period, all access behaviors except the owner are prohibited.

abstract acquire(owner: str) → bool

Acquire the env.

参数:

owner (str) – The owner of the env.

返回:

Whether the env was acquired successfully.

返回类型:

bool

abstract release(owner: str) → bool

Release the env.

参数:

owner (str) – The owner of the env.

返回:

Whether the env was released successfully.

返回类型:

bool

class Movable2D

基类：ABC

A class representing an env can be moved in 2D.

abstract get_position() → Tuple[float, float]

Get the position of the env.

返回:

The position of the env.

返回类型:

Tuple[float, float]

abstract move_by(x: float, y: float) → bool

Move the env in 2D by the given vector.

参数:

• x (float) – The movement in x direction.

• y (float) – The movement in y direction.

返回:

Whether the movement was successful.

返回类型:

bool

abstract move_to(x: float, y: float) → bool

Move the env to the given position.

参数:

• x (float) – The x coordinate of the new position.

• y (float) – The y coordinate of the new position.

返回:

Whether the movement was successful.

返回类型:

bool

class Setable

基类：ABC

Representing an env whose value can be set.

abstract set(value: Any) → bool

Set the value of the env.

参数:

value (Any) – The new value of the env.

返回:

Whether the value was set successfully.

返回类型:

bool