Contents

# `AdventureRL::Point`
A point is a two dimensional vector.  
it has an `x` axis and a `y` axis.  
It should be pretty straight-forward and self-explanatory.

__Table of Contents__
- [Methods](#methods)
  - [`initialize`](#initialize)
  - [`assign_to`](#assign_to)
  - [`get_point`](#get_point)
  - [`x`](#x)
  - [`y`](#y)
  - [`get_position`](#get_position)
  - [`set_position`](#set_position)
  - [`collides_with?`](#collides_with)
  - [`keys`](#keys)
  - [`values`](#values)

## Methods
### `initialize`
```ruby
def initialize x, y, args = {}
end
```
Create a new point with `x` and `y` axes.  
You can pass the key `:assign_to` with the value of an object with args  
to make all point methods available directly through the object.

### `assign_to`
```ruby
def assign_to object
end
```
Assigns the object to the point.  
Same as using the key `:assign_to` in `#initialize`.

### `get_point`
```ruby
def get_point
end
```
Returns self.  
Useful for using from objects where the point was assigned to them.

### `x`
```ruby
def x
end
```
Returns the integer for its `x` axis.

### `y`
```ruby
def y
end
```
Returns the integer for its `y` axis.

### `get_position`
```ruby
def get_position target = :all
end
```
Returns either both axes as a hash if target is `:all` or is ommited,  
or returns the value of target's axis.

### `set_position`
```ruby
def set_position
end
```

### `collides_with?`
```ruby
def collides_with? point_or_mask
end
```
This method checks if it is in collision / overlapping with  
a `AdventureRL::Point` or `Adventure::Mask`; the argument accepts both.

### `keys`
```ruby
def keys
end
```
Returns the symbols `:x` and `:y` in an array, respectively.  
Based on `Hash#keys`.

### `values`
```ruby
def values
end
```
Returns the `:x` and `:y` axes in an array, respectively.  
Based on `Hash#values`.

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
adventure_rl-0.0.2	doc/Point.md
adventure_rl-0.0.1.pre.ld42	doc/Point.md