etlegacy/JoyStick
0
0
Fork 0
mirror of https://github.com/etlegacy/JoyStick.git synced 2024-11-10 06:42:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
erz05 2017-01-22 14:51:53 -08:00 committed by GitHub
parent b173a4213b
commit 513538f85c
1 changed files with 71 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

81
README.md
View file

@ -26,12 +26,29 @@ repositories {
maven { maven {
url "http://dl.bintray.com/erz05/maven" url "http://dl.bintray.com/erz05/maven"
} }
//Or
jcenter()
} }
dependencies { dependencies {
compile 'com.github.erz05:JoyStick:1.0.3' compile 'com.github.erz05:JoyStick:1.1.0'
} }
``` ```
<H2>v1.10 BREAKING CHANGE!</H2>
1. Made changes to JoyStickListener<br>
a. Added Direction to onMove<br>
b. Added Event calls for onTap and onDoubleTap<br>
<H2>Defaults:</H2>
1. Background = White
2. Button = Red
3. Button Radius = 25%
4. StayPut = false
5. Directional-Axis = 8
<H2>Setup:</H2>
```xml ```xml
<com.erz.joysticklibrary.JoyStick <com.erz.joysticklibrary.JoyStick
@ -46,7 +63,11 @@ dependencies {
android:layout_height="200dp" android:layout_height="200dp"
android:layout_gravity="bottom|right" android:layout_gravity="bottom|right"
app:padColor="#55ffffff" app:padColor="#55ffffff"
app:buttonColor="#55ff0000"/> app:buttonColor="#55ff0000"
app:stayPut="true"
app:percentage="25" //default 25: radius percentage of full size of the view between 25% and 50%
app:backgroundDrawable="R.drawable.background"
app:buttonDrawable="R.drawable.button"/>
``` ```
```java ```java
@ -55,7 +76,54 @@ JoyStick joyStick = (JoyStick) findViewById(R.id.joyStick);
//or //or
JoyStick joyStick = new JoyStick(context); JoyStick joyStick = new JoyStick(context);
```
<H2>JoyStickListener:</H2>
```java
//JoyStickListener Interface
public interface JoyStickListener {
void onMove(JoyStick joyStick, double angle, double power, int direction);
void onTap();
void onDoubleTap();
}
//Set JoyStickListener
joyStick.setListener(this);
```
1. onMove: gets called everytime theres a touch interaction
2. onTap: gets called onSingleTapConfirmed
3. onDoubleTap: gets called onDoubleTap
<H2>Directions:</H2>
1. DIRECTION_CENTER = -1
2. DIRECTION_LEFT = 0
3. DIRECTION_LEFT_UP = 1
4. DIRECTION_UP = 2
5. DIRECTION_UP_RIGHT = 3
6. DIRECTION_RIGHT = 4
7. DIRECTION_RIGHT_DOWN = 5
8. DIRECTION_DOWN = 6
9. DIRECTION_DOWN_LEFT = 7
To get JoyStick direction you can use
```java
joyStick.getDirection();
```
or get it from the JoyStickListener
<H2>Axis Types:</H2>
1. TYPE_8_AXIS
2. TYPE_4_AXIS
3. TYPE_2_AXIS_LEFT_RIGHT
4. TYPE_2_AXIS_UP_DOWN
To set Axis Type:
```java
joyStick.setType(JoyStick.TYPE_4_AXIS);
```
<H2>Getters/Setters</H2>
```java
//Set GamePad Color //Set GamePad Color
joyStick.setPadColor(Color.BLACK); joyStick.setPadColor(Color.BLACK);
@ -82,15 +150,8 @@ joyStick.getAngle();
//Get Angle in Degrees //Get Angle in Degrees
joyStick.getAngleDegrees(); joyStick.getAngleDegrees();
//Set JoyStickListener
joyStick.setListener(this);
//JoyStickListener Interface
public interface JoyStickListener {
void onMove(JoyStick joyStick, double angle, double power);
}
``` ```
<H2>License</H2> <H2>License</H2>
Copyright 2015 erz05 Copyright 2015 erz05