# DirectionAxis

Represents a direction axis (X, Y, Z)

## Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
```zenscript
import crafttweaker.api.util.DirectionAxis;
```


## Implemented Interfaces
DirectionAxis implements the following interfaces. That means all methods defined in these interfaces are also available in DirectionAxis

- Predicate

## Enum Constants

DirectionAxis is an enum. It has 3 enum constants. They are accessible using the code below.

```zenscript
DirectionAxis.X
DirectionAxis.Y
DirectionAxis.Z
```
## Methods

:::group{name=equals}

Return Type: boolean

```zenscript
DirectionAxis.equals(o as Object) as boolean
```

| Parameter | Type | Description |
|-----------|------|-------------|
| o | Object | No Description Provided |


:::

:::group{name=getCoordinate}

Gets the coordinate of this axis based on the given values, if this axis is "X", then it will return the value of the "x" parameter

Returns: value of the coordinate  
Return Type: double

```zenscript
// DirectionAxis.getCoordinate(x as double, y as double, z as double) as double

<directionaxis:x>.getCoordinate(1.2, 2.5, 3.87);
```

| Parameter | Type | Description |
|-----------|------|-------------|
| x | double | x value of the coordinate |
| y | double | y value of the coordinate |
| z | double | z value of the coordinate |


:::

:::group{name=getCoordinate}

Gets the coordinate of this axis based on the given values, if this axis is "X", then it will return the value of the "x" parameter

Returns: value of the coordinate  
Return Type: int

```zenscript
// DirectionAxis.getCoordinate(x as int, y as int, z as int) as int

<directionaxis:x>.getCoordinate(1, 2, 3);
```

| Parameter | Type | Description |
|-----------|------|-------------|
| x | int | x value of the coordinate |
| y | int | y value of the coordinate |
| z | int | z value of the coordinate |


:::

:::group{name=hashCode}

Return Type: int

```zenscript
// DirectionAxis.hashCode() as int

<directionaxis:x>.hashCode();
```

:::


## Properties

| Name | Type | Has Getter | Has Setter | Description |
|------|------|------------|------------|-------------|
| commandString | string | true | false | No Description Provided |
| hashCode | int | true | false | No Description Provided |
| horizontal | boolean | true | false | No Description Provided |
| name | string | true | false | Get the name of this Axis ("X", "Y" or "Z") |
| ordinal | int | true | false | Gets the enum ordinal of this axis |
| vertical | boolean | true | false | No Description Provided |



Parameter	Type	Description
Parameter x	Type double	Description x value of the coordinate
Parameter y	Type double	Description y value of the coordinate
Parameter z	Type double	Description z value of the coordinate

Parameter	Type	Description
Parameter x	Type int	Description x value of the coordinate
Parameter y	Type int	Description y value of the coordinate
Parameter z	Type int	Description z value of the coordinate

Name	Type	Has Getter	Has Setter	Description
Name commandString	Type string	Has Getter true	Has Setter false	Description No Description Provided
Name hashCode	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name horizontal	Type boolean	Has Getter true	Has Setter false	Description No Description Provided
Name name	Type string	Has Getter true	Has Setter false	Description Get the name of this Axis ("X", "Y" or "Z")
Name ordinal	Type int	Has Getter true	Has Setter false	Description Gets the enum ordinal of this axis
Name vertical	Type boolean	Has Getter true	Has Setter false	Description No Description Provided