battle_city v0.1.6

BattleCity.Environment behaviour (battle_city v0.1.6) View Source

Environment

Link to this section Summary

Types

env_object()
t()

Functions

copy_rxy(map, o)
copy_xy(map, o)
enter(environment, bullet)
hit(env, damage)
leave(environment, o)
reset(env, module)

Callbacks

handle_enter(t, env_object)
handle_init(map)
handle_leave(t, env_object)

Link to this section Types

Link to this type

env_object()

View Source

Specs

env_object() :: BattleCity.Tank.t() | BattleCity.Bullet.t()
Link to this type

t()

View Source

Specs

t() :: %BattleCity.Environment{
  __module__: module(),
  enter?: boolean(),
  health: health(),
  id: BattleCity.id(),
  position: BattleCity.Position.t(),
  raw: binary(),
  shape: shape()
}

Link to this section Functions

Link to this function

copy_rxy(map, o)

View Source

Specs

copy_rxy(t(), env_object()) :: env_object()
Link to this function

copy_xy(map, o)

View Source

Specs

copy_xy(t(), env_object()) :: env_object()
Link to this function

enter(environment, bullet)

View Source

Specs

enter(t(), env_object()) :: enter_result()
Link to this function

hit(env, damage)

View Source

Specs

hit(t(), integer()) :: t()
Link to this function

leave(environment, o)

View Source

Specs

leave(t(), env_object()) :: enter_result()
Link to this function

reset(env, module)

View Source

Specs

reset(t(), module()) :: t()

Link to this section Callbacks

Link to this callback

handle_enter(t, env_object)

View Source

Specs

handle_enter(t(), env_object()) :: enter_result()
Link to this callback

handle_init(map)

View Source (optional)

Specs

handle_init(map()) :: map() | {:error, :atom}
Link to this callback

handle_leave(t, env_object)

View Source

Specs

handle_leave(t(), env_object()) :: enter_result()