public enum Aud +extends Enum<Aud>+
| Modifier and Type | +Method and Description | +
|---|---|
Audible |
+get() |
+
void |
+play(org.bukkit.Location l) |
+
void |
+play(org.bukkit.entity.Player p) |
+
static Aud |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Aud[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static Aud[] values()+
+for (Aud c : Aud.values()) + System.out.println(c); +
public static Aud valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Audible get()+
public void play(org.bukkit.entity.Player p)+
public void play(org.bukkit.Location l)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/Audible.html b/docs/org/phantomapi/sfx/Audible.html new file mode 100644 index 000000000..ae4a8f8e6 --- /dev/null +++ b/docs/org/phantomapi/sfx/Audible.html @@ -0,0 +1,411 @@ + + + + + + +public interface Audible
+| Modifier and Type | +Method and Description | +
|---|---|
Audible |
+clone()
+Clone the audio
+ |
+
Float |
+getPitch()
+get the pitch
+ |
+
Float |
+getVolume()
+Get volume
+ |
+
void |
+play(org.bukkit.Location l)
+Play the sound globally
+ |
+
void |
+play(org.bukkit.entity.Player p)
+Play the sound to just the player
+ |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.Location l)
+Play the sound to just the player
+ |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.util.Vector v)
+Play the sound to the player
+ |
+
void |
+setPitch(Float pitch)
+Set the pitch
+ |
+
void |
+setVolume(Float volume)
+Sets the volume
+ |
+
void play(org.bukkit.entity.Player p, + org.bukkit.Location l)+
p - the playerl - the locationvoid play(org.bukkit.entity.Player p)+
p - the playervoid play(org.bukkit.Location l)+
l - the locationvoid play(org.bukkit.entity.Player p, + org.bukkit.util.Vector v)+
p - the playerv - relative to the players locationFloat getVolume()+
void setVolume(Float volume)+
volume - the volumeFloat getPitch()+
void setPitch(Float pitch)+
pitch - the pitchAudible clone()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/AudibleEntity.html b/docs/org/phantomapi/sfx/AudibleEntity.html new file mode 100644 index 000000000..7ad4b0fde --- /dev/null +++ b/docs/org/phantomapi/sfx/AudibleEntity.html @@ -0,0 +1,384 @@ + + + + + + +public class AudibleEntity +extends Object+
| Constructor and Description | +
|---|
AudibleEntity(org.bukkit.entity.Entity entity,
+ Audible audible,
+ Integer interval)
+Create the audio bind to an entity
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+cancel()
+Stop playing the sound
+ |
+
Audible |
+getAudible()
+Get the audible sound
+ |
+
org.bukkit.entity.Entity |
+getEntity()
+Get the entity
+ |
+
protected void |
+onPlay(org.bukkit.entity.Player i,
+ Audible audible,
+ org.bukkit.entity.Entity entity)
+Override when played
+ |
+
void |
+setAudible(Audible audible)
+Set the sound
+ |
+
public void cancel()+
protected void onPlay(org.bukkit.entity.Player i, + Audible audible, + org.bukkit.entity.Entity entity)+
i - the playeraudible - the soundentity - the entitypublic Audible getAudible()+
public void setAudible(Audible audible)+
audible - the soundpublic org.bukkit.entity.Entity getEntity()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/Audio.html b/docs/org/phantomapi/sfx/Audio.html new file mode 100644 index 000000000..9fccfc68e --- /dev/null +++ b/docs/org/phantomapi/sfx/Audio.html @@ -0,0 +1,542 @@ + + + + + + +| Constructor and Description | +
|---|
Audio()
+Create an audible object
+ |
+
Audio(GList<Audible> audibles)
+Create an audible entity with multiple sub-audibles
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(Audible audible)
+Add an audible object to the sound entity
+ |
+
Audible |
+clone()
+Clone the audio
+ |
+
Float |
+getPitch()
+get the pitch
+ |
+
Float |
+getVolume()
+Get volume
+ |
+
void |
+play(org.bukkit.Location l)
+Play the sound globally
+ |
+
void |
+play(org.bukkit.entity.Player p)
+Play the sound to just the player
+ |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.Location l)
+Play the sound to just the player
+ |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.util.Vector v)
+Play the sound to the player
+ |
+
Audio |
+qadd(Audible audible) |
+
void |
+setPitch(Float pitch)
+Set the pitch
+ |
+
void |
+setVolume(Float volume)
+Sets the volume
+ |
+
public Audio()+
public void add(Audible audible)+
audible - to be played with the otherspublic void play(org.bukkit.entity.Player p, + org.bukkit.Location l)+
Audiblepublic void play(org.bukkit.entity.Player p)+
Audiblepublic void play(org.bukkit.Location l)+
Audiblepublic void play(org.bukkit.entity.Player p, + org.bukkit.util.Vector v)+
Audiblepublic Float getVolume()+
Audiblepublic void setVolume(Float volume)+
Audiblepublic Float getPitch()+
AudibleCopyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/AudioDistortion.html b/docs/org/phantomapi/sfx/AudioDistortion.html new file mode 100644 index 000000000..23d16c639 --- /dev/null +++ b/docs/org/phantomapi/sfx/AudioDistortion.html @@ -0,0 +1,277 @@ + + + + + + +public abstract class AudioDistortion +extends Object+
| Constructor and Description | +
|---|
AudioDistortion() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract Audible |
+distort(Audible a) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/BasicSequencer.html b/docs/org/phantomapi/sfx/BasicSequencer.html new file mode 100644 index 000000000..0976f394b --- /dev/null +++ b/docs/org/phantomapi/sfx/BasicSequencer.html @@ -0,0 +1,603 @@ + + + + + + +| Constructor and Description | +
|---|
BasicSequencer() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(Audible a,
+ int timing)
+Add an audible object to the track with a time slot (in ticks)
+ |
+
Audible |
+clone()
+Clone the audio
+ |
+
int |
+getLength()
+Get the length of this sequence in ticks
+ |
+
Float |
+getPitch()
+get the pitch
+ |
+
int |
+getPlayHead()
+Get the position of the playhead
+ |
+
Float |
+getVolume()
+Get volume
+ |
+
boolean |
+isPlaying()
+Is the sequencer currently playing?
+ |
+
void |
+play(org.bukkit.Location l)
+Play the sound globally
+ |
+
void |
+play(org.bukkit.entity.Player p)
+Play the sound to just the player
+ |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.Location l)
+Play the sound to just the player
+ |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.util.Vector v)
+Play the sound to the player
+ |
+
void |
+setPitch(Float pitch)
+Set the pitch
+ |
+
void |
+setPlayHead(int p)
+Set the position of the playhead
+ |
+
void |
+setVolume(Float volume)
+Sets the volume
+ |
+
public void play(org.bukkit.entity.Player p, + org.bukkit.Location l)+
Audiblepublic void play(org.bukkit.entity.Player p)+
Audiblepublic void play(org.bukkit.Location l)+
Audiblepublic void play(org.bukkit.entity.Player p, + org.bukkit.util.Vector v)+
Audiblepublic Float getVolume()+
Audiblepublic void setVolume(Float volume)+
Audiblepublic Float getPitch()+
Audiblepublic void setPitch(Float pitch)+
Audiblepublic void add(Audible a, + int timing)+
Sequencerpublic boolean isPlaying()+
Sequencerpublic void setPlayHead(int p)+
SequencersetPlayHead in interface Sequencerp - the posititionpublic int getLength()+
Sequencerpublic int getPlayHead()+
SequencergetPlayHead in interface SequencerCopyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/DopplerAudibleEntity.html b/docs/org/phantomapi/sfx/DopplerAudibleEntity.html new file mode 100644 index 000000000..066196cc8 --- /dev/null +++ b/docs/org/phantomapi/sfx/DopplerAudibleEntity.html @@ -0,0 +1,310 @@ + + + + + + +public class DopplerAudibleEntity +extends AudibleEntity+
| Constructor and Description | +
|---|
DopplerAudibleEntity(org.bukkit.entity.Entity entity,
+ Audible audible,
+ Integer interval) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+onPlay(org.bukkit.entity.Player i,
+ Audible audible,
+ org.bukkit.entity.Entity entity)
+Override when played
+ |
+
cancel, getAudible, getEntity, setAudibleprotected void onPlay(org.bukkit.entity.Player i, + Audible audible, + org.bukkit.entity.Entity entity)+
AudibleEntityonPlay in class AudibleEntityi - the playeraudible - the soundentity - the entityCopyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/Instrument.html b/docs/org/phantomapi/sfx/Instrument.html new file mode 100644 index 000000000..93e69b8a8 --- /dev/null +++ b/docs/org/phantomapi/sfx/Instrument.html @@ -0,0 +1,1188 @@ + + + + + + +public enum Instrument +extends Enum<Instrument>+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+play(org.bukkit.Location l) |
+
void |
+play(org.bukkit.entity.Player p) |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.Location l) |
+
static Instrument |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Instrument[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Instrument CLICK+
public static final Instrument KINDLE_HIGH+
public static final Instrument KINDLE_MID+
public static final Instrument KINDLE_LOW+
public static final Instrument KINDLE_WIDE+
public static final Instrument GRAVEL_HIGH+
public static final Instrument GRAVEL_MID+
public static final Instrument GRAVEL_LOW+
public static final Instrument GRAVEL_WIDE+
public static final Instrument BWANG_HIGH+
public static final Instrument BWANG_MID+
public static final Instrument BWANG_LOW+
public static final Instrument POCKET_HIGH+
public static final Instrument POCKET_MID+
public static final Instrument POCKET_LOW+
public static final Instrument SWEEP_HIGH+
public static final Instrument SWEEP_MID+
public static final Instrument SWEEP_LOW+
public static final Instrument BOB_CLOSE_HIGH+
public static final Instrument BOB_CLOSE_MID+
public static final Instrument BOB_CLOSE_LOW+
public static final Instrument THICK_CLOSE_HIGH+
public static final Instrument THICK_CLOSE_MID+
public static final Instrument THICK_CLOSE_LOW+
public static final Instrument BRITTLE_HIGH+
public static final Instrument BRITTLE_MID+
public static final Instrument BRITTLE_LOW+
public static final Instrument SHOOT_HIGH+
public static final Instrument SHOOT_MID+
public static final Instrument SHOOT_LOW+
public static final Instrument TWIG_HIGH+
public static final Instrument TWIG_MID+
public static final Instrument TWIG_LOW+
public static final Instrument WOOD_CRACK_HIGH+
public static final Instrument WOOD_CRACK_MID+
public static final Instrument WOOD_CRACK_LOW+
public static final Instrument CRUMBLE_HIGH+
public static final Instrument CRUMBLE_MID+
public static final Instrument CRUMBLE_LOW+
public static final Instrument CRAWL_HIGH+
public static final Instrument CRAWL_MID+
public static final Instrument CRAWL_LOW+
public static final Instrument METAL_CLINK_HIGH+
public static final Instrument METAL_CLINK_MID+
public static final Instrument METAL_CLINK_LOW+
public static final Instrument DEEP_THUMP_HIGH+
public static final Instrument DEEP_THUMP_MID+
public static final Instrument DEEP_THUMP_LOW+
public static final Instrument DEEP_PUNCH_HIGH+
public static final Instrument DEEP_PUNCH_MID+
public static final Instrument DEEP_PUNCH_LOW+
public static final Instrument DEEP_CLICK_HIGH+
public static final Instrument DEEP_CLICK_MID+
public static final Instrument DEEP_CLICK_LOW+
public static final Instrument SHOVEL_HIGH+
public static final Instrument SHOVEL_MID+
public static final Instrument SHOVEL_LOW+
public static final Instrument DEEP_BOOM_HIGH+
public static final Instrument DEEP_BOOM_MID+
public static final Instrument DEEP_BOOM_LOW+
public static final Instrument DEEP_SQUELCH_HIGH+
public static final Instrument DEEP_SQUELCH_MID+
public static final Instrument DEEP_SQUELCH_LOW+
public static final Instrument METAL_HIT_HIGH+
public static final Instrument METAL_HIT_MID+
public static final Instrument METAL_HIT_LOW+
public static final Instrument WOOD_HIT_HIGH+
public static final Instrument WOOD_HIT_MID+
public static final Instrument WOOD_HIT_LOW+
public static Instrument[] values()+
+for (Instrument c : Instrument.values()) + System.out.println(c); +
public static Instrument valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic void play(org.bukkit.Location l)+
public void play(org.bukkit.entity.Player p)+
public void play(org.bukkit.entity.Player p, + org.bukkit.Location l)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/MFADistortion.html b/docs/org/phantomapi/sfx/MFADistortion.html new file mode 100644 index 000000000..8b5bbeda5 --- /dev/null +++ b/docs/org/phantomapi/sfx/MFADistortion.html @@ -0,0 +1,284 @@ + + + + + + +public class MFADistortion +extends AudioDistortion+
| Constructor and Description | +
|---|
MFADistortion(int span,
+ float to) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Audible |
+distort(Audible a) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/Sequencer.html b/docs/org/phantomapi/sfx/Sequencer.html new file mode 100644 index 000000000..2612314f3 --- /dev/null +++ b/docs/org/phantomapi/sfx/Sequencer.html @@ -0,0 +1,334 @@ + + + + + + +public interface Sequencer +extends Audible+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(Audible a,
+ int timing)
+Add an audible object to the track with a time slot (in ticks)
+ |
+
int |
+getLength()
+Get the length of this sequence in ticks
+ |
+
int |
+getPlayHead()
+Get the position of the playhead
+ |
+
boolean |
+isPlaying()
+Is the sequencer currently playing?
+ |
+
void |
+setPlayHead(int p)
+Set the position of the playhead
+ |
+
void add(Audible a, + int timing)+
a - the audibletiming - the amount of ticks into the sequenceboolean isPlaying()+
void setPlayHead(int p)+
p - the posititionint getLength()+
int getPlayHead()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/Aud.html b/docs/org/phantomapi/sfx/class-use/Aud.html new file mode 100644 index 000000000..3136c0bd0 --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/Aud.html @@ -0,0 +1,177 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.phantomapi.sfx | +
+ Audio, Sound structures and distorters.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Aud |
+Aud.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Aud[] |
+Aud.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/Audible.html b/docs/org/phantomapi/sfx/class-use/Audible.html new file mode 100644 index 000000000..ce29e2a86 --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/Audible.html @@ -0,0 +1,366 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.phantomapi.sfx | +
+ Audio, Sound structures and distorters.
+ |
+
| phantom.lang | +
+ A collection of glang
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+Sequencer
+Sequencing of audio
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Audio
+A collection of audibles which may contain more sub-audibles or actual sound
+ objects.
+ |
+
class |
+BasicSequencer
+Represents a basic sequencer
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Audible |
+BasicSequencer.clone() |
+
Audible |
+Audio.clone() |
+
Audible |
+Audible.clone()
+Clone the audio
+ |
+
Audible |
+MFADistortion.distort(Audible a) |
+
abstract Audible |
+AudioDistortion.distort(Audible a) |
+
Audible |
+Aud.get() |
+
Audible |
+AudibleEntity.getAudible()
+Get the audible sound
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Audio.add(Audible audible)
+Add an audible object to the sound entity
+ |
+
void |
+Sequencer.add(Audible a,
+ int timing)
+Add an audible object to the track with a time slot (in ticks)
+ |
+
void |
+BasicSequencer.add(Audible a,
+ int timing) |
+
Audible |
+MFADistortion.distort(Audible a) |
+
abstract Audible |
+AudioDistortion.distort(Audible a) |
+
protected void |
+DopplerAudibleEntity.onPlay(org.bukkit.entity.Player i,
+ Audible audible,
+ org.bukkit.entity.Entity entity) |
+
protected void |
+AudibleEntity.onPlay(org.bukkit.entity.Player i,
+ Audible audible,
+ org.bukkit.entity.Entity entity)
+Override when played
+ |
+
Audio |
+Audio.qadd(Audible audible) |
+
void |
+AudibleEntity.setAudible(Audible audible)
+Set the sound
+ |
+
| Constructor and Description | +
|---|
AudibleEntity(org.bukkit.entity.Entity entity,
+ Audible audible,
+ Integer interval)
+Create the audio bind to an entity
+ |
+
DopplerAudibleEntity(org.bukkit.entity.Entity entity,
+ Audible audible,
+ Integer interval) |
+
| Constructor and Description | +
|---|
Audio(GList<Audible> audibles)
+Create an audible entity with multiple sub-audibles
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+GSound
+A GSound can play a sound
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Audible |
+GSound.clone()
+clone it
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/AudibleEntity.html b/docs/org/phantomapi/sfx/class-use/AudibleEntity.html new file mode 100644 index 000000000..72b69bcfc --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/AudibleEntity.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.phantomapi.sfx | +
+ Audio, Sound structures and distorters.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+DopplerAudibleEntity
+Doppler audio effect
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/Audio.html b/docs/org/phantomapi/sfx/class-use/Audio.html new file mode 100644 index 000000000..6db5a73a4 --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/Audio.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.phantomapi.sfx | +
+ Audio, Sound structures and distorters.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Audio |
+Audio.qadd(Audible audible) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/AudioDistortion.html b/docs/org/phantomapi/sfx/class-use/AudioDistortion.html new file mode 100644 index 000000000..76bf7aa9e --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/AudioDistortion.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.phantomapi.sfx | +
+ Audio, Sound structures and distorters.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+MFADistortion |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/BasicSequencer.html b/docs/org/phantomapi/sfx/class-use/BasicSequencer.html new file mode 100644 index 000000000..43db7fb5c --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/BasicSequencer.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/DopplerAudibleEntity.html b/docs/org/phantomapi/sfx/class-use/DopplerAudibleEntity.html new file mode 100644 index 000000000..f1809c89e --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/DopplerAudibleEntity.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/Instrument.html b/docs/org/phantomapi/sfx/class-use/Instrument.html new file mode 100644 index 000000000..5179d4a33 --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/Instrument.html @@ -0,0 +1,177 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.phantomapi.sfx | +
+ Audio, Sound structures and distorters.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Instrument |
+Instrument.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Instrument[] |
+Instrument.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/MFADistortion.html b/docs/org/phantomapi/sfx/class-use/MFADistortion.html new file mode 100644 index 000000000..d50a6fa77 --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/MFADistortion.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/class-use/Sequencer.html b/docs/org/phantomapi/sfx/class-use/Sequencer.html new file mode 100644 index 000000000..7564b6792 --- /dev/null +++ b/docs/org/phantomapi/sfx/class-use/Sequencer.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.phantomapi.sfx | +
+ Audio, Sound structures and distorters.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BasicSequencer
+Represents a basic sequencer
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/package-frame.html b/docs/org/phantomapi/sfx/package-frame.html new file mode 100644 index 000000000..96f9f34af --- /dev/null +++ b/docs/org/phantomapi/sfx/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Audible | +
+ Allows you to wrap either objects or more folders of wrappers into one
+ audible object allowing multiple sounds at different pitches and volumes be
+ played with one object
+ |
+
| Sequencer | +
+ Sequencing of audio
+ |
+
| Class | +Description | +
|---|---|
| AudibleEntity | +
+ Audio bound to entities
+ |
+
| Audio | +
+ A collection of audibles which may contain more sub-audibles or actual sound
+ objects.
+ |
+
| AudioDistortion | ++ |
| BasicSequencer | +
+ Represents a basic sequencer
+ |
+
| DopplerAudibleEntity | +
+ Doppler audio effect
+ |
+
| MFADistortion | ++ |
| Enum | +Description | +
|---|---|
| Aud | +
+ Audio sounds commonly used
+ |
+
| Instrument | ++ |
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/package-tree.html b/docs/org/phantomapi/sfx/package-tree.html new file mode 100644 index 000000000..98d4a7545 --- /dev/null +++ b/docs/org/phantomapi/sfx/package-tree.html @@ -0,0 +1,171 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/sfx/package-use.html b/docs/org/phantomapi/sfx/package-use.html new file mode 100644 index 000000000..6dcca5826 --- /dev/null +++ b/docs/org/phantomapi/sfx/package-use.html @@ -0,0 +1,217 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.phantomapi.sfx | +
+ Audio, Sound structures and distorters.
+ |
+
| phantom.lang | +
+ A collection of glang
+ |
+
| Class and Description | +
|---|
| Aud
+ Audio sounds commonly used
+ |
+
| Audible
+ Allows you to wrap either objects or more folders of wrappers into one
+ audible object allowing multiple sounds at different pitches and volumes be
+ played with one object
+ |
+
| AudibleEntity
+ Audio bound to entities
+ |
+
| Audio
+ A collection of audibles which may contain more sub-audibles or actual sound
+ objects.
+ |
+
| AudioDistortion | +
| Instrument | +
| Sequencer
+ Sequencing of audio
+ |
+
| Class and Description | +
|---|
| Audible
+ Allows you to wrap either objects or more folders of wrappers into one
+ audible object allowing multiple sounds at different pitches and volumes be
+ played with one object
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/org/phantomapi/test/TestAsyncTask.html b/docs/org/phantomapi/test/TestAsyncTask.html index a77187891..159def0c9 100644 --- a/docs/org/phantomapi/test/TestAsyncTask.html +++ b/docs/org/phantomapi/test/TestAsyncTask.html @@ -2,9 +2,9 @@ - + -public class Inventories +extends Object+
| Constructor and Description | +
|---|
Inventories() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static GList<org.bukkit.inventory.ItemStack> |
+getActualContents(org.bukkit.inventory.Inventory i)
+Get the ACTUAL contents in this inventory.
+ |
+
static int |
+getEmptySlots(org.bukkit.inventory.Inventory ix)
+Get the count of empty slots (or air slots)
+ |
+
static boolean |
+hasSpace(org.bukkit.inventory.Inventory i)
+Does the inventory have any space (empty slots)
+ |
+
static boolean |
+hasSpace(org.bukkit.inventory.Inventory i,
+ int slots)
+Does the inventory have a given amount of empty space (or more)
+ |
+
static boolean |
+hasSpace(org.bukkit.inventory.Inventory i,
+ org.bukkit.inventory.ItemStack item)
+Does the inventory have space for the given item
+ |
+
public static boolean hasSpace(org.bukkit.inventory.Inventory i)+
i - the inventorypublic static boolean hasSpace(org.bukkit.inventory.Inventory i, + int slots)+
i - the inventoryslots - the slots needed emptypublic static GList<org.bukkit.inventory.ItemStack> getActualContents(org.bukkit.inventory.Inventory i)+
i - the inventorypublic static boolean hasSpace(org.bukkit.inventory.Inventory i, + org.bukkit.inventory.ItemStack item)+
i - the inventoryitem - the itempublic static int getEmptySlots(org.bukkit.inventory.Inventory ix)+
i - the inventoryCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/inventory/class-use/Inventories.html b/docs/phantom/inventory/class-use/Inventories.html new file mode 100644 index 000000000..df885f59c --- /dev/null +++ b/docs/phantom/inventory/class-use/Inventories.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/inventory/package-frame.html b/docs/phantom/inventory/package-frame.html index 1e586a817..387fd6e34 100644 --- a/docs/phantom/inventory/package-frame.html +++ b/docs/phantom/inventory/package-frame.html @@ -2,14 +2,20 @@ - + -public class ByteMap2D +extends Object+
| Constructor and Description | +
|---|
ByteMap2D(int x,
+ int y,
+ byte b)
+Create a byte map
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+clear(byte b)
+Clear the entire byte map with the given byte
+ |
+
void |
+clear(int x1,
+ int y1,
+ int x2,
+ int y2,
+ byte b)
+Clear the map
+ |
+
byte |
+get(int x,
+ int y)
+Get the given x and y byte
+ |
+
int |
+getHeight()
+Get the height
+ |
+
byte[][] |
+getMap()
+Get the byte array
+ |
+
int |
+getWidth()
+Get the width
+ |
+
void |
+set(int x,
+ int y,
+ byte b)
+Set the given x and y to a byte
+ |
+
public ByteMap2D(int x, + int y, + byte b)+
x - the widthy - the heightb - the byte to fill it initially withpublic void clear(int x1, + int y1, + int x2, + int y2, + byte b)+
x1 - the first xy1 - the first yx2 - the second xy2 - the second yb - the byte to clear it withpublic void clear(byte b)+
b - the given bytepublic void set(int x, + int y, + byte b)+
x - the xy - the yb - the bytepublic byte get(int x, + int y)+
x - the xy - the ypublic byte[][] getMap()+
public int getWidth()+
public int getHeight()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/Callback.html b/docs/phantom/lang/Callback.html index 00fbc5252..8e3d1021e 100644 --- a/docs/phantom/lang/Callback.html +++ b/docs/phantom/lang/Callback.html @@ -2,9 +2,9 @@ - + -| Constructor and Description | +
|---|
GSound(org.bukkit.Sound iSound)
+Create a new sound
+ |
+
GSound(org.bukkit.Sound iSound,
+ Float volume,
+ Float pitch)
+Create a new sound
+ |
+
GSound(org.bukkit.Sound iSound,
+ String sound,
+ Float volume,
+ Float pitch)
+Create a new sound object
+ |
+
GSound(String sound)
+Create a sound object
+ |
+
GSound(String sound,
+ Float volume,
+ Float pitch)
+Create a sound object
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Audible |
+clone()
+clone it
+ |
+
org.bukkit.Sound |
+getiSound()
+Get the object sound
+ |
+
Float |
+getPitch()
+Get the pitch
+ |
+
String |
+getSound()
+Get the sound
+ |
+
Float |
+getVolume()
+Get the volume
+ |
+
void |
+play(org.bukkit.Location l)
+Play the sound globally to all players
+ |
+
void |
+play(org.bukkit.entity.Player p)
+Play the sound to just one player.
+ |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.Location l)
+Play the sound to just one player.
+ |
+
void |
+play(org.bukkit.entity.Player p,
+ org.bukkit.util.Vector v)
+Play the sound to just one player.
+ |
+
void |
+prePlay() |
+
void |
+setiSound(org.bukkit.Sound iSound)
+Set the object sound
+ |
+
void |
+setPitch(Float pitch)
+Set the pitch
+ |
+
void |
+setSound(String sound)
+Set the sound
+ |
+
void |
+setVolume(Float volume)
+Set the volume
+ |
+
public GSound(String sound, + Float volume, + Float pitch)+
sound - the string path for the soundvolume - the volumepitch - the pitchpublic GSound(org.bukkit.Sound iSound, + String sound, + Float volume, + Float pitch)+
iSound - the string pathsound - the sound pathvolume - the volumepitch - the pitchpublic GSound(String sound)+
sound - the sound pathpublic GSound(org.bukkit.Sound iSound, + Float volume, + Float pitch)+
iSound - volume - pitch - public GSound(org.bukkit.Sound iSound)+
iSound - the soundpublic void prePlay()+
public void play(org.bukkit.entity.Player p, + org.bukkit.Location l)+
public void play(org.bukkit.entity.Player p)+
public Audible clone()+
public void play(org.bukkit.Location l)+
public void play(org.bukkit.entity.Player p, + org.bukkit.util.Vector v)+
public String getSound()+
public void setSound(String sound)+
sound - the sound pathpublic org.bukkit.Sound getiSound()+
public void setiSound(org.bukkit.Sound iSound)+
iSound - the soundpublic Float getVolume()+
public void setVolume(Float volume)+
public Float getPitch()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/GTime.html b/docs/phantom/lang/GTime.html new file mode 100644 index 000000000..782ded52d --- /dev/null +++ b/docs/phantom/lang/GTime.html @@ -0,0 +1,506 @@ + + + + + + +public class GTime +extends Object +implements Serializable+
| Constructor and Description | +
|---|
GTime(long duration)
+Create time
+ |
+
GTime(long d,
+ long h,
+ long m,
+ long s,
+ long ms)
+Create time
+ |
+
GTime(String duration)
+Create time
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+ago()
+Time ago ex(4 hours ago)
+ |
+
long |
+getDays() |
+
long |
+getHours() |
+
long |
+getMilliseconds() |
+
long |
+getMinutes() |
+
long |
+getSeconds() |
+
long |
+getTotalDuration() |
+
String |
+shortDescription()
+Describe time
+ |
+
String |
+to()
+short time rep
+ |
+
String |
+to(String suff)
+Returns time with a suffix
+ |
+
String |
+toString() |
+
public GTime(long d, + long h, + long m, + long s, + long ms)+
d - daysh - hoursm - minutess - secondsms - millispublic GTime(long duration)+
duration - the duration in MS (use System.ctm for current)public GTime(String duration)+
duration - string duration of time (from tostring)public long getDays()+
public long getHours()+
public long getMinutes()+
public long getSeconds()+
public long getMilliseconds()+
public long getTotalDuration()+
public String shortDescription()+
public String to()+
public String to(String suff)+
suff - the suffixpublic String ago()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/GTriset.html b/docs/phantom/lang/GTriset.html index 1156acebc..6435ec134 100644 --- a/docs/phantom/lang/GTriset.html +++ b/docs/phantom/lang/GTriset.html @@ -2,9 +2,9 @@ - + -public enum Heaft +extends Enum<Heaft>+
| Enum Constant and Description | +
|---|
BIG |
+
MASSIVE |
+
NORMAL |
+
SMALL |
+
TINY |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Heaft |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Heaft[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Heaft TINY+
public static final Heaft SMALL+
public static final Heaft NORMAL+
public static final Heaft BIG+
public static final Heaft MASSIVE+
public static Heaft[] values()+
+for (Heaft c : Heaft.values()) + System.out.println(c); +
public static Heaft valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/Priority.html b/docs/phantom/lang/Priority.html new file mode 100644 index 000000000..0bc120d4c --- /dev/null +++ b/docs/phantom/lang/Priority.html @@ -0,0 +1,416 @@ + + + + + + +public enum Priority +extends Enum<Priority>+
| Enum Constant and Description | +
|---|
HIGH |
+
HIGHEST |
+
LOW |
+
LOWEST |
+
NORMAL |
+
VERY_HIGH |
+
VERY_LOW |
+
| Modifier and Type | +Method and Description | +
|---|---|
static GList<Priority> |
+topDown() |
+
static Priority |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Priority[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Priority LOWEST+
public static final Priority VERY_LOW+
public static final Priority LOW+
public static final Priority NORMAL+
public static final Priority HIGH+
public static final Priority VERY_HIGH+
public static final Priority HIGHEST+
public static Priority[] values()+
+for (Priority c : Priority.values()) + System.out.println(c); +
public static Priority valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/class-use/AccessCallback.html b/docs/phantom/lang/class-use/AccessCallback.html index fb244f20b..7ae11ac5f 100644 --- a/docs/phantom/lang/class-use/AccessCallback.html +++ b/docs/phantom/lang/class-use/AccessCallback.html @@ -2,9 +2,9 @@ - + -Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/class-use/Callback.html b/docs/phantom/lang/class-use/Callback.html index 7e5cdecee..3e78934b5 100644 --- a/docs/phantom/lang/class-use/Callback.html +++ b/docs/phantom/lang/class-use/Callback.html @@ -2,9 +2,9 @@ - + -Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/class-use/GTime.html b/docs/phantom/lang/class-use/GTime.html new file mode 100644 index 000000000..bcbabe04d --- /dev/null +++ b/docs/phantom/lang/class-use/GTime.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/class-use/GTriset.html b/docs/phantom/lang/class-use/GTriset.html index cf33b90a1..a4bdcce29 100644 --- a/docs/phantom/lang/class-use/GTriset.html +++ b/docs/phantom/lang/class-use/GTriset.html @@ -2,9 +2,9 @@ - + -| Package | +Description | +
|---|---|
| phantom.lang | +
+ A collection of glang
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Heaft |
+Heaft.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Heaft[] |
+Heaft.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/class-use/Priority.html b/docs/phantom/lang/class-use/Priority.html new file mode 100644 index 000000000..670888ae3 --- /dev/null +++ b/docs/phantom/lang/class-use/Priority.html @@ -0,0 +1,190 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.lang | +
+ A collection of glang
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Priority |
+Priority.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Priority[] |
+Priority.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static GList<Priority> |
+Priority.topDown() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/lang/format/F.html b/docs/phantom/lang/format/F.html index 64798896a..8957c4fa6 100644 --- a/docs/phantom/lang/format/F.html +++ b/docs/phantom/lang/format/F.html @@ -2,9 +2,9 @@ - + -public class CDou +extends Object+
| Constructor and Description | +
|---|
CDou(double max) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/math/CNum.html b/docs/phantom/math/CNum.html new file mode 100644 index 000000000..3f579f77a --- /dev/null +++ b/docs/phantom/math/CNum.html @@ -0,0 +1,325 @@ + + + + + + +public class CNum +extends Object+
| Constructor and Description | +
|---|
CNum(int max) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/math/DoubleArrayUtils.html b/docs/phantom/math/DoubleArrayUtils.html index 464261f74..30421e270 100644 --- a/docs/phantom/math/DoubleArrayUtils.html +++ b/docs/phantom/math/DoubleArrayUtils.html @@ -2,9 +2,9 @@ - + -public class RayTrace +extends Object+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/math/class-use/Average.html b/docs/phantom/math/class-use/Average.html index 291714de4..2dc096992 100644 --- a/docs/phantom/math/class-use/Average.html +++ b/docs/phantom/math/class-use/Average.html @@ -2,9 +2,9 @@ - + -| Package | +Description | +
|---|---|
| phantom.math | +
+ A collection of math apis
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/math/class-use/CNum.html b/docs/phantom/math/class-use/CNum.html new file mode 100644 index 000000000..1b37ba995 --- /dev/null +++ b/docs/phantom/math/class-use/CNum.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.math | +
+ A collection of math apis
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/math/class-use/DoubleArrayUtils.html b/docs/phantom/math/class-use/DoubleArrayUtils.html index 9b263db54..451a2410e 100644 --- a/docs/phantom/math/class-use/DoubleArrayUtils.html +++ b/docs/phantom/math/class-use/DoubleArrayUtils.html @@ -2,9 +2,9 @@ - + -Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/math/geometry/package-frame.html b/docs/phantom/math/geometry/package-frame.html index e6871cff3..99b89b134 100644 --- a/docs/phantom/math/geometry/package-frame.html +++ b/docs/phantom/math/geometry/package-frame.html @@ -2,9 +2,9 @@ - + -public class VectorMath +extends Object+
| Constructor and Description | +
|---|
VectorMath() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static org.bukkit.util.Vector |
+angleDown(org.bukkit.util.Vector v,
+ float amt)
+Angle the vector in a self relative direction
+ |
+
static org.bukkit.util.Vector |
+angleLeft(org.bukkit.util.Vector v,
+ float amt)
+Angle the vector in a self relative direction
+ |
+
static org.bukkit.util.Vector |
+angleRight(org.bukkit.util.Vector v,
+ float amt)
+Angle the vector in a self relative direction
+ |
+
static org.bukkit.util.Vector |
+angleUp(org.bukkit.util.Vector v,
+ float amt)
+Angle the vector in a self relative direction
+ |
+
static org.bukkit.util.Vector |
+direction(org.bukkit.Location from,
+ org.bukkit.Location to)
+Get a normalized vector going from a location to another
+ |
+
static org.bukkit.block.BlockFace |
+getBlockFace(org.bukkit.util.Vector v)
+Attempt to get the blockFace for the vector (will be tri-normalized)
+ |
+
static double |
+getSpeed(org.bukkit.util.Vector v)
+Get a speed value from a vector (velocity)
+ |
+
static org.bukkit.util.Vector |
+reverse(org.bukkit.util.Vector v)
+Reverse a direction
+ |
+
static GList<org.bukkit.util.Vector> |
+shift(org.bukkit.util.Vector vector,
+ GList<org.bukkit.util.Vector> vectors)
+Shift all vectors based on the given vector
+ |
+
static GList<org.bukkit.block.BlockFace> |
+split(org.bukkit.block.BlockFace f)
+Get all SIMPLE block faces from a more specific block face (SOUTH_EAST) =
+ (south, east)
+ |
+
static org.bukkit.util.Vector |
+toVector(float yaw,
+ float pitch)
+Get the vector direction from the yaw and pitch
+ |
+
static org.bukkit.util.Vector |
+triNormalize(org.bukkit.util.Vector direction)
+(clone) Force normalize the vector into three points, 1, 0, or -1.
+ |
+
public static GList<org.bukkit.block.BlockFace> split(org.bukkit.block.BlockFace f)+
f - the block facepublic static org.bukkit.util.Vector direction(org.bukkit.Location from, + org.bukkit.Location to)+
from - from hereto - to herepublic static org.bukkit.util.Vector toVector(float yaw, + float pitch)+
yaw - the yawpitch - the pitchpublic static org.bukkit.util.Vector reverse(org.bukkit.util.Vector v)+
v - the directionpublic static double getSpeed(org.bukkit.util.Vector v)+
v - the vectorpublic static GList<org.bukkit.util.Vector> shift(org.bukkit.util.Vector vector, + GList<org.bukkit.util.Vector> vectors)+
vector - the vector direction to shift the vectorsvectors - the vectors to be shiftedpublic static org.bukkit.block.BlockFace getBlockFace(org.bukkit.util.Vector v)+
v - the vectorpublic static org.bukkit.util.Vector angleLeft(org.bukkit.util.Vector v, + float amt)+
v - the initial directionamt - the amount to shift in the directionpublic static org.bukkit.util.Vector angleRight(org.bukkit.util.Vector v, + float amt)+
v - the initial directionamt - the amount to shift in the directionpublic static org.bukkit.util.Vector angleUp(org.bukkit.util.Vector v, + float amt)+
v - the initial directionamt - the amount to shift in the directionpublic static org.bukkit.util.Vector angleDown(org.bukkit.util.Vector v, + float amt)+
v - the initial directionamt - the amount to shift in the directionpublic static org.bukkit.util.Vector triNormalize(org.bukkit.util.Vector direction)+
direction - the directionCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/math/physics/class-use/VectorMath.html b/docs/phantom/math/physics/class-use/VectorMath.html new file mode 100644 index 000000000..5ccb0ff03 --- /dev/null +++ b/docs/phantom/math/physics/class-use/VectorMath.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/math/physics/package-frame.html b/docs/phantom/math/physics/package-frame.html index db7c67e9a..c7da56920 100644 --- a/docs/phantom/math/physics/package-frame.html +++ b/docs/phantom/math/physics/package-frame.html @@ -2,14 +2,20 @@ - + -public class Items +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+damage(org.bukkit.inventory.ItemStack is,
+ int amt)
+Damage an itemstack
+ |
+
static short |
+getDurability(org.bukkit.inventory.ItemStack is)
+Get the durability
+ |
+
static double |
+getDurabilityPercent(org.bukkit.inventory.ItemStack is)
+Get the durability percent
+ |
+
static short |
+getMaxDurability(org.bukkit.inventory.ItemStack is)
+Get the max durability
+ |
+
static org.bukkit.inventory.ItemStack |
+getSkull(String uri)
+Load skin into a skull item stack
+ |
+
static boolean |
+hasDurability(org.bukkit.inventory.ItemStack is)
+Does this item have durability
+ |
+
static boolean |
+hasEnchantment(org.bukkit.inventory.ItemStack is,
+ org.bukkit.enchantments.Enchantment e)
+Does the item have the given enchantment
+ |
+
static boolean |
+hasEnchantment(org.bukkit.inventory.ItemStack is,
+ org.bukkit.enchantments.Enchantment e,
+ int level)
+Does the item have the enchantment at the given level
+ |
+
static boolean |
+hasEnchantments(org.bukkit.inventory.ItemStack is)
+Does the item have any enchantments
+ |
+
static boolean |
+hasLore(org.bukkit.inventory.ItemStack is)
+Does the item have any lore?
+ |
+
static boolean |
+hasLore(org.bukkit.inventory.ItemStack is,
+ List<String> lores)
+Does the item have the exact lore
+ |
+
static boolean |
+hasMeta(org.bukkit.inventory.ItemStack is)
+Does the item have meta
+ |
+
static boolean |
+hasName(org.bukkit.inventory.ItemStack is)
+Does the item have a custom name
+ |
+
static boolean |
+hasName(org.bukkit.inventory.ItemStack is,
+ String name)
+Does the item have the given name (color matters)
+ |
+
static boolean |
+is(org.bukkit.inventory.ItemStack is)
+Is the item an item (not null or air)
+ |
+
static boolean |
+is(org.bukkit.inventory.ItemStack is,
+ org.bukkit.Material material)
+Is the item a certain material
+ |
+
static boolean |
+is(org.bukkit.inventory.ItemStack is,
+ MaterialBlock mb)
+Is the item a certain material and metadata
+ |
+
static boolean |
+is(org.bukkit.inventory.ItemStack is,
+ org.bukkit.Material material,
+ byte data)
+Is the item a given material and data
+ |
+
static boolean |
+is(org.bukkit.inventory.ItemStack is,
+ org.bukkit.Material material,
+ int data)
+Is the item a given material and data
+ |
+
static boolean |
+isBroken(org.bukkit.inventory.ItemStack is)
+Should the itemstack be broken?
+ |
+
static boolean |
+isMergable(org.bukkit.inventory.ItemStack a,
+ org.bukkit.inventory.ItemStack b)
+Can the item a be stacked onto the item b (following max stack size)
+ |
+
static void |
+setDurability(org.bukkit.inventory.ItemStack is,
+ int dmg)
+Set the durability (if higher than max, it will be set to the max)
+ |
+
static void |
+setDurability(org.bukkit.inventory.ItemStack is,
+ short dmg)
+Set the durability (if higher than max, it will be set to the max)
+ |
+
static void |
+setDurabilityPercent(org.bukkit.inventory.ItemStack is,
+ double pc)
+Set the durability percent
+ |
+
static MaterialBlock |
+toMaterialBlock(org.bukkit.inventory.ItemStack is)
+Get a materialblock representation of this item
+ |
+
public static boolean is(org.bukkit.inventory.ItemStack is)+
is - the itempublic static boolean is(org.bukkit.inventory.ItemStack is, + org.bukkit.Material material)+
is - the itemmaterial - the materialpublic static boolean is(org.bukkit.inventory.ItemStack is, + MaterialBlock mb)+
is - the itemmb - the materialblockpublic static boolean is(org.bukkit.inventory.ItemStack is, + org.bukkit.Material material, + byte data)+
is - the itemmaterial - the materialdata - the datapublic static org.bukkit.inventory.ItemStack getSkull(String uri) + throws NoSuchFieldException, + SecurityException, + IllegalArgumentException, + IllegalAccessException+
uri - the url, eg:
+ "http://textures.minecraft.net/texture/e58c3ff46ac3fa1a408b24e5b99913cb4c116d8ad7b259186c9fd529464a71c"NoSuchFieldException - bad version (not 1.9.2-4)SecurityException - LET ME DO STUFFIllegalArgumentException - shouldnt happenIllegalAccessException - not goodpublic static boolean is(org.bukkit.inventory.ItemStack is, + org.bukkit.Material material, + int data)+
is - the itemmaterial - the materialdata - the datapublic static boolean hasMeta(org.bukkit.inventory.ItemStack is)+
is - the itempublic static boolean hasName(org.bukkit.inventory.ItemStack is)+
is - the itempublic static boolean hasLore(org.bukkit.inventory.ItemStack is)+
is - the itempublic static boolean hasName(org.bukkit.inventory.ItemStack is, + String name)+
is - the itemname - the namepublic static boolean hasLore(org.bukkit.inventory.ItemStack is, + List<String> lores)+
is - the itemlores - the lorepublic static boolean hasEnchantment(org.bukkit.inventory.ItemStack is, + org.bukkit.enchantments.Enchantment e)+
is - the iteme - the enchantmentpublic static boolean hasEnchantment(org.bukkit.inventory.ItemStack is, + org.bukkit.enchantments.Enchantment e, + int level)+
is - the iteme - the enchantmentlevel - the levelpublic static boolean hasEnchantments(org.bukkit.inventory.ItemStack is)+
is - the itempublic static MaterialBlock toMaterialBlock(org.bukkit.inventory.ItemStack is)+
is - the itempublic static boolean isBroken(org.bukkit.inventory.ItemStack is)+
is - the itemStackpublic static boolean hasDurability(org.bukkit.inventory.ItemStack is)+
is - the itempublic static double getDurabilityPercent(org.bukkit.inventory.ItemStack is)+
is - the itemstackpublic static void setDurabilityPercent(org.bukkit.inventory.ItemStack is, + double pc)+
is - the itemStackpc - the percentpublic static short getMaxDurability(org.bukkit.inventory.ItemStack is)+
is - the itempublic static short getDurability(org.bukkit.inventory.ItemStack is)+
is - the itempublic static void setDurability(org.bukkit.inventory.ItemStack is, + short dmg)+
is - the itemdmg - the durabilitypublic static void setDurability(org.bukkit.inventory.ItemStack is, + int dmg)+
is - the itemdmg - the durabilitypublic static void damage(org.bukkit.inventory.ItemStack is, + int amt)+
is - the itemamt - the amount to damagepublic static boolean isMergable(org.bukkit.inventory.ItemStack a, + org.bukkit.inventory.ItemStack b)+
a - the item ab - the item bCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/stack/class-use/Items.html b/docs/phantom/stack/class-use/Items.html new file mode 100644 index 000000000..dbabf89b8 --- /dev/null +++ b/docs/phantom/stack/class-use/Items.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/stack/package-frame.html b/docs/phantom/stack/package-frame.html new file mode 100644 index 000000000..71800a057 --- /dev/null +++ b/docs/phantom/stack/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| Items | +
+ Itemstack utilities
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/stack/package-tree.html b/docs/phantom/stack/package-tree.html new file mode 100644 index 000000000..403161ea5 --- /dev/null +++ b/docs/phantom/stack/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/stack/package-use.html b/docs/phantom/stack/package-use.html new file mode 100644 index 000000000..8133d57a0 --- /dev/null +++ b/docs/phantom/stack/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/test/IUnitTest.html b/docs/phantom/test/IUnitTest.html index cfb02ef7c..58e5eb174 100644 --- a/docs/phantom/test/IUnitTest.html +++ b/docs/phantom/test/IUnitTest.html @@ -2,9 +2,9 @@ - + -See: Description
+Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/texture/package-tree.html b/docs/phantom/texture/package-tree.html new file mode 100644 index 000000000..641823aa0 --- /dev/null +++ b/docs/phantom/texture/package-tree.html @@ -0,0 +1,129 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/texture/package-use.html b/docs/phantom/texture/package-use.html new file mode 100644 index 000000000..6e3a53d3d --- /dev/null +++ b/docs/phantom/texture/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/array/ARR.html b/docs/phantom/util/array/ARR.html index 8cc4a20c9..27cfdbb6b 100644 --- a/docs/phantom/util/array/ARR.html +++ b/docs/phantom/util/array/ARR.html @@ -2,9 +2,9 @@ - + -public enum Alphabet +extends Enum<Alphabet>+
| Enum Constant and Description | +
|---|
ALPHA
+A
+ |
+
BRAVO
+B
+ |
+
CHARLIE
+C
+ |
+
DELTA
+D
+ |
+
ECHO
+E
+ |
+
FOXTROT
+F
+ |
+
GOLF
+G
+ |
+
HOTEL
+H
+ |
+
INDIA
+I
+ |
+
JULIET
+J
+ |
+
KILO
+K
+ |
+
LIMA
+L
+ |
+
MIKE
+M
+ |
+
NOVEMBER
+N
+ |
+
OSCAR
+O
+ |
+
PAPA
+P
+ |
+
QUEBEC
+Q
+ |
+
ROMEO
+R
+ |
+
SIERRA
+S
+ |
+
TANGO
+T
+ |
+
UNIFORM
+U
+ |
+
VICTOR
+V
+ |
+
WISKEY
+W
+ |
+
XRAY
+X
+ |
+
YANKEE
+Y
+ |
+
ZULU
+Z
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Alphabet |
+fromChar(char c)
+From char to alphabet
+ |
+
static GList<Character> |
+getAlphabet()
+Get the alphabet in a list of chars lowercased
+ |
+
char |
+getChar()
+Get the lower case form of the char
+ |
+
static String |
+radioTalk(String msg)
+ROMEO ALPHA DELTA INDIA OSCAR
+ |
+
static Alphabet |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Alphabet[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Alphabet ALPHA+
public static final Alphabet BRAVO+
public static final Alphabet CHARLIE+
public static final Alphabet DELTA+
public static final Alphabet ECHO+
public static final Alphabet FOXTROT+
public static final Alphabet GOLF+
public static final Alphabet HOTEL+
public static final Alphabet INDIA+
public static final Alphabet JULIET+
public static final Alphabet KILO+
public static final Alphabet LIMA+
public static final Alphabet MIKE+
public static final Alphabet NOVEMBER+
public static final Alphabet OSCAR+
public static final Alphabet PAPA+
public static final Alphabet QUEBEC+
public static final Alphabet ROMEO+
public static final Alphabet SIERRA+
public static final Alphabet TANGO+
public static final Alphabet UNIFORM+
public static final Alphabet VICTOR+
public static final Alphabet WISKEY+
public static final Alphabet XRAY+
public static final Alphabet YANKEE+
public static final Alphabet ZULU+
public static Alphabet[] values()+
+for (Alphabet c : Alphabet.values()) + System.out.println(c); +
public static Alphabet valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic char getChar()+
public static String radioTalk(String msg)+
msg - public static Alphabet fromChar(char c)+
c - the charCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/data/ClassUtil.html b/docs/phantom/util/data/ClassUtil.html index cc715bb42..f245f8500 100644 --- a/docs/phantom/util/data/ClassUtil.html +++ b/docs/phantom/util/data/ClassUtil.html @@ -2,9 +2,9 @@ - + -| Package | +Description | +
|---|---|
| phantom.util.data | +
+ A collection of data utils
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Alphabet |
+Alphabet.fromChar(char c)
+From char to alphabet
+ |
+
static Alphabet |
+Alphabet.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Alphabet[] |
+Alphabet.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/data/class-use/ClassUtil.html b/docs/phantom/util/data/class-use/ClassUtil.html index 12d0a0393..36c41a05c 100644 --- a/docs/phantom/util/data/class-use/ClassUtil.html +++ b/docs/phantom/util/data/class-use/ClassUtil.html @@ -2,9 +2,9 @@ - + -public static class Base64.InputStream +extends FilterInputStream+
Base64.InputStream will read data from another
+ java.io.InputStream, given in the constructor, and encode/decode
+ to/from Base64 notation on the fly.Base64in| Constructor and Description | +
|---|
InputStream(InputStream in)
+Constructs a
+Base64.InputStream in DECODE mode. |
+
InputStream(InputStream in,
+ int options)
+Constructs a
+Base64.InputStream in either ENCODE or DECODE
+ mode. |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+read()
+Reads enough of the input stream to convert to/from Base64 and
+ returns the next byte.
+ |
+
int |
+read(byte[] dest,
+ int off,
+ int len)
+Calls
+read() repeatedly until the end of stream is reached
+ or len bytes are read. |
+
available, close, mark, markSupported, read, reset, skippublic InputStream(InputStream in)+
Base64.InputStream in DECODE mode.in - the java.io.InputStream from which to read data.public InputStream(InputStream in, + int options)+
Base64.InputStream in either ENCODE or DECODE
+ mode.
+ + Valid options: + +
+ ENCODE or DECODE: Encode or Decode as data is read. + DO_BREAK_LINES: break lines at 76 characters + (only meaningful when encoding) ++
+ Example: new Base64.InputStream( in, Base64.DECODE )
in - the java.io.InputStream from which to read data.options - Specified optionsBase64.ENCODE,
+Base64.DECODE,
+Base64.DO_BREAK_LINESpublic int read() + throws IOException+
read in class FilterInputStreamIOExceptionpublic int read(byte[] dest, + int off, + int len) + throws IOException+
read() repeatedly until the end of stream is reached
+ or len bytes are read. Returns number of bytes read into
+ array or -1 if end of stream is encountered.read in class FilterInputStreamdest - array to hold valuesoff - offset for arraylen - max number of bytes to read into arrayIOExceptionCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/files/Base64.OutputStream.html b/docs/phantom/util/files/Base64.OutputStream.html new file mode 100644 index 000000000..820fd069d --- /dev/null +++ b/docs/phantom/util/files/Base64.OutputStream.html @@ -0,0 +1,522 @@ + + + + + + +public static class Base64.OutputStream +extends FilterOutputStream+
Base64.OutputStream will write data to another
+ java.io.OutputStream, given in the constructor, and
+ encode/decode to/from Base64 notation on the fly.Base64out| Constructor and Description | +
|---|
OutputStream(OutputStream out)
+Constructs a
+Base64.OutputStream in ENCODE mode. |
+
OutputStream(OutputStream out,
+ int options)
+Constructs a
+Base64.OutputStream in either ENCODE or DECODE
+ mode. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+close()
+Flushes and closes (I think, in the superclass) the stream.
+ |
+
void |
+flushBase64()
+Method added by PHIL.
+ |
+
void |
+resumeEncoding()
+Resumes encoding of the stream.
+ |
+
void |
+suspendEncoding()
+Suspends encoding of the stream.
+ |
+
void |
+write(byte[] theBytes,
+ int off,
+ int len)
+Calls
+write(int) repeatedly until len bytes are
+ written. |
+
void |
+write(int theByte)
+Writes the byte to the output stream after converting to/from Base64
+ notation.
+ |
+
flush, writepublic OutputStream(OutputStream out)+
Base64.OutputStream in ENCODE mode.out - the java.io.OutputStream to which data will be
+ written.public OutputStream(OutputStream out, + int options)+
Base64.OutputStream in either ENCODE or DECODE
+ mode.
+ + Valid options: + +
+ ENCODE or DECODE: Encode or Decode as data is read. + DO_BREAK_LINES: don't break lines at 76 characters + (only meaningful when encoding) ++
+ Example: new Base64.OutputStream( out, Base64.ENCODE )
out - the java.io.OutputStream to which data will be
+ written.options - Specified options.Base64.ENCODE,
+Base64.DECODE,
+Base64.DO_BREAK_LINESpublic void write(int theByte) + throws IOException+
write in class FilterOutputStreamtheByte - the byte to writeIOExceptionpublic void write(byte[] theBytes, + int off, + int len) + throws IOException+
write(int) repeatedly until len bytes are
+ written.write in class FilterOutputStreamtheBytes - array from which to read bytesoff - offset for arraylen - max number of bytes to read into arrayIOExceptionpublic void flushBase64() + throws IOException+
IOException - if there's an error.public void close() + throws IOException+
close in interface Closeableclose in interface AutoCloseableclose in class FilterOutputStreamIOExceptionpublic void suspendEncoding() + throws IOException+
IOException - if there's an error flushingpublic void resumeEncoding()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/files/Base64.html b/docs/phantom/util/files/Base64.html new file mode 100644 index 000000000..0291c2887 --- /dev/null +++ b/docs/phantom/util/files/Base64.html @@ -0,0 +1,1298 @@ + + + + + + +public class Base64 +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+Base64.InputStream
+A
+Base64.InputStream will read data from another
+ java.io.InputStream, given in the constructor, and encode/decode
+ to/from Base64 notation on the fly. |
+
static class |
+Base64.OutputStream
+A
+Base64.OutputStream will write data to another
+ java.io.OutputStream, given in the constructor, and
+ encode/decode to/from Base64 notation on the fly. |
+
| Modifier and Type | +Field and Description | +
|---|---|
static int |
+DECODE
+Specify decoding in first bit.
+ |
+
static int |
+DO_BREAK_LINES
+Do break lines when encoding.
+ |
+
static int |
+DONT_GUNZIP
+Specify that gzipped data should not be automatically gunzipped.
+ |
+
static int |
+ENCODE
+Specify encoding in first bit.
+ |
+
static int |
+GZIP
+Specify that data should be gzip-compressed in second bit.
+ |
+
static String |
+mx
+Encodes a byte array into Base64 notation.
+ |
+
static int |
+NO_OPTIONS
+No options specified.
+ |
+
static int |
+ORDERED
+Encode using the special "ordered" dialect of Base64 described here:
+ http://www.faqs.org/qa/
+ rfcc-1940.html.
+ |
+
static int |
+URL_SAFE
+Encode using Base64-like encoding that is URL- and Filename-safe as
+ described in Section 4 of RFC3548:
+ http://www.faqs.org/rfcs/
+ rfc3548.html.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static byte[] |
+decode(byte[] source)
+Low-level access to decoding ASCII characters in the form of a byte
+ array.
+ |
+
static byte[] |
+decode(byte[] source,
+ int off,
+ int len,
+ int options)
+Low-level access to decoding ASCII characters in the form of a byte
+ array.
+ |
+
static byte[] |
+decode(String s)
+Decodes data from Base64 notation, automatically detecting
+ gzip-compressed data and decompressing it.
+ |
+
static byte[] |
+decode(String s,
+ int options)
+Decodes data from Base64 notation, automatically detecting
+ gzip-compressed data and decompressing it.
+ |
+
static void |
+decodeFileToFile(String infile,
+ String outfile)
+Reads infile and decodes it to outfile.
+ |
+
static byte[] |
+decodeFromFile(String filename)
+Convenience method for reading a base64-encoded file and decoding it.
+ |
+
static void |
+decodeToFile(String dataToDecode,
+ String filename)
+Convenience method for decoding data to a file.
+ |
+
static Object |
+decodeToObject(String encodedObject)
+Attempts to decode Base64 data and deserialize a Java Object within.
+ |
+
static Object |
+decodeToObject(String encodedObject,
+ int options,
+ ClassLoader loader)
+Attempts to decode Base64 data and deserialize a Java Object within.
+ |
+
static void |
+encode(ByteBuffer raw,
+ ByteBuffer encoded)
+Performs Base64 encoding on the
+raw ByteBuffer, writing it
+ to the encoded ByteBuffer. |
+
static void |
+encode(ByteBuffer raw,
+ CharBuffer encoded)
+Performs Base64 encoding on the
+raw ByteBuffer, writing it
+ to the encoded CharBuffer. |
+
static String |
+encodeBytes(byte[] source) |
+
static String |
+encodeBytes(byte[] source,
+ int options)
+Encodes a byte array into Base64 notation.
+ |
+
static String |
+encodeBytes(byte[] source,
+ int off,
+ int len)
+Encodes a byte array into Base64 notation.
+ |
+
static String |
+encodeBytes(byte[] source,
+ int off,
+ int len,
+ int options)
+Encodes a byte array into Base64 notation.
+ |
+
static byte[] |
+encodeBytesToBytes(byte[] source)
+Similar to
+encodeBytes(byte[]) but returns a byte array instead
+ of instantiating a String. |
+
static byte[] |
+encodeBytesToBytes(byte[] source,
+ int off,
+ int len,
+ int options)
+Similar to
+encodeBytes(byte[], int, int, int) but returns a byte
+ array instead of instantiating a String. |
+
static void |
+encodeFileToFile(String infile,
+ String outfile)
+Reads infile and encodes it to outfile.
+ |
+
static String |
+encodeFromFile(String filename)
+Convenience method for reading a binary file and base64-encoding it.
+ |
+
static String |
+encodeObject(Serializable serializableObject)
+Serializes an object and returns the Base64-encoded version of that
+ serialized object.
+ |
+
static String |
+encodeObject(Serializable serializableObject,
+ int options)
+Serializes an object and returns the Base64-encoded version of that
+ serialized object.
+ |
+
static void |
+encodeToFile(byte[] dataToEncode,
+ String filename)
+Convenience method for encoding data to a file.
+ |
+
static void |
+ex(File df) |
+
static String |
+readFile(String filename) |
+
public static final int NO_OPTIONS+
public static final int ENCODE+
public static final int DECODE+
public static final int GZIP+
public static final int DONT_GUNZIP+
public static final int DO_BREAK_LINES+
public static final int URL_SAFE+
public static final int ORDERED+
public static String mx+
public static void encode(ByteBuffer raw, + ByteBuffer encoded)+
raw ByteBuffer, writing it
+ to the encoded ByteBuffer. This is an experimental feature.
+ Currently it does not pass along any options (such as
+ DO_BREAK_LINES or GZIP.raw - input bufferencoded - output bufferpublic static void encode(ByteBuffer raw, + CharBuffer encoded)+
raw ByteBuffer, writing it
+ to the encoded CharBuffer. This is an experimental feature.
+ Currently it does not pass along any options (such as
+ DO_BREAK_LINES or GZIP.raw - input bufferencoded - output bufferpublic static String encodeObject(Serializable serializableObject) + throws IOException+
+ As of v 2.3, if the object cannot be serialized or there is another + error, the method will throw an java.io.IOException. This is new to + v2.3! In earlier versions, it just returned a null value, but in + retrospect that's a pretty poor way to handle it. +
+ + The object is not GZip-compressed before being encoded.serializableObject - The object to encodeIOException - if there is an errorNullPointerException - if serializedObject is nullpublic static String encodeObject(Serializable serializableObject, + int options) + throws IOException+
+ As of v 2.3, if the object cannot be serialized or there is another + error, the method will throw an java.io.IOException. This is new to + v2.3! In earlier versions, it just returned a null value, but in + retrospect that's a pretty poor way to handle it. +
+ + The object is not GZip-compressed before being encoded. ++ Example options: + +
+ GZIP: gzip-compresses object before encoding it. + DO_BREAK_LINES: break lines at 76 characters ++
+ Example: encodeObject( myObj, Base64.GZIP ) or
+
+ Example:
+ encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES )
serializableObject - The object to encodeoptions - Specified optionsIOException - if there is an errorGZIP,
+DO_BREAK_LINESpublic static String encodeBytes(byte[] source)+
public static String encodeBytes(byte[] source, + int options) + throws IOException+
+ Example options: + +
+ GZIP: gzip-compresses object before encoding it. + DO_BREAK_LINES: break lines at 76 characters + Note: Technically, this makes your encoding non-compliant. ++
+ Example: encodeBytes( myData, Base64.GZIP ) or
+
+ Example:
+ encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )
+
+
+
+ As of v 2.3, if there is an error with the GZIP stream, the method will + throw an java.io.IOException. This is new to v2.3! In earlier + versions, it just returned a null value, but in retrospect that's a + pretty poor way to handle it. +
source - The data to convertoptions - Specified optionsIOException - if there is an errorNullPointerException - if source array is nullGZIP,
+DO_BREAK_LINESpublic static String encodeBytes(byte[] source, + int off, + int len)+
+ As of v 2.3, if there is an error, the method will throw an + java.io.IOException. This is new to v2.3! In earlier versions, it + just returned a null value, but in retrospect that's a pretty poor way to + handle it. +
source - The data to convertoff - Offset in array where conversion should beginlen - Length of data to convertNullPointerException - if source array is nullIllegalArgumentException - if source array, offset, or length are invalidpublic static String encodeBytes(byte[] source, + int off, + int len, + int options) + throws IOException+
+ Example options: + +
+ GZIP: gzip-compresses object before encoding it. + DO_BREAK_LINES: break lines at 76 characters + Note: Technically, this makes your encoding non-compliant. ++
+ Example: encodeBytes( myData, Base64.GZIP ) or
+
+ Example:
+ encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )
+
+
+
+ As of v 2.3, if there is an error with the GZIP stream, the method will + throw an java.io.IOException. This is new to v2.3! In earlier + versions, it just returned a null value, but in retrospect that's a + pretty poor way to handle it. +
source - The data to convertoff - Offset in array where conversion should beginlen - Length of data to convertoptions - Specified optionsIOException - if there is an errorNullPointerException - if source array is nullIllegalArgumentException - if source array, offset, or length are invalidGZIP,
+DO_BREAK_LINESpublic static byte[] encodeBytesToBytes(byte[] source)+
encodeBytes(byte[]) but returns a byte array instead
+ of instantiating a String. This is more efficient if you're working with
+ I/O streams and have large data sets to encode.source - The data to convertNullPointerException - if source array is nullpublic static byte[] encodeBytesToBytes(byte[] source, + int off, + int len, + int options) + throws IOException+
encodeBytes(byte[], int, int, int) but returns a byte
+ array instead of instantiating a String. This is more efficient if you're
+ working with I/O streams and have large data sets to encode.source - The data to convertoff - Offset in array where conversion should beginlen - Length of data to convertoptions - Specified optionsIOException - if there is an errorNullPointerException - if source array is nullIllegalArgumentException - if source array, offset, or length are invalidGZIP,
+DO_BREAK_LINESpublic static byte[] decode(byte[] source) + throws IOException+
source - The Base64 encoded dataIOExceptionpublic static byte[] decode(byte[] source, + int off, + int len, + int options) + throws IOException+
source - The Base64 encoded dataoff - The offset of where to begin decodinglen - The length of characters to decodeoptions - Can specify options such as alphabet type to useIOException - If bogus characters exist in source datapublic static byte[] decode(String s) + throws IOException+
s - the string to decodeIOException - If there is a problempublic static byte[] decode(String s, + int options) + throws IOException+
s - the string to decodeoptions - encode options such as URL_SAFEIOException - if there is an errorNullPointerException - if s is nullpublic static Object decodeToObject(String encodedObject) + throws IOException, + ClassNotFoundException+
encodedObject - The Base64 data to decodeNullPointerException - if encodedObject is nullIOException - if there is a general errorClassNotFoundException - if the decoded object is of a class that cannot be found by
+ the JVMpublic static Object decodeToObject(String encodedObject, + int options, + ClassLoader loader) + throws IOException, + ClassNotFoundException+
encodedObject - The Base64 data to decodeoptions - Various parameters related to decodingloader - Optional class loader to use in deserializing classes.NullPointerException - if encodedObject is nullIOException - if there is a general errorClassNotFoundException - if the decoded object is of a class that cannot be found by
+ the JVMpublic static void encodeToFile(byte[] dataToEncode, + String filename) + throws IOException+
+ As of v 2.3, if there is a error, the method will throw an + java.io.IOException. This is new to v2.3! In earlier versions, it + just returned false, but in retrospect that's a pretty poor way to handle + it. +
dataToEncode - byte array of data to encode in base64 formfilename - Filename for saving encoded dataIOException - if there is an errorNullPointerException - if dataToEncode is nullpublic static void decodeToFile(String dataToDecode, + String filename) + throws IOException+
+ As of v 2.3, if there is a error, the method will throw an + java.io.IOException. This is new to v2.3! In earlier versions, it + just returned false, but in retrospect that's a pretty poor way to handle + it. +
dataToDecode - Base64-encoded data as a stringfilename - Filename for saving decoded dataIOException - if there is an errorpublic static byte[] decodeFromFile(String filename) + throws IOException+
+ As of v 2.3, if there is a error, the method will throw an + java.io.IOException. This is new to v2.3! In earlier versions, it + just returned false, but in retrospect that's a pretty poor way to handle + it. +
filename - Filename for reading encoded dataIOException - if there is an errorpublic static String encodeFromFile(String filename) + throws IOException+
+ As of v 2.3, if there is a error, the method will throw an + java.io.IOException. This is new to v2.3! In earlier versions, it + just returned false, but in retrospect that's a pretty poor way to handle + it. +
filename - Filename for reading binary dataIOException - if there is an errorpublic static void encodeFileToFile(String infile, + String outfile) + throws IOException+
infile - Input fileoutfile - Output fileIOException - if there is an errorpublic static void decodeFileToFile(String infile, + String outfile) + throws IOException+
infile - Input fileoutfile - Output fileIOException - if there is an errorpublic static void ex(File df)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/files/FS.html b/docs/phantom/util/files/FS.html index f813d7d49..da5a9b035 100644 --- a/docs/phantom/util/files/FS.html +++ b/docs/phantom/util/files/FS.html @@ -2,9 +2,9 @@ - + -public class IO +extends Object+
+ This class provides static utility methods for input/output operations. +
+ The byte-to-char methods and char-to-byte methods involve a conversion step. + Two methods are provided in each case, one that uses the platform default + encoding and the other which allows you to specify an encoding. You are + encouraged to always specify an encoding because relying on the platform + default can lead to unexpected results, for example when moving from + development to production. +
+ All the methods in this class that read a stream are buffered internally.
+ This means that there is no cause to use a BufferedInputStream
+ or BufferedReader. The default buffer size of 4K has been shown
+ to be efficient in tests.
+
+ Wherever possible, the methods in this class do not flush or close + the stream. This is to avoid making non-portable assumptions about the + streams' origin and further use. Thus the caller is still responsible for + closing streams after use. +
+ Origin of code: Excalibur.
| Modifier and Type | +Field and Description | +
|---|---|
static char |
+DIR_SEPARATOR
+The system directory separator character.
+ |
+
static char |
+DIR_SEPARATOR_UNIX
+The Unix directory separator character.
+ |
+
static char |
+DIR_SEPARATOR_WINDOWS
+The Windows directory separator character.
+ |
+
static String |
+LINE_SEPARATOR
+The system line separator string.
+ |
+
static String |
+LINE_SEPARATOR_UNIX
+The Unix line separator string.
+ |
+
static String |
+LINE_SEPARATOR_WINDOWS
+The Windows line separator string.
+ |
+
| Constructor and Description | +
|---|
IO()
+Instances should NOT be constructed in standard programming.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+closeQuietly(InputStream input)
+Unconditionally close an
+InputStream. |
+
static void |
+closeQuietly(OutputStream output)
+Unconditionally close an
+OutputStream. |
+
static void |
+closeQuietly(Reader input)
+Unconditionally close an
+Reader. |
+
static void |
+closeQuietly(Writer output)
+Unconditionally close a
+Writer. |
+
static boolean |
+contentEquals(InputStream input1,
+ InputStream input2)
+Compare the contents of two Streams to determine if they are equal or
+ not.
+ |
+
static boolean |
+contentEquals(Reader input1,
+ Reader input2)
+Compare the contents of two Readers to determine if they are equal or
+ not.
+ |
+
static int |
+copy(InputStream input,
+ OutputStream output)
+Copy bytes from an
+InputStream to an
+ OutputStream. |
+
static void |
+copy(InputStream input,
+ Writer output)
+Copy bytes from an
+InputStream to chars on a
+ Writer using the default character encoding of the platform. |
+
static void |
+copy(InputStream input,
+ Writer output,
+ String encoding)
+Copy bytes from an
+InputStream to chars on a
+ Writer using the specified character encoding. |
+
static void |
+copy(Reader input,
+ OutputStream output)
+Copy chars from a
+Reader to bytes on an
+ OutputStream using the default character encoding of the
+ platform, and calling flush. |
+
static void |
+copy(Reader input,
+ OutputStream output,
+ String encoding)
+Copy chars from a
+Reader to bytes on an
+ OutputStream using the specified character encoding, and
+ calling flush. |
+
static int |
+copy(Reader input,
+ Writer output)
+Copy chars from a
+Reader to a Writer. |
+
static long |
+copyLarge(InputStream input,
+ OutputStream output)
+Copy bytes from a large (over 2GB)
+InputStream to an
+ OutputStream. |
+
static long |
+copyLarge(Reader input,
+ Writer output)
+Copy chars from a large (over 2GB)
+Reader to a
+ Writer. |
+
static List<String> |
+readLines(InputStream input)
+Get the contents of an
+InputStream as a list of Strings, one
+ entry per line, using the default character encoding of the platform. |
+
static List<String> |
+readLines(InputStream input,
+ String encoding)
+Get the contents of an
+InputStream as a list of Strings, one
+ entry per line, using the specified character encoding. |
+
static List<String> |
+readLines(Reader input)
+Get the contents of a
+Reader as a list of Strings, one entry
+ per line. |
+
static byte[] |
+toByteArray(InputStream input)
+Get the contents of an
+InputStream as a byte[]. |
+
static byte[] |
+toByteArray(Reader input)
+Get the contents of a
+Reader as a byte[] using
+ the default character encoding of the platform. |
+
static byte[] |
+toByteArray(Reader input,
+ String encoding)
+Get the contents of a
+Reader as a byte[] using
+ the specified character encoding. |
+
static byte[] |
+toByteArray(String input)
+Deprecated.
+
+
+ |
+
static char[] |
+toCharArray(InputStream is)
+Get the contents of an
+InputStream as a character array
+ using the default character encoding of the platform. |
+
static char[] |
+toCharArray(InputStream is,
+ String encoding)
+Get the contents of an
+InputStream as a character array
+ using the specified character encoding. |
+
static char[] |
+toCharArray(Reader input)
+Get the contents of a
+Reader as a character array. |
+
static InputStream |
+toInputStream(String input)
+Convert the specified string to an input stream, encoded as bytes using
+ the default character encoding of the platform.
+ |
+
static InputStream |
+toInputStream(String input,
+ String encoding)
+Convert the specified string to an input stream, encoded as bytes using
+ the specified character encoding.
+ |
+
static String |
+toString(byte[] input)
+Deprecated.
+
+
+ |
+
static String |
+toString(byte[] input,
+ String encoding)
+Deprecated.
+
+
+ |
+
static String |
+toString(InputStream input)
+Get the contents of an
+InputStream as a String using the
+ default character encoding of the platform. |
+
static String |
+toString(InputStream input,
+ String encoding)
+Get the contents of an
+InputStream as a String using the
+ specified character encoding. |
+
static String |
+toString(Reader input)
+Get the contents of a
+Reader as a String. |
+
static void |
+write(byte[] data,
+ OutputStream output)
+Writes bytes from a
+byte[] to an OutputStream. |
+
static void |
+write(byte[] data,
+ Writer output)
+Writes bytes from a
+byte[] to chars on a Writer
+ using the default character encoding of the platform. |
+
static void |
+write(byte[] data,
+ Writer output,
+ String encoding)
+Writes bytes from a
+byte[] to chars on a Writer
+ using the specified character encoding. |
+
static void |
+write(char[] data,
+ OutputStream output)
+Writes chars from a
+char[] to bytes on an
+ OutputStream. |
+
static void |
+write(char[] data,
+ OutputStream output,
+ String encoding)
+Writes chars from a
+char[] to bytes on an
+ OutputStream using the specified character encoding. |
+
static void |
+write(char[] data,
+ Writer output)
+Writes chars from a
+char[] to a Writer using
+ the default character encoding of the platform. |
+
static void |
+write(StringBuffer data,
+ OutputStream output)
+Writes chars from a
+StringBuffer to bytes on an
+ OutputStream using the default character encoding of the
+ platform. |
+
static void |
+write(StringBuffer data,
+ OutputStream output,
+ String encoding)
+Writes chars from a
+StringBuffer to bytes on an
+ OutputStream using the specified character encoding. |
+
static void |
+write(StringBuffer data,
+ Writer output)
+Writes chars from a
+StringBuffer to a Writer. |
+
static void |
+write(String data,
+ OutputStream output)
+Writes chars from a
+String to bytes on an
+ OutputStream using the default character encoding of the
+ platform. |
+
static void |
+write(String data,
+ OutputStream output,
+ String encoding)
+Writes chars from a
+String to bytes on an
+ OutputStream using the specified character encoding. |
+
static void |
+write(String data,
+ Writer output)
+Writes chars from a
+String to a Writer. |
+
static void |
+writeLines(Collection<String> lines,
+ String lineEnding,
+ OutputStream output)
+Writes the
+toString() value of each item in a collection to
+ an OutputStream line by line, using the default character
+ encoding of the platform and the specified line ending. |
+
static void |
+writeLines(Collection<String> lines,
+ String lineEnding,
+ OutputStream output,
+ String encoding)
+Writes the
+toString() value of each item in a collection to
+ an OutputStream line by line, using the specified character
+ encoding and the specified line ending. |
+
static void |
+writeLines(Collection<String> lines,
+ String lineEnding,
+ Writer writer)
+Writes the
+toString() value of each item in a collection to
+ a Writer line by line, using the specified line ending. |
+
public static final char DIR_SEPARATOR_UNIX+
public static final char DIR_SEPARATOR_WINDOWS+
public static final char DIR_SEPARATOR+
public static final String LINE_SEPARATOR_UNIX+
public static final String LINE_SEPARATOR_WINDOWS+
public static final String LINE_SEPARATOR+
public IO()+
public static void closeQuietly(Reader input)+
Reader.
+
+ Equivalent to Reader.close(), except any exceptions will be
+ ignored. This is typically used in finally blocks.
input - the Reader to close, may be null or already closedpublic static void closeQuietly(Writer output)+
Writer.
+
+ Equivalent to Writer.close(), except any exceptions will be
+ ignored. This is typically used in finally blocks.
output - the Writer to close, may be null or already closedpublic static void closeQuietly(InputStream input)+
InputStream.
+
+ Equivalent to InputStream.close(), except any exceptions will be
+ ignored. This is typically used in finally blocks.
input - the InputStream to close, may be null or already closedpublic static void closeQuietly(OutputStream output)+
OutputStream.
+
+ Equivalent to OutputStream.close(), except any exceptions will be
+ ignored. This is typically used in finally blocks.
output - the OutputStream to close, may be null or already closedpublic static byte[] toByteArray(InputStream input) + throws IOException+
InputStream as a byte[].
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
input - the InputStream to read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic static byte[] toByteArray(Reader input) + throws IOException+
Reader as a byte[] using
+ the default character encoding of the platform.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
input - the Reader to read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic static byte[] toByteArray(Reader input, + String encoding) + throws IOException+
Reader as a byte[] using
+ the specified character encoding.
+ + Character encoding names can be found at + IANA. +
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
input - the Reader to read fromencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurs@Deprecated +public static byte[] toByteArray(String input) + throws IOException+
String.getBytes()String as a byte[] using
+ the default character encoding of the platform.
+
+ This is the same as String.getBytes().
input - the String to convertNullPointerException - if the input is nullIOException - if an I/O error occurs (never occurs)public static char[] toCharArray(InputStream is) + throws IOException+
InputStream as a character array
+ using the default character encoding of the platform.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
is - the InputStream to read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic static char[] toCharArray(InputStream is, + String encoding) + throws IOException+
InputStream as a character array
+ using the specified character encoding.
+ + Character encoding names can be found at + IANA. +
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
is - the InputStream to read fromencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurspublic static char[] toCharArray(Reader input) + throws IOException+
Reader as a character array.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
input - the Reader to read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic static String toString(InputStream input) + throws IOException+
InputStream as a String using the
+ default character encoding of the platform.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
input - the InputStream to read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic static String toString(InputStream input, + String encoding) + throws IOException+
InputStream as a String using the
+ specified character encoding.
+ + Character encoding names can be found at + IANA. +
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
input - the InputStream to read fromencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurspublic static String toString(Reader input) + throws IOException+
Reader as a String.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
input - the Reader to read fromNullPointerException - if the input is nullIOException - if an I/O error occurs@Deprecated +public static String toString(byte[] input) + throws IOException+
String.String(byte[])byte[] as a String using the default
+ character encoding of the platform.input - the byte array to read fromNullPointerException - if the input is nullIOException - if an I/O error occurs (never occurs)@Deprecated +public static String toString(byte[] input, + String encoding) + throws IOException+
String.String(byte[],String)byte[] as a String using the specified
+ character encoding.
+ + Character encoding names can be found at + IANA.
input - the byte array to read fromencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurs (never occurs)public static List<String> readLines(InputStream input) + throws IOException+
InputStream as a list of Strings, one
+ entry per line, using the default character encoding of the platform.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
input - the InputStream to read from, not nullNullPointerException - if the input is nullIOException - if an I/O error occurspublic static List<String> readLines(InputStream input, + String encoding) + throws IOException+
InputStream as a list of Strings, one
+ entry per line, using the specified character encoding.
+ + Character encoding names can be found at + IANA. +
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
input - the InputStream to read from, not nullencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurspublic static List<String> readLines(Reader input) + throws IOException+
Reader as a list of Strings, one entry
+ per line.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
input - the Reader to read from, not nullNullPointerException - if the input is nullIOException - if an I/O error occurspublic static InputStream toInputStream(String input)+
input - the string to convertpublic static InputStream toInputStream(String input, + String encoding) + throws IOException+
+ Character encoding names can be found at + IANA.
input - the string to convertencoding - the encoding to use, null means platform defaultIOException - if the encoding is invalidpublic static void write(byte[] data, + OutputStream output) + throws IOException+
byte[] to an OutputStream.data - the byte array to write, do not modify during output, null
+ ignoredoutput - the OutputStream to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(byte[] data, + Writer output) + throws IOException+
byte[] to chars on a Writer
+ using the default character encoding of the platform.
+
+ This method uses String.String(byte[]).
data - the byte array to write, do not modify during output, null
+ ignoredoutput - the Writer to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(byte[] data, + Writer output, + String encoding) + throws IOException+
byte[] to chars on a Writer
+ using the specified character encoding.
+ + Character encoding names can be found at + IANA. +
+ This method uses String.String(byte[], String).
data - the byte array to write, do not modify during output, null
+ ignoredoutput - the Writer to write toencoding - the encoding to use, null means platform defaultNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(char[] data, + Writer output) + throws IOException+
char[] to a Writer using
+ the default character encoding of the platform.data - the char array to write, do not modify during output, null
+ ignoredoutput - the Writer to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(char[] data, + OutputStream output) + throws IOException+
char[] to bytes on an
+ OutputStream.
+
+ This method uses String.String(char[]) and
+ String.getBytes().
data - the char array to write, do not modify during output, null
+ ignoredoutput - the OutputStream to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(char[] data, + OutputStream output, + String encoding) + throws IOException+
char[] to bytes on an
+ OutputStream using the specified character encoding.
+ + Character encoding names can be found at + IANA. +
+ This method uses String.String(char[]) and
+ String.getBytes(String).
data - the char array to write, do not modify during output, null
+ ignoredoutput - the OutputStream to write toencoding - the encoding to use, null means platform defaultNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(String data, + Writer output) + throws IOException+
String to a Writer.data - the String to write, null ignoredoutput - the Writer to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(String data, + OutputStream output) + throws IOException+
String to bytes on an
+ OutputStream using the default character encoding of the
+ platform.
+
+ This method uses String.getBytes().
data - the String to write, null ignoredoutput - the OutputStream to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(String data, + OutputStream output, + String encoding) + throws IOException+
String to bytes on an
+ OutputStream using the specified character encoding.
+ + Character encoding names can be found at + IANA. +
+ This method uses String.getBytes(String).
data - the String to write, null ignoredoutput - the OutputStream to write toencoding - the encoding to use, null means platform defaultNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(StringBuffer data, + Writer output) + throws IOException+
StringBuffer to a Writer.data - the StringBuffer to write, null ignoredoutput - the Writer to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(StringBuffer data, + OutputStream output) + throws IOException+
StringBuffer to bytes on an
+ OutputStream using the default character encoding of the
+ platform.
+
+ This method uses String.getBytes().
data - the StringBuffer to write, null ignoredoutput - the OutputStream to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(StringBuffer data, + OutputStream output, + String encoding) + throws IOException+
StringBuffer to bytes on an
+ OutputStream using the specified character encoding.
+ + Character encoding names can be found at + IANA. +
+ This method uses String.getBytes(String).
data - the StringBuffer to write, null ignoredoutput - the OutputStream to write toencoding - the encoding to use, null means platform defaultNullPointerException - if output is nullIOException - if an I/O error occurspublic static void writeLines(Collection<String> lines, + String lineEnding, + OutputStream output) + throws IOException+
toString() value of each item in a collection to
+ an OutputStream line by line, using the default character
+ encoding of the platform and the specified line ending.lines - the lines to write, null entries produce blank lineslineEnding - the line separator to use, null is system defaultoutput - the OutputStream to write to, not null, not
+ closedNullPointerException - if the output is nullIOException - if an I/O error occurspublic static void writeLines(Collection<String> lines, + String lineEnding, + OutputStream output, + String encoding) + throws IOException+
toString() value of each item in a collection to
+ an OutputStream line by line, using the specified character
+ encoding and the specified line ending.
+ + Character encoding names can be found at + IANA.
lines - the lines to write, null entries produce blank lineslineEnding - the line separator to use, null is system defaultoutput - the OutputStream to write to, not null, not
+ closedencoding - the encoding to use, null means platform defaultNullPointerException - if the output is nullIOException - if an I/O error occurspublic static void writeLines(Collection<String> lines, + String lineEnding, + Writer writer) + throws IOException+
toString() value of each item in a collection to
+ a Writer line by line, using the specified line ending.lines - the lines to write, null entries produce blank lineslineEnding - the line separator to use, null is system defaultwriter - the Writer to write to, not null, not closedNullPointerException - if the input is nullIOException - if an I/O error occurspublic static int copy(InputStream input, + OutputStream output) + throws IOException+
InputStream to an
+ OutputStream.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
+
+ Large streams (over 2GB) will return a bytes copied value of
+ -1 after the copy has completed since the correct number of
+ bytes cannot be returned as an int. For large streams use the
+ copyLarge(InputStream, OutputStream) method.
input - the InputStream to read fromoutput - the OutputStream to write toNullPointerException - if the input or output is nullIOException - if an I/O error occursArithmeticException - if the byte count is too largepublic static long copyLarge(InputStream input, + OutputStream output) + throws IOException+
InputStream to an
+ OutputStream.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
input - the InputStream to read fromoutput - the OutputStream to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static void copy(InputStream input, + Writer output) + throws IOException+
InputStream to chars on a
+ Writer using the default character encoding of the platform.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
+
+ This method uses InputStreamReader.
input - the InputStream to read fromoutput - the Writer to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static void copy(InputStream input, + Writer output, + String encoding) + throws IOException+
InputStream to chars on a
+ Writer using the specified character encoding.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedInputStream.
+
+ Character encoding names can be found at + IANA. +
+ This method uses InputStreamReader.
input - the InputStream to read fromoutput - the Writer to write toencoding - the encoding to use, null means platform defaultNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static int copy(Reader input, + Writer output) + throws IOException+
Reader to a Writer.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
+
+ Large streams (over 2GB) will return a chars copied value of
+ -1 after the copy has completed since the correct number of
+ chars cannot be returned as an int. For large streams use the
+ copyLarge(Reader, Writer) method.
input - the Reader to read fromoutput - the Writer to write toNullPointerException - if the input or output is nullIOException - if an I/O error occursArithmeticException - if the character count is too largepublic static long copyLarge(Reader input, + Writer output) + throws IOException+
Reader to a
+ Writer.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
input - the Reader to read fromoutput - the Writer to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static void copy(Reader input, + OutputStream output) + throws IOException+
Reader to bytes on an
+ OutputStream using the default character encoding of the
+ platform, and calling flush.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
+
+ Due to the implementation of OutputStreamWriter, this method performs a + flush. +
+ This method uses OutputStreamWriter.
input - the Reader to read fromoutput - the OutputStream to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static void copy(Reader input, + OutputStream output, + String encoding) + throws IOException+
Reader to bytes on an
+ OutputStream using the specified character encoding, and
+ calling flush.
+
+ This method buffers the input internally, so there is no need to use a
+ BufferedReader.
+
+ Character encoding names can be found at + IANA. +
+ Due to the implementation of OutputStreamWriter, this method performs a + flush. +
+ This method uses OutputStreamWriter.
input - the Reader to read fromoutput - the OutputStream to write toencoding - the encoding to use, null means platform defaultNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static boolean contentEquals(InputStream input1, + InputStream input2) + throws IOException+
+ This method buffers the input internally using
+ BufferedInputStream if they are not already buffered.
input1 - the first streaminput2 - the second streamNullPointerException - if either input is nullIOException - if an I/O error occurspublic static boolean contentEquals(Reader input1, + Reader input2) + throws IOException+
+ This method buffers the input internally using
+ BufferedReader if they are not already buffered.
input1 - the first readerinput2 - the second readerNullPointerException - if either input is nullIOException - if an I/O error occursCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/files/class-use/Base64.InputStream.html b/docs/phantom/util/files/class-use/Base64.InputStream.html new file mode 100644 index 000000000..961ac56e5 --- /dev/null +++ b/docs/phantom/util/files/class-use/Base64.InputStream.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/files/class-use/Base64.OutputStream.html b/docs/phantom/util/files/class-use/Base64.OutputStream.html new file mode 100644 index 000000000..3df3a8983 --- /dev/null +++ b/docs/phantom/util/files/class-use/Base64.OutputStream.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/files/class-use/Base64.html b/docs/phantom/util/files/class-use/Base64.html new file mode 100644 index 000000000..6b1f9a81b --- /dev/null +++ b/docs/phantom/util/files/class-use/Base64.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/files/class-use/FS.html b/docs/phantom/util/files/class-use/FS.html index b53319461..eb8355bdc 100644 --- a/docs/phantom/util/files/class-use/FS.html +++ b/docs/phantom/util/files/class-use/FS.html @@ -2,9 +2,9 @@ - + -Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/util/files/package-frame.html b/docs/phantom/util/files/package-frame.html index 3804a1265..f742fa980 100644 --- a/docs/phantom/util/files/package-frame.html +++ b/docs/phantom/util/files/package-frame.html @@ -2,9 +2,9 @@ - + -public class ColoredParticleEffect +extends Object +implements VisualEffect+
| Constructor and Description | +
|---|
ColoredParticleEffect(org.bukkit.Color color) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addEffect(VisualEffect e)
+Add a visual effect to this effect.
+ |
+
org.bukkit.Color |
+getColor() |
+
GList<VisualEffect> |
+getEffects()
+Get all effects in this visual effect
+ |
+
boolean |
+isAlpha() |
+
void |
+play(org.bukkit.Location l)
+Play this effect.
+ |
+
void |
+setAlpha(boolean alpha) |
+
void |
+setColor(org.bukkit.Color color) |
+
public ColoredParticleEffect(org.bukkit.Color color)+
public GList<VisualEffect> getEffects()+
VisualEffectgetEffects in interface VisualEffectpublic void play(org.bukkit.Location l)+
VisualEffectplay in interface VisualEffectl - the location to play the effectpublic void addEffect(VisualEffect e)+
VisualEffectaddEffect in interface VisualEffecte - the effectpublic org.bukkit.Color getColor()+
public void setColor(org.bukkit.Color color)+
public boolean isAlpha()+
public void setAlpha(boolean alpha)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/LineParticleManipulator.html b/docs/phantom/vfx/LineParticleManipulator.html new file mode 100644 index 000000000..7e0fa2e49 --- /dev/null +++ b/docs/phantom/vfx/LineParticleManipulator.html @@ -0,0 +1,317 @@ + + + + + + +public abstract class LineParticleManipulator +extends ParticleManipulator+
| Constructor and Description | +
|---|
LineParticleManipulator() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+play(org.bukkit.Location a,
+ org.bukkit.Location b,
+ Double ppb)
+Runs play(Location l) across a line between a and b with ppa particles
+ per block
+ |
+
addEffect, getEffects, playpublic LineParticleManipulator()+
public void play(org.bukkit.Location a, + org.bukkit.Location b, + Double ppb)+
a - the first locationb - the second locationppb - plays per block. Setting this to 1 will play one particle per
+ block. Setting this to 2 will play 2 particles per block (more
+ density on the line)Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.BlockData.html b/docs/phantom/vfx/ParticleEffect.BlockData.html new file mode 100644 index 000000000..e5cd952bb --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.BlockData.html @@ -0,0 +1,281 @@ + + + + + + +public static final class ParticleEffect.BlockData +extends ParticleEffect.ParticleData+
ParticleEffect.BLOCK_CRACK and
+ ParticleEffect.BLOCK_DUST effects
+ + This class is part of the ParticleEffect Library and follows the + same usage conditions
| Constructor and Description | +
|---|
BlockData(org.bukkit.Material material,
+ byte data)
+Construct a new block data
+ |
+
getData, getMaterial, getPacketData, getPacketDataStringpublic BlockData(org.bukkit.Material material, + byte data) + throws IllegalArgumentException+
material - Material of the blockdata - Data value of the blockIllegalArgumentException - If the material is not a blockParticleData#ParticleData(Material, byte)Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.ItemData.html b/docs/phantom/vfx/ParticleEffect.ItemData.html new file mode 100644 index 000000000..66c5b84dd --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.ItemData.html @@ -0,0 +1,277 @@ + + + + + + +public static final class ParticleEffect.ItemData +extends ParticleEffect.ParticleData+
ParticleEffect.ITEM_CRACK effect
+ + This class is part of the ParticleEffect Library and follows the + same usage conditions
| Constructor and Description | +
|---|
ItemData(org.bukkit.Material material,
+ byte data)
+Construct a new item data
+ |
+
getData, getMaterial, getPacketData, getPacketDataStringCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.NoteColor.html b/docs/phantom/vfx/ParticleEffect.NoteColor.html new file mode 100644 index 000000000..91d53f5d3 --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.NoteColor.html @@ -0,0 +1,355 @@ + + + + + + +public static final class ParticleEffect.NoteColor +extends ParticleEffect.ParticleColor+
ParticleEffect.NOTE effect
+ + This class is part of the ParticleEffect Library and follows the + same usage conditions
| Constructor and Description | +
|---|
NoteColor(int note)
+Construct a new note color
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
float |
+getValueX()
+Returns the note value divided by 24
+ |
+
float |
+getValueY()
+Returns zero because the offsetY value is unused
+ |
+
float |
+getValueZ()
+Returns zero because the offsetZ value is unused
+ |
+
public NoteColor(int note) + throws IllegalArgumentException+
note - Note id which determines colorIllegalArgumentException - If the note value is lower than 0 or higher than 24public float getValueX()+
getValueX in class ParticleEffect.ParticleColorpublic float getValueY()+
getValueY in class ParticleEffect.ParticleColorpublic float getValueZ()+
getValueZ in class ParticleEffect.ParticleColorCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.OrdinaryColor.html b/docs/phantom/vfx/ParticleEffect.OrdinaryColor.html new file mode 100644 index 000000000..1ed53db2a --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.OrdinaryColor.html @@ -0,0 +1,441 @@ + + + + + + +public static final class ParticleEffect.OrdinaryColor +extends ParticleEffect.ParticleColor+
ParticleEffect.SPELL_MOB,
+ ParticleEffect.SPELL_MOB_AMBIENT and ParticleEffect.NOTE
+ + This class is part of the ParticleEffect Library and follows the + same usage conditions
| Constructor and Description | +
|---|
OrdinaryColor(org.bukkit.Color color)
+Construct a new ordinary color
+ |
+
OrdinaryColor(int red,
+ int green,
+ int blue)
+Construct a new ordinary color
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getBlue()
+Returns the blue value of the RGB format
+ |
+
int |
+getGreen()
+Returns the green value of the RGB format
+ |
+
int |
+getRed()
+Returns the red value of the RGB format
+ |
+
float |
+getValueX()
+Returns the red value divided by 255
+ |
+
float |
+getValueY()
+Returns the green value divided by 255
+ |
+
float |
+getValueZ()
+Returns the blue value divided by 255
+ |
+
public OrdinaryColor(int red, + int green, + int blue) + throws IllegalArgumentException+
red - Red value of the RGB formatgreen - Green value of the RGB formatblue - Blue value of the RGB formatIllegalArgumentException - If one of the values is lower than 0 or higher than 255public OrdinaryColor(org.bukkit.Color color)+
color - Bukkit colorpublic int getRed()+
public int getGreen()+
public int getBlue()+
public float getValueX()+
getValueX in class ParticleEffect.ParticleColorpublic float getValueY()+
getValueY in class ParticleEffect.ParticleColorpublic float getValueZ()+
getValueZ in class ParticleEffect.ParticleColorCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.ParticleColor.html b/docs/phantom/vfx/ParticleEffect.ParticleColor.html new file mode 100644 index 000000000..eb6a762fe --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.ParticleColor.html @@ -0,0 +1,340 @@ + + + + + + +public abstract static class ParticleEffect.ParticleColor +extends Object+
ParticleEffect.SPELL_MOB,
+ ParticleEffect.SPELL_MOB_AMBIENT, ParticleEffect.REDSTONE
+ and ParticleEffect.NOTE
+ + This class is part of the ParticleEffect Library and follows the + same usage conditions
| Constructor and Description | +
|---|
ParticleColor() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract float |
+getValueX()
+Returns the value for the offsetX field
+ |
+
abstract float |
+getValueY()
+Returns the value for the offsetY field
+ |
+
abstract float |
+getValueZ()
+Returns the value for the offsetZ field
+ |
+
public abstract float getValueX()+
public abstract float getValueY()+
public abstract float getValueZ()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.ParticleData.html b/docs/phantom/vfx/ParticleEffect.ParticleData.html new file mode 100644 index 000000000..4f0065e71 --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.ParticleData.html @@ -0,0 +1,370 @@ + + + + + + +public abstract static class ParticleEffect.ParticleData +extends Object+
ParticleEffect.ITEM_CRACK, ParticleEffect.BLOCK_CRACK and
+ ParticleEffect.BLOCK_DUST
+ + This class is part of the ParticleEffect Library and follows the + same usage conditions
| Constructor and Description | +
|---|
ParticleData(org.bukkit.Material material,
+ byte data)
+Construct a new particle data
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
byte |
+getData()
+Returns the data value of this data
+ |
+
org.bukkit.Material |
+getMaterial()
+Returns the material of this data
+ |
+
int[] |
+getPacketData()
+Returns the data as an int array for packet construction
+ |
+
String |
+getPacketDataString()
+Returns the data as a string for pre 1.8 versions
+ |
+
public ParticleData(org.bukkit.Material material, + byte data)+
material - Material of the item/blockdata - Data value of the item/blockpublic org.bukkit.Material getMaterial()+
public byte getData()+
public int[] getPacketData()+
public String getPacketDataString()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.ParticlePacket.html b/docs/phantom/vfx/ParticleEffect.ParticlePacket.html new file mode 100644 index 000000000..e5b022b19 --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.ParticlePacket.html @@ -0,0 +1,545 @@ + + + + + + +public static final class ParticleEffect.ParticlePacket +extends Object+
+ This class is part of the ParticleEffect Library and follows the + same usage conditions
| Constructor and Description | +
|---|
ParticlePacket(ParticleEffect effect,
+ float offsetX,
+ float offsetY,
+ float offsetZ,
+ float speed,
+ int amount,
+ boolean longDistance,
+ ParticleEffect.ParticleData data)
+Construct a new particle packet
+ |
+
ParticlePacket(ParticleEffect effect,
+ ParticleEffect.ParticleColor color,
+ boolean longDistance)
+Construct a new particle packet of a single colored particle
+ |
+
ParticlePacket(ParticleEffect effect,
+ org.bukkit.util.Vector direction,
+ float speed,
+ boolean longDistance,
+ ParticleEffect.ParticleData data)
+Construct a new particle packet of a single particle flying into a
+ determined direction
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static int |
+getVersion()
+Returns the version of your server (1.x)
+ |
+
static void |
+initialize()
+Initializes
+packetConstructor, getHandle,
+ playerConnection and sendPacket and sets
+ initialized to true if it succeeds |
+
static boolean |
+isInitialized()
+
+ |
+
void |
+sendTo(org.bukkit.Location center,
+ double range)
+Sends the packet to all players in a certain range
+ |
+
void |
+sendTo(org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Sends the packet to all players in the list
+ |
+
void |
+sendTo(org.bukkit.Location center,
+ org.bukkit.entity.Player player)
+Sends the packet to a single player and caches it
+ |
+
public ParticlePacket(ParticleEffect effect, + float offsetX, + float offsetY, + float offsetZ, + float speed, + int amount, + boolean longDistance, + ParticleEffect.ParticleData data) + throws IllegalArgumentException+
effect - Particle effectoffsetX - Maximum distance particles can fly away from the center on
+ the x-axisoffsetY - Maximum distance particles can fly away from the center on
+ the y-axisoffsetZ - Maximum distance particles can fly away from the center on
+ the z-axisspeed - Display speed of the particlesamount - Amount of particleslongDistance - Indicates whether the maximum distance is increased from
+ 256 to 65536data - Data of the effectIllegalArgumentException - If the speed or amount is lower than 0initialize()public ParticlePacket(ParticleEffect effect, + org.bukkit.util.Vector direction, + float speed, + boolean longDistance, + ParticleEffect.ParticleData data) + throws IllegalArgumentException+
effect - Particle effectdirection - Direction of the particlespeed - Display speed of the particlelongDistance - Indicates whether the maximum distance is increased from
+ 256 to 65536data - Data of the effectIllegalArgumentException - If the speed is lower than 0#ParticleEffect(ParticleEffect, float, float, float, float, int,
+ boolean, ParticleData)public ParticlePacket(ParticleEffect effect, + ParticleEffect.ParticleColor color, + boolean longDistance)+
effect - Particle effectcolor - Color of the particlelongDistance - Indicates whether the maximum distance is increased from
+ 256 to 65536#ParticleEffect(ParticleEffect, float, float, float, float, int,
+ boolean, ParticleData)public static void initialize() + throws phantom.vfx.ParticleEffect.ParticlePacket.VersionIncompatibleException+
packetConstructor, getHandle,
+ playerConnection and sendPacket and sets
+ initialized to true if it succeeds
+
+ Note: These fields only have to be initialized once, so it
+ will return if initialized is already set to
+ true
VersionIncompatibleException - if your bukkit version is not supported by this libraryphantom.vfx.ParticleEffect.ParticlePacket.VersionIncompatibleExceptionpublic static int getVersion()+
public static boolean isInitialized()+ +
initialize()public void sendTo(org.bukkit.Location center, + org.bukkit.entity.Player player) + throws phantom.vfx.ParticleEffect.ParticlePacket.PacketInstantiationException, + phantom.vfx.ParticleEffect.ParticlePacket.PacketSendingException+
center - Center location of the effectplayer - Receiver of the packetPacketInstantiationException - If instantion fails due to an unknown errorPacketSendingException - If sending fails due to an unknown errorphantom.vfx.ParticleEffect.ParticlePacket.PacketInstantiationExceptionphantom.vfx.ParticleEffect.ParticlePacket.PacketSendingExceptioninitializePacket(Location)public void sendTo(org.bukkit.Location center, + List<org.bukkit.entity.Player> players) + throws IllegalArgumentException+
center - Center location of the effectplayers - Receivers of the packetIllegalArgumentException - If the player list is emptysendTo(Location center, Player player)public void sendTo(org.bukkit.Location center, + double range) + throws IllegalArgumentException+
center - Center location of the effectrange - Range in which players will receive the packet (Maximum
+ range for particles is usually 16, but it can differ for
+ some types)IllegalArgumentException - If the range is lower than 1sendTo(Location center, Player player)Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.ParticleProperty.html b/docs/phantom/vfx/ParticleEffect.ParticleProperty.html new file mode 100644 index 000000000..f246a6683 --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.ParticleProperty.html @@ -0,0 +1,393 @@ + + + + + + +public static enum ParticleEffect.ParticleProperty +extends Enum<ParticleEffect.ParticleProperty>+
+ This class is part of the ParticleEffect Library and follows the + same usage conditions
| Enum Constant and Description | +
|---|
COLORABLE
+The particle effect uses the offsets as color values
+ |
+
DIRECTIONAL
+The particle effect uses the offsets as direction values
+ |
+
REQUIRES_DATA
+The particle effect requires block or item data to be displayed
+ |
+
REQUIRES_WATER
+The particle effect requires water to be displayed
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ParticleEffect.ParticleProperty |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ParticleEffect.ParticleProperty[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ParticleEffect.ParticleProperty REQUIRES_WATER+
public static final ParticleEffect.ParticleProperty REQUIRES_DATA+
public static final ParticleEffect.ParticleProperty DIRECTIONAL+
public static final ParticleEffect.ParticleProperty COLORABLE+
public static ParticleEffect.ParticleProperty[] values()+
+for (ParticleEffect.ParticleProperty c : ParticleEffect.ParticleProperty.values()) + System.out.println(c); +
public static ParticleEffect.ParticleProperty valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleEffect.html b/docs/phantom/vfx/ParticleEffect.html new file mode 100644 index 000000000..12d4c785d --- /dev/null +++ b/docs/phantom/vfx/ParticleEffect.html @@ -0,0 +1,2383 @@ + + + + + + +public enum ParticleEffect +extends Enum<ParticleEffect>+
+ This library was created by @DarkBlade12 and allows you to display all + Minecraft particle effects on a Bukkit server +
+ You are welcome to use it, modify it and redistribute it under the following + conditions: +
+ Special thanks: +
+ It would be nice if you provide credit to me if you use this class in a + published project
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+ParticleEffect.BlockData
+Represents the block data for the
+BLOCK_CRACK and
+ BLOCK_DUST effects |
+
static class |
+ParticleEffect.ItemData
+Represents the item data for the
+ITEM_CRACK effect |
+
static class |
+ParticleEffect.NoteColor
+Represents the color for the
+NOTE effect |
+
static class |
+ParticleEffect.OrdinaryColor
+
+ |
+
static class |
+ParticleEffect.ParticleColor
+
+ |
+
static class |
+ParticleEffect.ParticleData
+
+ |
+
static class |
+ParticleEffect.ParticlePacket
+Represents a particle effect packet with all attributes which is used for
+ sending packets to the players
+ |
+
static class |
+ParticleEffect.ParticleProperty
+Represents the property of a particle effect
+ |
+
| Enum Constant and Description | +
|---|
BARRIER
+A particle effect which is displayed by barriers:
+
+ It looks like a red box with a slash through it
+ The speed value has no influence on this particle effect
+
+ |
+
BLOCK_CRACK
+A particle effect which is displayed when breaking blocks or sprinting:
+
+ It looks like a little piece with a block texture
+ The speed value has no influence on this particle effect
+
+ |
+
BLOCK_DUST
+A particle effect which is displayed when falling:
+
+ It looks like a little piece with a block texture
+
+ |
+
CLOUD
+A particle effect which is displayed when a mob dies:
+
+ It looks like a large white cloud
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
CRIT
+A particle effect which is displayed when landing a critical hit and by
+ arrows:
+
+ It looks like a light brown cross
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
CRIT_MAGIC
+A particle effect which is displayed when landing a hit with an enchanted
+ weapon:
+
+ It looks like a cyan star
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
DAMAGE_INDICATOR
+A damage indicator particle effect
+ |
+
DRAGON_BREATH
+A particle effect which is displayed by enderdragons
+ |
+
DRIP_LAVA
+A particle effect which is displayed by blocks beneath a lava source:
+
+ It looks like an orange drip
+ The speed value has no influence on this particle effect
+
+ |
+
DRIP_WATER
+A particle effect which is displayed by blocks beneath a water source:
+
+ It looks like a blue drip
+ The speed value has no influence on this particle effect
+
+ |
+
ENCHANTMENT_TABLE
+A particle effect which is displayed by enchantment tables which are
+ nearby bookshelves:
+
+ It looks like a cryptic white letter
+ The speed value influences the spread of this particle effect
+
+ |
+
END_ROD
+The end rod particle effect from end rods
+ |
+
EXPLOSION_HUGE
+A particle effect which is displayed by exploding tnt and creepers:
+
+ It looks like a crowd of gray balls which are fading away
+ The speed value has no influence on this particle effect
+
+ |
+
EXPLOSION_LARGE
+A particle effect which is displayed by exploding ghast fireballs and
+ wither skulls:
+
+ It looks like a gray ball which is fading away
+ The speed value slightly influences the size of this particle effect
+
+ |
+
EXPLOSION_NORMAL
+A particle effect which is displayed by exploding tnt and creepers:
+
+ It looks like a white cloud
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
FIREWORKS_SPARK
+A particle effect which is displayed by launching fireworks:
+
+ It looks like a white star which is sparkling
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
FLAME
+A particle effect which is displayed by torches, active furnaces, magma
+ cubes and monster spawners:
+
+ It looks like a tiny flame
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
FOOTSTEP
+A particle effect which is currently unused:
+
+ It looks like a transparent gray square
+ The speed value has no influence on this particle effect
+
+ |
+
HEART
+A particle effect which is displayed when breeding and taming animals:
+
+ It looks like a red heart
+ The speed value has no influence on this particle effect
+
+ |
+
ITEM_CRACK
+A particle effect which is displayed when breaking a tool or eggs hit a
+ block:
+
+ It looks like a little piece with an item texture
+
+ |
+
ITEM_TAKE
+A particle effect which is currently unused:
+
+ It has no visual effect
+
+ |
+
LAVA
+A particle effect which is displayed by lava:
+
+ It looks like a spark
+ The speed value has no influence on this particle effect
+
+ |
+
MOB_APPEARANCE
+A particle effect which is displayed by elder guardians:
+
+ It looks like the shape of the elder guardian
+ The speed value has no influence on this particle effect
+ The offset values have no influence on this particle effect
+
+ |
+
NOTE
+A particle effect which is displayed by note blocks:
+
+ It looks like a colored note
+ The speed value causes the particle to be colored green when set to 0
+
+ |
+
PORTAL
+A particle effect which is displayed by nether portals, endermen, ender
+ pearls, eyes of ender, ender chests and dragon eggs:
+
+ It looks like a purple cloud
+ The speed value influences the spread of this particle effect
+
+ |
+
REDSTONE
+A particle effect which is displayed by redstone ore, powered redstone,
+ redstone torches and redstone repeaters:
+
+ It looks like a tiny colored cloud
+ The speed value causes the particle to be colored red when set to 0
+
+ |
+
SLIME
+A particle effect which is displayed by slimes:
+
+ It looks like a tiny part of the slimeball icon
+ The speed value has no influence on this particle effect
+
+ |
+
SMOKE_LARGE
+A particle effect which is displayed by fire, minecarts with furnace and
+ blazes:
+
+ It looks like a large gray cloud
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
SMOKE_NORMAL
+A particle effect which is displayed by primed tnt, torches, droppers,
+ dispensers, end portals, brewing stands and monster spawners:
+
+ It looks like a little gray cloud
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
SNOW_SHOVEL
+A particle effect which is currently unused:
+
+ It looks like a tiny white cloud
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
SNOWBALL
+A particle effect which is displayed when snowballs hit a block:
+
+ It looks like a little piece with the snowball texture
+ The speed value has no influence on this particle effect
+
+ |
+
SPELL
+A particle effect which is displayed when splash potions or bottles o'
+ enchanting hit something:
+
+ It looks like a white swirl
+ The speed value causes the particle to only move upwards when set to
+ 0
+ Only the motion on the y-axis can be controlled, the motion on the x-
+ and z-axis are multiplied by 0.1 when setting the values to 0
+
+ |
+
SPELL_INSTANT
+A particle effect which is displayed when instant splash potions hit
+ something:
+
+ It looks like a white cross
+ The speed value causes the particle to only move upwards when set to
+ 0
+ Only the motion on the y-axis can be controlled, the motion on the x-
+ and z-axis are multiplied by 0.1 when setting the values to 0
+
+ |
+
SPELL_MOB
+A particle effect which is displayed by entities with active potion
+ effects:
+
+ It looks like a colored swirl
+ The speed value causes the particle to be colored black when set to 0
+ The particle color gets lighter when increasing the speed and darker
+ when decreasing the speed
+
+ |
+
SPELL_MOB_AMBIENT
+A particle effect which is displayed by entities with active potion
+ effects applied through a beacon:
+
+ It looks like a transparent colored swirl
+ The speed value causes the particle to be always colored black when
+ set to 0
+ The particle color gets lighter when increasing the speed and darker
+ when decreasing the speed
+
+ |
+
SPELL_WITCH
+A particle effect which is displayed by witches:
+
+ It looks like a purple cross
+ The speed value causes the particle to only move upwards when set to
+ 0
+ Only the motion on the y-axis can be controlled, the motion on the x-
+ and z-axis are multiplied by 0.1 when setting the values to 0
+
+ |
+
SUSPENDED
+A particle effect which is displayed by water:
+
+ It looks like a tiny blue square
+ The speed value has no influence on this particle effect
+
+ |
+
SUSPENDED_DEPTH
+A particle effect which is displayed by air when close to bedrock and the
+ in the void:
+
+ It looks like a tiny gray square
+ The speed value has no influence on this particle effect
+
+ |
+
SWEEP_ATTACK
+A swipe sword effect
+ |
+
TOWN_AURA
+A particle effect which is displayed by mycelium:
+
+ It looks like a tiny gray square
+ The speed value has no influence on this particle effect
+
+ |
+
VILLAGER_ANGRY
+A particle effect which is displayed when attacking a villager in a
+ village:
+
+ It looks like a cracked gray heart
+ The speed value has no influence on this particle effect
+
+ |
+
VILLAGER_HAPPY
+A particle effect which is displayed when using bone meal and trading
+ with a villager in a village:
+
+ It looks like a green star
+ The speed value has no influence on this particle effect
+
+ |
+
WATER_BUBBLE
+A particle effect which is displayed by swimming entities and arrows in
+ water:
+
+ It looks like a bubble
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
WATER_DROP
+A particle effect which is displayed when rain hits the ground:
+
+ It looks like a blue droplet
+ The speed value has no influence on this particle effect
+
+ |
+
WATER_SPLASH
+A particle effect which is displayed by swimming entities and shaking
+ wolves:
+
+ It looks like a blue drop
+ The speed value has no influence on this particle effect
+
+ |
+
WATER_WAKE
+A particle effect which is displayed on water when fishing:
+
+ It looks like a blue droplet
+ The speed value influences the velocity at which the particle flies
+ off
+
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+display(float speed,
+ int amount,
+ org.bukkit.Location center,
+ double range)
+Displays a particle effect which is only visible for all players within a
+ certain range in the world of @param center
+ |
+
void |
+display(float speed,
+ int amount,
+ org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Displays a particle effect which is only visible for the specified
+ players
+ |
+
void |
+display(float speed,
+ int amount,
+ org.bukkit.Location center,
+ org.bukkit.entity.Player... players)
+Displays a particle effect which is only visible for the specified
+ players
+ |
+
void |
+display(ParticleEffect.ParticleColor color,
+ org.bukkit.Location center,
+ double range)
+Displays a single particle which is colored and only visible for all
+ players within a certain range in the world of @param center
+ |
+
void |
+display(ParticleEffect.ParticleColor color,
+ org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Displays a single particle which is colored and only visible for the
+ specified players
+ |
+
void |
+display(ParticleEffect.ParticleColor color,
+ org.bukkit.Location center,
+ org.bukkit.entity.Player... players)
+Displays a single particle which is colored and only visible for the
+ specified players
+ |
+
void |
+display(ParticleEffect.ParticleData data,
+ float speed,
+ int amount,
+ org.bukkit.Location center,
+ double range)
+Displays a particle effect which requires additional data and is only
+ visible for all players within a certain range in the world of @param
+ center
+ |
+
void |
+display(ParticleEffect.ParticleData data,
+ float speed,
+ int amount,
+ org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Displays a particle effect which requires additional data and is only
+ visible for the specified players
+ |
+
void |
+display(ParticleEffect.ParticleData data,
+ float speed,
+ int amount,
+ org.bukkit.Location center,
+ org.bukkit.entity.Player... players)
+Displays a particle effect which requires additional data and is only
+ visible for the specified players
+ |
+
void |
+display(ParticleEffect.ParticleData data,
+ org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ double range)
+Displays a single particle which requires additional data that flies into
+ a determined direction and is only visible for all players within a
+ certain range in the world of @param center
+ |
+
void |
+display(ParticleEffect.ParticleData data,
+ org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Displays a single particle which requires additional data that flies into
+ a determined direction and is only visible for the specified players
+ |
+
void |
+display(ParticleEffect.ParticleData data,
+ org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ org.bukkit.entity.Player... players)
+Displays a single particle which requires additional data that flies into
+ a determined direction and is only visible for the specified players
+ |
+
void |
+display(org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ double range)
+Displays a single particle which flies into a determined direction and is
+ only visible for all players within a certain range in the world
+ of @param center
+ |
+
void |
+display(org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Displays a single particle which flies into a determined direction and is
+ only visible for the specified players
+ |
+
void |
+display(org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ org.bukkit.entity.Player... players)
+Displays a single particle which flies into a determined direction and is
+ only visible for the specified players
+ |
+
static ParticleEffect |
+fromId(int id)
+Returns the particle effect with the given id
+ |
+
static ParticleEffect |
+fromName(String name)
+Returns the particle effect with the given name
+ |
+
int |
+getId()
+Returns the id of this particle effect
+ |
+
String |
+getName()
+Returns the name of this particle effect
+ |
+
int |
+getRequiredVersion()
+Returns the required version for this particle effect (1.x)
+ |
+
boolean |
+hasProperty(ParticleEffect.ParticleProperty property)
+Determine if this particle effect has a specific property
+ |
+
boolean |
+isSupported()
+Determine if this particle effect is supported by your current server
+ version
+ |
+
static void |
+phantom(org.bukkit.Location l,
+ int intervals) |
+
static ParticleEffect |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ParticleEffect[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ParticleEffect EXPLOSION_NORMAL+
public static final ParticleEffect EXPLOSION_LARGE+
public static final ParticleEffect EXPLOSION_HUGE+
public static final ParticleEffect FIREWORKS_SPARK+
public static final ParticleEffect WATER_BUBBLE+
public static final ParticleEffect WATER_SPLASH+
public static final ParticleEffect WATER_WAKE+
public static final ParticleEffect SUSPENDED+
public static final ParticleEffect SUSPENDED_DEPTH+
public static final ParticleEffect CRIT+
public static final ParticleEffect CRIT_MAGIC+
public static final ParticleEffect SMOKE_NORMAL+
public static final ParticleEffect SMOKE_LARGE+
public static final ParticleEffect SPELL+
public static final ParticleEffect SPELL_INSTANT+
public static final ParticleEffect SPELL_MOB+
public static final ParticleEffect SPELL_MOB_AMBIENT+
public static final ParticleEffect SPELL_WITCH+
public static final ParticleEffect DRIP_WATER+
public static final ParticleEffect DRIP_LAVA+
public static final ParticleEffect VILLAGER_ANGRY+
public static final ParticleEffect VILLAGER_HAPPY+
public static final ParticleEffect TOWN_AURA+
public static final ParticleEffect NOTE+
public static final ParticleEffect PORTAL+
public static final ParticleEffect ENCHANTMENT_TABLE+
public static final ParticleEffect FLAME+
public static final ParticleEffect LAVA+
public static final ParticleEffect FOOTSTEP+
public static final ParticleEffect CLOUD+
public static final ParticleEffect REDSTONE+
public static final ParticleEffect SNOWBALL+
public static final ParticleEffect SNOW_SHOVEL+
public static final ParticleEffect SLIME+
public static final ParticleEffect HEART+
public static final ParticleEffect BARRIER+
public static final ParticleEffect ITEM_CRACK+
public static final ParticleEffect BLOCK_CRACK+
public static final ParticleEffect BLOCK_DUST+
public static final ParticleEffect WATER_DROP+
public static final ParticleEffect ITEM_TAKE+
public static final ParticleEffect MOB_APPEARANCE+
public static final ParticleEffect DRAGON_BREATH+
public static final ParticleEffect END_ROD+
public static final ParticleEffect DAMAGE_INDICATOR+
public static final ParticleEffect SWEEP_ATTACK+
public static ParticleEffect[] values()+
+for (ParticleEffect c : ParticleEffect.values()) + System.out.println(c); +
public static ParticleEffect valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String getName()+
public int getId()+
public int getRequiredVersion()+
public boolean hasProperty(ParticleEffect.ParticleProperty property)+
public boolean isSupported()+
public static ParticleEffect fromName(String name)+
name - Name of the particle effectpublic static ParticleEffect fromId(int id)+
id - Id of the particle effectpublic void display(float speed, + int amount, + org.bukkit.Location center, + double range) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException, + IllegalArgumentException+
offsetX - Maximum distance particles can fly away from the center on the
+ x-axisoffsetY - Maximum distance particles can fly away from the center on the
+ y-axisoffsetZ - Maximum distance particles can fly away from the center on the
+ z-axisspeed - Display speed of the particlesamount - Amount of particlescenter - Center location of the effectrange - Range of the visibilityParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect requires additional dataIllegalArgumentException - If the particle effect requires water and none is at the
+ center locationphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptionParticleEffect.ParticlePacket,
+ParticleEffect.ParticlePacket.sendTo(Location, double)public void display(float speed, + int amount, + org.bukkit.Location center, + List<org.bukkit.entity.Player> players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException, + IllegalArgumentException+
offsetX - Maximum distance particles can fly away from the center on the
+ x-axisoffsetY - Maximum distance particles can fly away from the center on the
+ y-axisoffsetZ - Maximum distance particles can fly away from the center on the
+ z-axisspeed - Display speed of the particlesamount - Amount of particlescenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect requires additional dataIllegalArgumentException - If the particle effect requires water and none is at the
+ center locationphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptionParticleEffect.ParticlePacket,
+ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(float speed, + int amount, + org.bukkit.Location center, + org.bukkit.entity.Player... players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException, + IllegalArgumentException+
offsetX - Maximum distance particles can fly away from the center on the
+ x-axisoffsetY - Maximum distance particles can fly away from the center on the
+ y-axisoffsetZ - Maximum distance particles can fly away from the center on the
+ z-axisspeed - Display speed of the particlesamount - Amount of particlescenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect requires additional dataIllegalArgumentException - If the particle effect requires water and none is at the
+ center locationphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataException#display(float, float, float, float, int, Location, List)public void display(org.bukkit.util.Vector direction, + float speed, + org.bukkit.Location center, + double range) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException, + IllegalArgumentException+
direction - Direction of the particlespeed - Display speed of the particlecenter - Center location of the effectrange - Range of the visibilityParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect requires additional dataIllegalArgumentException - If the particle effect is not directional or if it requires
+ water and none is at the center locationphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptionParticlePacket#ParticlePacket(ParticleEffect, Vector, float,
+ boolean, ParticleData),
+ParticleEffect.ParticlePacket.sendTo(Location, double)public void display(org.bukkit.util.Vector direction, + float speed, + org.bukkit.Location center, + List<org.bukkit.entity.Player> players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException, + IllegalArgumentException+
direction - Direction of the particlespeed - Display speed of the particlecenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect requires additional dataIllegalArgumentException - If the particle effect is not directional or if it requires
+ water and none is at the center locationphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptionParticlePacket#ParticlePacket(ParticleEffect, Vector, float,
+ boolean, ParticleData),
+ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(org.bukkit.util.Vector direction, + float speed, + org.bukkit.Location center, + org.bukkit.entity.Player... players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException, + IllegalArgumentException+
direction - Direction of the particlespeed - Display speed of the particlecenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect requires additional dataIllegalArgumentException - If the particle effect is not directional or if it requires
+ water and none is at the center locationphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptiondisplay(Vector, float, Location, List)public void display(ParticleEffect.ParticleColor color, + org.bukkit.Location center, + double range) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleColorException+
color - Color of the particlecenter - Center location of the effectrange - Range of the visibilityParticleVersionException - If the particle effect is not supported by the server versionParticleColorException - If the particle effect is not colorable or the color type is
+ incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleColorExceptionParticlePacket#ParticlePacket(ParticleEffect, ParticleColor,
+ boolean),
+ParticleEffect.ParticlePacket.sendTo(Location, double)public void display(ParticleEffect.ParticleColor color, + org.bukkit.Location center, + List<org.bukkit.entity.Player> players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleColorException+
color - Color of the particlecenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleColorException - If the particle effect is not colorable or the color type is
+ incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleColorExceptionParticlePacket#ParticlePacket(ParticleEffect, ParticleColor,
+ boolean),
+ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(ParticleEffect.ParticleColor color, + org.bukkit.Location center, + org.bukkit.entity.Player... players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleColorException+
color - Color of the particlecenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleColorException - If the particle effect is not colorable or the color type is
+ incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleColorExceptiondisplay(ParticleColor, Location, List)public void display(ParticleEffect.ParticleData data, + float speed, + int amount, + org.bukkit.Location center, + double range) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException+
data - Data of the effectoffsetX - Maximum distance particles can fly away from the center on the
+ x-axisoffsetY - Maximum distance particles can fly away from the center on the
+ y-axisoffsetZ - Maximum distance particles can fly away from the center on the
+ z-axisspeed - Display speed of the particlesamount - Amount of particlescenter - Center location of the effectrange - Range of the visibilityParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect does not require additional data or if
+ the data type is incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptionParticleEffect.ParticlePacket,
+ParticleEffect.ParticlePacket.sendTo(Location, double)public void display(ParticleEffect.ParticleData data, + float speed, + int amount, + org.bukkit.Location center, + List<org.bukkit.entity.Player> players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException+
data - Data of the effectoffsetX - Maximum distance particles can fly away from the center on the
+ x-axisoffsetY - Maximum distance particles can fly away from the center on the
+ y-axisoffsetZ - Maximum distance particles can fly away from the center on the
+ z-axisspeed - Display speed of the particlesamount - Amount of particlescenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect does not require additional data or if
+ the data type is incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptionParticleEffect.ParticlePacket,
+ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(ParticleEffect.ParticleData data, + float speed, + int amount, + org.bukkit.Location center, + org.bukkit.entity.Player... players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException+
data - Data of the effectoffsetX - Maximum distance particles can fly away from the center on the
+ x-axisoffsetY - Maximum distance particles can fly away from the center on the
+ y-axisoffsetZ - Maximum distance particles can fly away from the center on the
+ z-axisspeed - Display speed of the particlesamount - Amount of particlescenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect does not require additional data or if
+ the data type is incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataException#display(ParticleData, float, float, float, float, int, Location,
+ List)public void display(ParticleEffect.ParticleData data, + org.bukkit.util.Vector direction, + float speed, + org.bukkit.Location center, + double range) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException+
data - Data of the effectdirection - Direction of the particlespeed - Display speed of the particlescenter - Center location of the effectrange - Range of the visibilityParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect does not require additional data or if
+ the data type is incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptionParticleEffect.ParticlePacket,
+ParticleEffect.ParticlePacket.sendTo(Location, double)public void display(ParticleEffect.ParticleData data, + org.bukkit.util.Vector direction, + float speed, + org.bukkit.Location center, + List<org.bukkit.entity.Player> players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException+
data - Data of the effectdirection - Direction of the particlespeed - Display speed of the particlescenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect does not require additional data or if
+ the data type is incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptionParticleEffect.ParticlePacket,
+ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(ParticleEffect.ParticleData data, + org.bukkit.util.Vector direction, + float speed, + org.bukkit.Location center, + org.bukkit.entity.Player... players) + throws phantom.vfx.ParticleEffect.ParticleVersionException, + phantom.vfx.ParticleEffect.ParticleDataException+
data - Data of the effectdirection - Direction of the particlespeed - Display speed of the particlescenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleDataException - If the particle effect does not require additional data or if
+ the data type is incorrectphantom.vfx.ParticleEffect.ParticleVersionExceptionphantom.vfx.ParticleEffect.ParticleDataExceptiondisplay(ParticleData, Vector, float, Location, List)public static void phantom(org.bukkit.Location l, + int intervals)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ParticleManipulator.html b/docs/phantom/vfx/ParticleManipulator.html new file mode 100644 index 000000000..129386e93 --- /dev/null +++ b/docs/phantom/vfx/ParticleManipulator.html @@ -0,0 +1,264 @@ + + + + + + +public abstract class ParticleManipulator +extends PhantomEffect+
| Constructor and Description | +
|---|
ParticleManipulator() |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/PhantomEffect.html b/docs/phantom/vfx/PhantomEffect.html new file mode 100644 index 000000000..f4c377fd4 --- /dev/null +++ b/docs/phantom/vfx/PhantomEffect.html @@ -0,0 +1,345 @@ + + + + + + +public abstract class PhantomEffect +extends Object +implements VisualEffect+
| Constructor and Description | +
|---|
PhantomEffect() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addEffect(VisualEffect e)
+Add a visual effect to this effect.
+ |
+
GList<VisualEffect> |
+getEffects()
+Get all effects in this visual effect
+ |
+
abstract void |
+play(org.bukkit.Location l)
+Play this effect.
+ |
+
public GList<VisualEffect> getEffects()+
VisualEffectgetEffects in interface VisualEffectpublic abstract void play(org.bukkit.Location l)+
VisualEffectplay in interface VisualEffectl - the location to play the effectpublic void addEffect(VisualEffect e)+
VisualEffectaddEffect in interface VisualEffecte - the effectCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ReflectionUtils.DataType.html b/docs/phantom/vfx/ReflectionUtils.DataType.html new file mode 100644 index 000000000..bb4b1b68c --- /dev/null +++ b/docs/phantom/vfx/ReflectionUtils.DataType.html @@ -0,0 +1,652 @@ + + + + + + +public static enum ReflectionUtils.DataType +extends Enum<ReflectionUtils.DataType>+
+ This class is part of the ReflectionUtils and follows the same + usage conditions
| Enum Constant and Description | +
|---|
BOOLEAN |
+
BYTE |
+
CHARACTER |
+
DOUBLE |
+
FLOAT |
+
INTEGER |
+
LONG |
+
SHORT |
+
| Modifier and Type | +Method and Description | +
|---|---|
static boolean |
+compare(Class<?>[] primary,
+ Class<?>[] secondary)
+Compares two class arrays on equivalence
+ |
+
static ReflectionUtils.DataType |
+fromClass(Class<?> clazz)
+Returns the data type with the given primitive/reference class
+ |
+
Class<?> |
+getPrimitive()
+Returns the primitive class of this data type
+ |
+
static Class<?> |
+getPrimitive(Class<?> clazz)
+Returns the primitive class of the data type with the given reference
+ class
+ |
+
static Class<?>[] |
+getPrimitive(Class<?>[] classes)
+Returns the primitive class array of the given class array
+ |
+
static Class<?>[] |
+getPrimitive(Object[] objects)
+Returns the primitive class array of the given object array
+ |
+
Class<?> |
+getReference()
+Returns the reference class of this data type
+ |
+
static Class<?> |
+getReference(Class<?> clazz)
+Returns the reference class of the data type with the given primitive
+ class
+ |
+
static Class<?>[] |
+getReference(Class<?>[] classes)
+Returns the reference class array of the given class array
+ |
+
static Class<?>[] |
+getReference(Object[] objects)
+Returns the reference class array of the given object array
+ |
+
static ReflectionUtils.DataType |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ReflectionUtils.DataType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ReflectionUtils.DataType BYTE+
public static final ReflectionUtils.DataType SHORT+
public static final ReflectionUtils.DataType INTEGER+
public static final ReflectionUtils.DataType LONG+
public static final ReflectionUtils.DataType CHARACTER+
public static final ReflectionUtils.DataType FLOAT+
public static final ReflectionUtils.DataType DOUBLE+
public static final ReflectionUtils.DataType BOOLEAN+
public static ReflectionUtils.DataType[] values()+
+for (ReflectionUtils.DataType c : ReflectionUtils.DataType.values()) + System.out.println(c); +
public static ReflectionUtils.DataType valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Class<?> getPrimitive()+
public Class<?> getReference()+
public static ReflectionUtils.DataType fromClass(Class<?> clazz)+
clazz - Primitive/Reference class of the data typepublic static Class<?> getPrimitive(Class<?> clazz)+
clazz - Reference class of the data typepublic static Class<?> getReference(Class<?> clazz)+
clazz - Primitive class of the data typepublic static Class<?>[] getPrimitive(Class<?>[] classes)+
classes - Given class arraypublic static Class<?>[] getReference(Class<?>[] classes)+
classes - Given class arraypublic static Class<?>[] getPrimitive(Object[] objects)+
objects - Given object arraypublic static Class<?>[] getReference(Object[] objects)+
objects - Given object arrayCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ReflectionUtils.PackageType.html b/docs/phantom/vfx/ReflectionUtils.PackageType.html new file mode 100644 index 000000000..5c6a86801 --- /dev/null +++ b/docs/phantom/vfx/ReflectionUtils.PackageType.html @@ -0,0 +1,656 @@ + + + + + + +public static enum ReflectionUtils.PackageType +extends Enum<ReflectionUtils.PackageType>+
+ This class is part of the ReflectionUtils and follows the same + usage conditions
| Enum Constant and Description | +
|---|
CRAFTBUKKIT |
+
CRAFTBUKKIT_BLOCK |
+
CRAFTBUKKIT_CHUNKIO |
+
CRAFTBUKKIT_COMMAND |
+
CRAFTBUKKIT_CONVERSATIONS |
+
CRAFTBUKKIT_ENCHANTMENS |
+
CRAFTBUKKIT_ENTITY |
+
CRAFTBUKKIT_EVENT |
+
CRAFTBUKKIT_GENERATOR |
+
CRAFTBUKKIT_HELP |
+
CRAFTBUKKIT_INVENTORY |
+
CRAFTBUKKIT_MAP |
+
CRAFTBUKKIT_METADATA |
+
CRAFTBUKKIT_POTION |
+
CRAFTBUKKIT_PROJECTILES |
+
CRAFTBUKKIT_SCHEDULER |
+
CRAFTBUKKIT_SCOREBOARD |
+
CRAFTBUKKIT_UPDATER |
+
CRAFTBUKKIT_UTIL |
+
MINECRAFT_SERVER |
+
| Modifier and Type | +Method and Description | +
|---|---|
Class<?> |
+getClass(String className)
+Returns the class with the given name
+ |
+
String |
+getPath()
+Returns the path of this package type
+ |
+
static String |
+getServerVersion()
+Returns the version of your server
+ |
+
String |
+toString() |
+
static ReflectionUtils.PackageType |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ReflectionUtils.PackageType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ReflectionUtils.PackageType MINECRAFT_SERVER+
public static final ReflectionUtils.PackageType CRAFTBUKKIT+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_BLOCK+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_CHUNKIO+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_COMMAND+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_CONVERSATIONS+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_ENCHANTMENS+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_ENTITY+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_EVENT+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_GENERATOR+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_HELP+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_INVENTORY+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_MAP+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_METADATA+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_POTION+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_PROJECTILES+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_SCHEDULER+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_SCOREBOARD+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_UPDATER+
public static final ReflectionUtils.PackageType CRAFTBUKKIT_UTIL+
public static ReflectionUtils.PackageType[] values()+
+for (ReflectionUtils.PackageType c : ReflectionUtils.PackageType.values()) + System.out.println(c); +
public static ReflectionUtils.PackageType valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String getPath()+
public Class<?> getClass(String className) + throws ClassNotFoundException+
className - Name of the desired classClassNotFoundException - If the desired class with the specified name and package
+ cannot be foundpublic String toString()+
toString in class Enum<ReflectionUtils.PackageType>public static String getServerVersion()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/ReflectionUtils.html b/docs/phantom/vfx/ReflectionUtils.html new file mode 100644 index 000000000..e59fdd45e --- /dev/null +++ b/docs/phantom/vfx/ReflectionUtils.html @@ -0,0 +1,1000 @@ + + + + + + +public final class ReflectionUtils +extends Object+
+ This class provides useful methods which makes dealing with reflection much + easier, especially when working with Bukkit +
+ You are welcome to use it, modify it and redistribute it under the following + conditions: +
+ It would be nice if you provide credit to me if you use this class in a + published project
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+ReflectionUtils.DataType
+Represents an enumeration of Java data types with corresponding classes
+ |
+
static class |
+ReflectionUtils.PackageType
+Represents an enumeration of dynamic packages of NMS and CraftBukkit
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Constructor<?> |
+getConstructor(Class<?> clazz,
+ Class<?>... parameterTypes)
+Returns the constructor of a given class with the given parameter types
+ |
+
static Constructor<?> |
+getConstructor(String className,
+ ReflectionUtils.PackageType packageType,
+ Class<?>... parameterTypes)
+Returns the constructor of a desired class with the given parameter types
+ |
+
static Field |
+getField(Class<?> clazz,
+ boolean declared,
+ String fieldName)
+Returns a field of the target class with the given name
+ |
+
static Field |
+getField(String className,
+ ReflectionUtils.PackageType packageType,
+ boolean declared,
+ String fieldName)
+Returns a field of a desired class with the given name
+ |
+
static Method |
+getMethod(Class<?> clazz,
+ String methodName,
+ Class<?>... parameterTypes)
+Returns a method of a class with the given parameter types
+ |
+
static Method |
+getMethod(String className,
+ ReflectionUtils.PackageType packageType,
+ String methodName,
+ Class<?>... parameterTypes)
+Returns a method of a desired class with the given parameter types
+ |
+
static Object |
+getValue(Object instance,
+ boolean declared,
+ String fieldName)
+Returns the value of a field with the given name of an object
+ |
+
static Object |
+getValue(Object instance,
+ Class<?> clazz,
+ boolean declared,
+ String fieldName)
+Returns the value of a field of the given class of an object
+ |
+
static Object |
+getValue(Object instance,
+ String className,
+ ReflectionUtils.PackageType packageType,
+ boolean declared,
+ String fieldName)
+Returns the value of a field of a desired class of an object
+ |
+
static Object |
+instantiateObject(Class<?> clazz,
+ Object... arguments)
+Returns an instance of a class with the given arguments
+ |
+
static Object |
+instantiateObject(String className,
+ ReflectionUtils.PackageType packageType,
+ Object... arguments)
+Returns an instance of a desired class with the given arguments
+ |
+
static Object |
+invokeMethod(Object instance,
+ Class<?> clazz,
+ String methodName,
+ Object... arguments)
+Invokes a method of the target class on an object with the given
+ arguments
+ |
+
static Object |
+invokeMethod(Object instance,
+ String methodName,
+ Object... arguments)
+Invokes a method on an object with the given arguments
+ |
+
static Object |
+invokeMethod(Object instance,
+ String className,
+ ReflectionUtils.PackageType packageType,
+ String methodName,
+ Object... arguments)
+Invokes a method of a desired class on an object with the given arguments
+ |
+
static void |
+setValue(Object instance,
+ boolean declared,
+ String fieldName,
+ Object value)
+Sets the value of a field with the given name of an object
+ |
+
static void |
+setValue(Object instance,
+ Class<?> clazz,
+ boolean declared,
+ String fieldName,
+ Object value)
+Sets the value of a field of the given class of an object
+ |
+
static void |
+setValue(Object instance,
+ String className,
+ ReflectionUtils.PackageType packageType,
+ boolean declared,
+ String fieldName,
+ Object value)
+Sets the value of a field of a desired class of an object
+ |
+
public static Constructor<?> getConstructor(Class<?> clazz, + Class<?>... parameterTypes) + throws NoSuchMethodException+
clazz - Target classparameterTypes - Parameter types of the desired constructorNoSuchMethodException - If the desired constructor with the specified parameter types
+ cannot be foundReflectionUtils.DataType,
+ReflectionUtils.DataType.getPrimitive(Class[]),
+ReflectionUtils.DataType.compare(Class[], Class[])public static Constructor<?> getConstructor(String className, + ReflectionUtils.PackageType packageType, + Class<?>... parameterTypes) + throws NoSuchMethodException, + ClassNotFoundException+
className - Name of the desired target classpackageType - Package where the desired target class is locatedparameterTypes - Parameter types of the desired constructorNoSuchMethodException - If the desired constructor with the specified parameter types
+ cannot be foundClassNotFoundException - ClassNotFoundException If the desired target class with the
+ specified name and package cannot be foundgetConstructor(Class, Class...)public static Object instantiateObject(Class<?> clazz, + Object... arguments) + throws InstantiationException, + IllegalAccessException, + IllegalArgumentException, + InvocationTargetException, + NoSuchMethodException+
clazz - Target classarguments - Arguments which are used to construct an object of the target
+ classInstantiationException - If you cannot create an instance of the target class due to
+ certain circumstancesIllegalAccessException - If the desired constructor cannot be accessed due to certain
+ circumstancesIllegalArgumentException - If the types of the arguments do not match the parameter
+ types of the constructor (this should not occur since it
+ searches for a constructor with the types of the arguments)InvocationTargetException - If the desired constructor cannot be invokedNoSuchMethodException - If the desired constructor with the specified arguments
+ cannot be foundpublic static Object instantiateObject(String className, + ReflectionUtils.PackageType packageType, + Object... arguments) + throws InstantiationException, + IllegalAccessException, + IllegalArgumentException, + InvocationTargetException, + NoSuchMethodException, + ClassNotFoundException+
className - Name of the desired target classpackageType - Package where the desired target class is locatedarguments - Arguments which are used to construct an object of the desired
+ target classInstantiationException - If you cannot create an instance of the desired target class
+ due to certain circumstancesIllegalAccessException - If the desired constructor cannot be accessed due to certain
+ circumstancesIllegalArgumentException - If the types of the arguments do not match the parameter
+ types of the constructor (this should not occur since it
+ searches for a constructor with the types of the arguments)InvocationTargetException - If the desired constructor cannot be invokedNoSuchMethodException - If the desired constructor with the specified arguments
+ cannot be foundClassNotFoundException - If the desired target class with the specified name and
+ package cannot be foundinstantiateObject(Class, Object...)public static Method getMethod(Class<?> clazz, + String methodName, + Class<?>... parameterTypes) + throws NoSuchMethodException+
clazz - Target classmethodName - Name of the desired methodparameterTypes - Parameter types of the desired methodNoSuchMethodException - If the desired method of the target class with the specified
+ name and parameter types cannot be foundReflectionUtils.DataType.getPrimitive(Class[]),
+ReflectionUtils.DataType.compare(Class[], Class[])public static Method getMethod(String className, + ReflectionUtils.PackageType packageType, + String methodName, + Class<?>... parameterTypes) + throws NoSuchMethodException, + ClassNotFoundException+
className - Name of the desired target classpackageType - Package where the desired target class is locatedmethodName - Name of the desired methodparameterTypes - Parameter types of the desired methodNoSuchMethodException - If the desired method of the desired target class with the
+ specified name and parameter types cannot be foundClassNotFoundException - If the desired target class with the specified name and
+ package cannot be foundgetMethod(Class, String, Class...)public static Object invokeMethod(Object instance, + String methodName, + Object... arguments) + throws IllegalAccessException, + IllegalArgumentException, + InvocationTargetException, + NoSuchMethodException+
instance - Target objectmethodName - Name of the desired methodarguments - Arguments which are used to invoke the desired methodIllegalAccessException - If the desired method cannot be accessed due to certain
+ circumstancesIllegalArgumentException - If the types of the arguments do not match the parameter
+ types of the method (this should not occur since it searches
+ for a method with the types of the arguments)InvocationTargetException - If the desired method cannot be invoked on the target objectNoSuchMethodException - If the desired method of the class of the target object with
+ the specified name and arguments cannot be foundgetMethod(Class, String, Class...),
+ReflectionUtils.DataType.getPrimitive(Object[])public static Object invokeMethod(Object instance, + Class<?> clazz, + String methodName, + Object... arguments) + throws IllegalAccessException, + IllegalArgumentException, + InvocationTargetException, + NoSuchMethodException+
instance - Target objectclazz - Target classmethodName - Name of the desired methodarguments - Arguments which are used to invoke the desired methodIllegalAccessException - If the desired method cannot be accessed due to certain
+ circumstancesIllegalArgumentException - If the types of the arguments do not match the parameter
+ types of the method (this should not occur since it searches
+ for a method with the types of the arguments)InvocationTargetException - If the desired method cannot be invoked on the target objectNoSuchMethodException - If the desired method of the target class with the specified
+ name and arguments cannot be foundgetMethod(Class, String, Class...),
+ReflectionUtils.DataType.getPrimitive(Object[])public static Object invokeMethod(Object instance, + String className, + ReflectionUtils.PackageType packageType, + String methodName, + Object... arguments) + throws IllegalAccessException, + IllegalArgumentException, + InvocationTargetException, + NoSuchMethodException, + ClassNotFoundException+
instance - Target objectclassName - Name of the desired target classpackageType - Package where the desired target class is locatedmethodName - Name of the desired methodarguments - Arguments which are used to invoke the desired methodIllegalAccessException - If the desired method cannot be accessed due to certain
+ circumstancesIllegalArgumentException - If the types of the arguments do not match the parameter
+ types of the method (this should not occur since it searches
+ for a method with the types of the arguments)InvocationTargetException - If the desired method cannot be invoked on the target objectNoSuchMethodException - If the desired method of the desired target class with the
+ specified name and arguments cannot be foundClassNotFoundException - If the desired target class with the specified name and
+ package cannot be foundinvokeMethod(Object, Class, String, Object...)public static Field getField(Class<?> clazz, + boolean declared, + String fieldName) + throws NoSuchFieldException, + SecurityException+
clazz - Target classdeclared - Whether the desired field is declared or notfieldName - Name of the desired fieldNoSuchFieldException - If the desired field of the given class cannot be foundSecurityException - If the desired field cannot be made accessiblepublic static Field getField(String className, + ReflectionUtils.PackageType packageType, + boolean declared, + String fieldName) + throws NoSuchFieldException, + SecurityException, + ClassNotFoundException+
className - Name of the desired target classpackageType - Package where the desired target class is locateddeclared - Whether the desired field is declared or notfieldName - Name of the desired fieldNoSuchFieldException - If the desired field of the desired class cannot be foundSecurityException - If the desired field cannot be made accessibleClassNotFoundException - If the desired target class with the specified name and
+ package cannot be foundgetField(Class, boolean, String)public static Object getValue(Object instance, + Class<?> clazz, + boolean declared, + String fieldName) + throws IllegalArgumentException, + IllegalAccessException, + NoSuchFieldException, + SecurityException+
instance - Target objectclazz - Target classdeclared - Whether the desired field is declared or notfieldName - Name of the desired fieldIllegalArgumentException - If the target object does not feature the desired fieldIllegalAccessException - If the desired field cannot be accessedNoSuchFieldException - If the desired field of the target class cannot be foundSecurityException - If the desired field cannot be made accessiblegetField(Class, boolean, String)public static Object getValue(Object instance, + String className, + ReflectionUtils.PackageType packageType, + boolean declared, + String fieldName) + throws IllegalArgumentException, + IllegalAccessException, + NoSuchFieldException, + SecurityException, + ClassNotFoundException+
instance - Target objectclassName - Name of the desired target classpackageType - Package where the desired target class is locateddeclared - Whether the desired field is declared or notfieldName - Name of the desired fieldIllegalArgumentException - If the target object does not feature the desired fieldIllegalAccessException - If the desired field cannot be accessedNoSuchFieldException - If the desired field of the desired class cannot be foundSecurityException - If the desired field cannot be made accessibleClassNotFoundException - If the desired target class with the specified name and
+ package cannot be foundgetValue(Object, Class, boolean, String)public static Object getValue(Object instance, + boolean declared, + String fieldName) + throws IllegalArgumentException, + IllegalAccessException, + NoSuchFieldException, + SecurityException+
instance - Target objectdeclared - Whether the desired field is declared or notfieldName - Name of the desired fieldIllegalArgumentException - If the target object does not feature the desired field
+ (should not occur since it searches for a field with the
+ given name in the class of the object)IllegalAccessException - If the desired field cannot be accessedNoSuchFieldException - If the desired field of the target object cannot be foundSecurityException - If the desired field cannot be made accessiblegetValue(Object, Class, boolean, String)public static void setValue(Object instance, + Class<?> clazz, + boolean declared, + String fieldName, + Object value) + throws IllegalArgumentException, + IllegalAccessException, + NoSuchFieldException, + SecurityException+
instance - Target objectclazz - Target classdeclared - Whether the desired field is declared or notfieldName - Name of the desired fieldvalue - New valueIllegalArgumentException - If the type of the value does not match the type of the
+ desired fieldIllegalAccessException - If the desired field cannot be accessedNoSuchFieldException - If the desired field of the target class cannot be foundSecurityException - If the desired field cannot be made accessiblegetField(Class, boolean, String)public static void setValue(Object instance, + String className, + ReflectionUtils.PackageType packageType, + boolean declared, + String fieldName, + Object value) + throws IllegalArgumentException, + IllegalAccessException, + NoSuchFieldException, + SecurityException, + ClassNotFoundException+
instance - Target objectclassName - Name of the desired target classpackageType - Package where the desired target class is locateddeclared - Whether the desired field is declared or notfieldName - Name of the desired fieldvalue - New valueIllegalArgumentException - If the type of the value does not match the type of the
+ desired fieldIllegalAccessException - If the desired field cannot be accessedNoSuchFieldException - If the desired field of the desired class cannot be foundSecurityException - If the desired field cannot be made accessibleClassNotFoundException - If the desired target class with the specified name and
+ package cannot be foundsetValue(Object, Class, boolean, String, Object)public static void setValue(Object instance, + boolean declared, + String fieldName, + Object value) + throws IllegalArgumentException, + IllegalAccessException, + NoSuchFieldException, + SecurityException+
instance - Target objectdeclared - Whether the desired field is declared or notfieldName - Name of the desired fieldvalue - New valueIllegalArgumentException - If the type of the value does not match the type of the
+ desired fieldIllegalAccessException - If the desired field cannot be accessedNoSuchFieldException - If the desired field of the target object cannot be foundSecurityException - If the desired field cannot be made accessiblesetValue(Object, Class, boolean, String, Object)Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/SphereParticleManipulator.html b/docs/phantom/vfx/SphereParticleManipulator.html new file mode 100644 index 000000000..f47d9e0d0 --- /dev/null +++ b/docs/phantom/vfx/SphereParticleManipulator.html @@ -0,0 +1,316 @@ + + + + + + +public abstract class SphereParticleManipulator +extends ParticleManipulator+
| Constructor and Description | +
|---|
SphereParticleManipulator() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+play(org.bukkit.Location center,
+ Double radius,
+ Double resolution)
+Draw a sphere
+ |
+
addEffect, getEffects, playpublic SphereParticleManipulator()+
public void play(org.bukkit.Location center, + Double radius, + Double resolution)+
center - the center of the sphereradius - the radius of the sphereresolution - resolution is particle blocks. Setting the resolution to 1
+ would simply make each particle about one block apart, 2 being
+ 2 particles per interval and so on. 0.5 being 2 blocks per
+ particleCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/SystemEffect.html b/docs/phantom/vfx/SystemEffect.html new file mode 100644 index 000000000..a5e6a4c9a --- /dev/null +++ b/docs/phantom/vfx/SystemEffect.html @@ -0,0 +1,345 @@ + + + + + + +public class SystemEffect +extends Object +implements VisualEffect+
| Constructor and Description | +
|---|
SystemEffect()
+Create a system effect
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addEffect(VisualEffect e)
+Add a visual effect to this effect.
+ |
+
GList<VisualEffect> |
+getEffects()
+Get all effects in this visual effect
+ |
+
void |
+play(org.bukkit.Location l)
+Play this effect.
+ |
+
public SystemEffect()+
public GList<VisualEffect> getEffects()+
VisualEffectgetEffects in interface VisualEffectpublic void play(org.bukkit.Location l)+
VisualEffectplay in interface VisualEffectl - the location to play the effectpublic void addEffect(VisualEffect e)+
VisualEffectaddEffect in interface VisualEffecte - the effectCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/VisualEffect.html b/docs/phantom/vfx/VisualEffect.html new file mode 100644 index 000000000..313b6e609 --- /dev/null +++ b/docs/phantom/vfx/VisualEffect.html @@ -0,0 +1,283 @@ + + + + + + +public interface VisualEffect
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+addEffect(VisualEffect e)
+Add a visual effect to this effect.
+ |
+
GList<VisualEffect> |
+getEffects()
+Get all effects in this visual effect
+ |
+
void |
+play(org.bukkit.Location l)
+Play this effect.
+ |
+
GList<VisualEffect> getEffects()+
void play(org.bukkit.Location l)+
l - the location to play the effectvoid addEffect(VisualEffect e)+
e - the effectCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ColoredParticleEffect.html b/docs/phantom/vfx/class-use/ColoredParticleEffect.html new file mode 100644 index 000000000..6d6dbb23c --- /dev/null +++ b/docs/phantom/vfx/class-use/ColoredParticleEffect.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/LineParticleManipulator.html b/docs/phantom/vfx/class-use/LineParticleManipulator.html new file mode 100644 index 000000000..009e9bb79 --- /dev/null +++ b/docs/phantom/vfx/class-use/LineParticleManipulator.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.BlockData.html b/docs/phantom/vfx/class-use/ParticleEffect.BlockData.html new file mode 100644 index 000000000..27f840772 --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.BlockData.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.ItemData.html b/docs/phantom/vfx/class-use/ParticleEffect.ItemData.html new file mode 100644 index 000000000..1c7380834 --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.ItemData.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.NoteColor.html b/docs/phantom/vfx/class-use/ParticleEffect.NoteColor.html new file mode 100644 index 000000000..baa326c5b --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.NoteColor.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.OrdinaryColor.html b/docs/phantom/vfx/class-use/ParticleEffect.OrdinaryColor.html new file mode 100644 index 000000000..a033e13bd --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.OrdinaryColor.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.ParticleColor.html b/docs/phantom/vfx/class-use/ParticleEffect.ParticleColor.html new file mode 100644 index 000000000..b5b37c33d --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.ParticleColor.html @@ -0,0 +1,228 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+ParticleEffect.NoteColor
+Represents the color for the
+ParticleEffect.NOTE effect |
+
static class |
+ParticleEffect.OrdinaryColor
+Represents the color for effects like
+ParticleEffect.SPELL_MOB,
+ ParticleEffect.SPELL_MOB_AMBIENT and ParticleEffect.NOTE |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ParticleEffect.display(ParticleEffect.ParticleColor color,
+ org.bukkit.Location center,
+ double range)
+Displays a single particle which is colored and only visible for all
+ players within a certain range in the world of @param center
+ |
+
void |
+ParticleEffect.display(ParticleEffect.ParticleColor color,
+ org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Displays a single particle which is colored and only visible for the
+ specified players
+ |
+
void |
+ParticleEffect.display(ParticleEffect.ParticleColor color,
+ org.bukkit.Location center,
+ org.bukkit.entity.Player... players)
+Displays a single particle which is colored and only visible for the
+ specified players
+ |
+
| Constructor and Description | +
|---|
ParticlePacket(ParticleEffect effect,
+ ParticleEffect.ParticleColor color,
+ boolean longDistance)
+Construct a new particle packet of a single colored particle
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.ParticleData.html b/docs/phantom/vfx/class-use/ParticleEffect.ParticleData.html new file mode 100644 index 000000000..8f99eaf56 --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.ParticleData.html @@ -0,0 +1,284 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+ParticleEffect.BlockData
+Represents the block data for the
+ParticleEffect.BLOCK_CRACK and
+ ParticleEffect.BLOCK_DUST effects |
+
static class |
+ParticleEffect.ItemData
+Represents the item data for the
+ParticleEffect.ITEM_CRACK effect |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ParticleEffect.display(ParticleEffect.ParticleData data,
+ float speed,
+ int amount,
+ org.bukkit.Location center,
+ double range)
+Displays a particle effect which requires additional data and is only
+ visible for all players within a certain range in the world of @param
+ center
+ |
+
void |
+ParticleEffect.display(ParticleEffect.ParticleData data,
+ float speed,
+ int amount,
+ org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Displays a particle effect which requires additional data and is only
+ visible for the specified players
+ |
+
void |
+ParticleEffect.display(ParticleEffect.ParticleData data,
+ float speed,
+ int amount,
+ org.bukkit.Location center,
+ org.bukkit.entity.Player... players)
+Displays a particle effect which requires additional data and is only
+ visible for the specified players
+ |
+
void |
+ParticleEffect.display(ParticleEffect.ParticleData data,
+ org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ double range)
+Displays a single particle which requires additional data that flies into
+ a determined direction and is only visible for all players within a
+ certain range in the world of @param center
+ |
+
void |
+ParticleEffect.display(ParticleEffect.ParticleData data,
+ org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ List<org.bukkit.entity.Player> players)
+Displays a single particle which requires additional data that flies into
+ a determined direction and is only visible for the specified players
+ |
+
void |
+ParticleEffect.display(ParticleEffect.ParticleData data,
+ org.bukkit.util.Vector direction,
+ float speed,
+ org.bukkit.Location center,
+ org.bukkit.entity.Player... players)
+Displays a single particle which requires additional data that flies into
+ a determined direction and is only visible for the specified players
+ |
+
| Constructor and Description | +
|---|
ParticlePacket(ParticleEffect effect,
+ float offsetX,
+ float offsetY,
+ float offsetZ,
+ float speed,
+ int amount,
+ boolean longDistance,
+ ParticleEffect.ParticleData data)
+Construct a new particle packet
+ |
+
ParticlePacket(ParticleEffect effect,
+ org.bukkit.util.Vector direction,
+ float speed,
+ boolean longDistance,
+ ParticleEffect.ParticleData data)
+Construct a new particle packet of a single particle flying into a
+ determined direction
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.ParticlePacket.html b/docs/phantom/vfx/class-use/ParticleEffect.ParticlePacket.html new file mode 100644 index 000000000..3df55d750 --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.ParticlePacket.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.ParticleProperty.html b/docs/phantom/vfx/class-use/ParticleEffect.ParticleProperty.html new file mode 100644 index 000000000..7e24a01b7 --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.ParticleProperty.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ParticleEffect.ParticleProperty |
+ParticleEffect.ParticleProperty.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ParticleEffect.ParticleProperty[] |
+ParticleEffect.ParticleProperty.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+ParticleEffect.hasProperty(ParticleEffect.ParticleProperty property)
+Determine if this particle effect has a specific property
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleEffect.html b/docs/phantom/vfx/class-use/ParticleEffect.html new file mode 100644 index 000000000..e0f673cc4 --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleEffect.html @@ -0,0 +1,226 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ParticleEffect |
+ParticleEffect.fromId(int id)
+Returns the particle effect with the given id
+ |
+
static ParticleEffect |
+ParticleEffect.fromName(String name)
+Returns the particle effect with the given name
+ |
+
static ParticleEffect |
+ParticleEffect.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ParticleEffect[] |
+ParticleEffect.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Constructor and Description | +
|---|
ParticlePacket(ParticleEffect effect,
+ float offsetX,
+ float offsetY,
+ float offsetZ,
+ float speed,
+ int amount,
+ boolean longDistance,
+ ParticleEffect.ParticleData data)
+Construct a new particle packet
+ |
+
ParticlePacket(ParticleEffect effect,
+ ParticleEffect.ParticleColor color,
+ boolean longDistance)
+Construct a new particle packet of a single colored particle
+ |
+
ParticlePacket(ParticleEffect effect,
+ org.bukkit.util.Vector direction,
+ float speed,
+ boolean longDistance,
+ ParticleEffect.ParticleData data)
+Construct a new particle packet of a single particle flying into a
+ determined direction
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ParticleManipulator.html b/docs/phantom/vfx/class-use/ParticleManipulator.html new file mode 100644 index 000000000..eb8fd5a9e --- /dev/null +++ b/docs/phantom/vfx/class-use/ParticleManipulator.html @@ -0,0 +1,177 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LineParticleManipulator
+A Particle effect which is a line from a to b.
+ |
+
class |
+SphereParticleManipulator
+A Particle effect which is an elptical shape created with a vector for volume
+ whd
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/PhantomEffect.html b/docs/phantom/vfx/class-use/PhantomEffect.html new file mode 100644 index 000000000..c5f6f5d96 --- /dev/null +++ b/docs/phantom/vfx/class-use/PhantomEffect.html @@ -0,0 +1,183 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LineParticleManipulator
+A Particle effect which is a line from a to b.
+ |
+
class |
+ParticleManipulator
+Base implementation for a particle manipluator
+ |
+
class |
+SphereParticleManipulator
+A Particle effect which is an elptical shape created with a vector for volume
+ whd
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ReflectionUtils.DataType.html b/docs/phantom/vfx/class-use/ReflectionUtils.DataType.html new file mode 100644 index 000000000..616dde43a --- /dev/null +++ b/docs/phantom/vfx/class-use/ReflectionUtils.DataType.html @@ -0,0 +1,183 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ReflectionUtils.DataType |
+ReflectionUtils.DataType.fromClass(Class<?> clazz)
+Returns the data type with the given primitive/reference class
+ |
+
static ReflectionUtils.DataType |
+ReflectionUtils.DataType.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ReflectionUtils.DataType[] |
+ReflectionUtils.DataType.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ReflectionUtils.PackageType.html b/docs/phantom/vfx/class-use/ReflectionUtils.PackageType.html new file mode 100644 index 000000000..caf1fd5e1 --- /dev/null +++ b/docs/phantom/vfx/class-use/ReflectionUtils.PackageType.html @@ -0,0 +1,251 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ReflectionUtils.PackageType |
+ReflectionUtils.PackageType.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ReflectionUtils.PackageType[] |
+ReflectionUtils.PackageType.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Constructor<?> |
+ReflectionUtils.getConstructor(String className,
+ ReflectionUtils.PackageType packageType,
+ Class<?>... parameterTypes)
+Returns the constructor of a desired class with the given parameter types
+ |
+
static Field |
+ReflectionUtils.getField(String className,
+ ReflectionUtils.PackageType packageType,
+ boolean declared,
+ String fieldName)
+Returns a field of a desired class with the given name
+ |
+
static Method |
+ReflectionUtils.getMethod(String className,
+ ReflectionUtils.PackageType packageType,
+ String methodName,
+ Class<?>... parameterTypes)
+Returns a method of a desired class with the given parameter types
+ |
+
static Object |
+ReflectionUtils.getValue(Object instance,
+ String className,
+ ReflectionUtils.PackageType packageType,
+ boolean declared,
+ String fieldName)
+Returns the value of a field of a desired class of an object
+ |
+
static Object |
+ReflectionUtils.instantiateObject(String className,
+ ReflectionUtils.PackageType packageType,
+ Object... arguments)
+Returns an instance of a desired class with the given arguments
+ |
+
static Object |
+ReflectionUtils.invokeMethod(Object instance,
+ String className,
+ ReflectionUtils.PackageType packageType,
+ String methodName,
+ Object... arguments)
+Invokes a method of a desired class on an object with the given arguments
+ |
+
static void |
+ReflectionUtils.setValue(Object instance,
+ String className,
+ ReflectionUtils.PackageType packageType,
+ boolean declared,
+ String fieldName,
+ Object value)
+Sets the value of a field of a desired class of an object
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/ReflectionUtils.html b/docs/phantom/vfx/class-use/ReflectionUtils.html new file mode 100644 index 000000000..5d2b28f04 --- /dev/null +++ b/docs/phantom/vfx/class-use/ReflectionUtils.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/SphereParticleManipulator.html b/docs/phantom/vfx/class-use/SphereParticleManipulator.html new file mode 100644 index 000000000..1f0517141 --- /dev/null +++ b/docs/phantom/vfx/class-use/SphereParticleManipulator.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/SystemEffect.html b/docs/phantom/vfx/class-use/SystemEffect.html new file mode 100644 index 000000000..2cd611ae7 --- /dev/null +++ b/docs/phantom/vfx/class-use/SystemEffect.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/class-use/VisualEffect.html b/docs/phantom/vfx/class-use/VisualEffect.html new file mode 100644 index 000000000..e2ea00714 --- /dev/null +++ b/docs/phantom/vfx/class-use/VisualEffect.html @@ -0,0 +1,254 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ColoredParticleEffect |
+
class |
+LineParticleManipulator
+A Particle effect which is a line from a to b.
+ |
+
class |
+ParticleManipulator
+Base implementation for a particle manipluator
+ |
+
class |
+PhantomEffect
+An effect that can be played
+ |
+
class |
+SphereParticleManipulator
+A Particle effect which is an elptical shape created with a vector for volume
+ whd
+ |
+
class |
+SystemEffect
+A system effect which contains multiple effects within itself, yet acts like
+ a normal visual effect which could be put into a super-super-effect if needed
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
GList<VisualEffect> |
+VisualEffect.getEffects()
+Get all effects in this visual effect
+ |
+
GList<VisualEffect> |
+SystemEffect.getEffects() |
+
GList<VisualEffect> |
+PhantomEffect.getEffects() |
+
GList<VisualEffect> |
+ColoredParticleEffect.getEffects() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+VisualEffect.addEffect(VisualEffect e)
+Add a visual effect to this effect.
+ |
+
void |
+SystemEffect.addEffect(VisualEffect e) |
+
void |
+PhantomEffect.addEffect(VisualEffect e) |
+
void |
+ColoredParticleEffect.addEffect(VisualEffect e) |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/package-frame.html b/docs/phantom/vfx/package-frame.html new file mode 100644 index 000000000..e59c28c20 --- /dev/null +++ b/docs/phantom/vfx/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +See: Description
+| Interface | +Description | +
|---|---|
| VisualEffect | +
+ A visual effect which may be an actual effect, or a super-effect (multiple
+ sub effects) Allows you to play them simply, even though there could be
+ hundreds of meta-visual effects within a super visual effect
+ |
+
| Class | +Description | +
|---|---|
| ColoredParticleEffect | ++ |
| LineParticleManipulator | +
+ A Particle effect which is a line from a to b.
+ |
+
| ParticleEffect.BlockData | +
+ Represents the block data for the
+ParticleEffect.BLOCK_CRACK and
+ ParticleEffect.BLOCK_DUST effects |
+
| ParticleEffect.ItemData | +
+ Represents the item data for the
+ParticleEffect.ITEM_CRACK effect |
+
| ParticleEffect.NoteColor | +
+ Represents the color for the
+ParticleEffect.NOTE effect |
+
| ParticleEffect.OrdinaryColor | +
+ Represents the color for effects like
+ParticleEffect.SPELL_MOB,
+ ParticleEffect.SPELL_MOB_AMBIENT and ParticleEffect.NOTE |
+
| ParticleEffect.ParticleColor | +
+ Represents the color for effects like
+ParticleEffect.SPELL_MOB,
+ ParticleEffect.SPELL_MOB_AMBIENT, ParticleEffect.REDSTONE
+ and ParticleEffect.NOTE |
+
| ParticleEffect.ParticleData | +
+ Represents the particle data for effects like
+
+ParticleEffect.ITEM_CRACK, ParticleEffect.BLOCK_CRACK and
+ ParticleEffect.BLOCK_DUST |
+
| ParticleEffect.ParticlePacket | +
+ Represents a particle effect packet with all attributes which is used for
+ sending packets to the players
+ |
+
| ParticleManipulator | +
+ Base implementation for a particle manipluator
+ |
+
| PhantomEffect | +
+ An effect that can be played
+ |
+
| ReflectionUtils | +
+ ReflectionUtils
+ |
+
| SphereParticleManipulator | +
+ A Particle effect which is an elptical shape created with a vector for volume
+ whd
+ |
+
| SystemEffect | +
+ A system effect which contains multiple effects within itself, yet acts like
+ a normal visual effect which could be put into a super-super-effect if needed
+ |
+
| Enum | +Description | +
|---|---|
| ParticleEffect | +
+ ParticleEffect Library
+ |
+
| ParticleEffect.ParticleProperty | +
+ Represents the property of a particle effect
+ |
+
| ReflectionUtils.DataType | +
+ Represents an enumeration of Java data types with corresponding classes
+ |
+
| ReflectionUtils.PackageType | +
+ Represents an enumeration of dynamic packages of NMS and CraftBukkit
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/package-tree.html b/docs/phantom/vfx/package-tree.html new file mode 100644 index 000000000..f410e47d8 --- /dev/null +++ b/docs/phantom/vfx/package-tree.html @@ -0,0 +1,183 @@ + + + + + + +Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/vfx/package-use.html b/docs/phantom/vfx/package-use.html new file mode 100644 index 000000000..a2f37b012 --- /dev/null +++ b/docs/phantom/vfx/package-use.html @@ -0,0 +1,209 @@ + + + + + + +| Package | +Description | +
|---|---|
| phantom.vfx | +
+ Visual effects, particle builders, and particle manipulators/distortions
+ |
+
| Class and Description | +
|---|
| ParticleEffect
+ ParticleEffect Library
+ |
+
| ParticleEffect.ParticleColor
+ Represents the color for effects like
+ParticleEffect.SPELL_MOB,
+ ParticleEffect.SPELL_MOB_AMBIENT, ParticleEffect.REDSTONE
+ and ParticleEffect.NOTE |
+
| ParticleEffect.ParticleData
+ Represents the particle data for effects like
+
+ParticleEffect.ITEM_CRACK, ParticleEffect.BLOCK_CRACK and
+ ParticleEffect.BLOCK_DUST |
+
| ParticleEffect.ParticleProperty
+ Represents the property of a particle effect
+ |
+
| ParticleManipulator
+ Base implementation for a particle manipluator
+ |
+
| PhantomEffect
+ An effect that can be played
+ |
+
| ReflectionUtils.DataType
+ Represents an enumeration of Java data types with corresponding classes
+ |
+
| ReflectionUtils.PackageType
+ Represents an enumeration of dynamic packages of NMS and CraftBukkit
+ |
+
| VisualEffect
+ A visual effect which may be an actual effect, or a super-effect (multiple
+ sub effects) Allows you to play them simply, even though there could be
+ hundreds of meta-visual effects within a super visual effect
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Area.html b/docs/phantom/world/Area.html new file mode 100644 index 000000000..d9d4ef547 --- /dev/null +++ b/docs/phantom/world/Area.html @@ -0,0 +1,610 @@ + + + + + + +public class Area +extends Object+
| Constructor and Description | +
|---|
Area(org.bukkit.Location location,
+ Double radius)
+Used to instantiate a new "area" in which you can check if entities are
+ within this area.
+ |
+
Area(org.bukkit.Location location,
+ Integer radius)
+Used to instantiate a new "area" in which you can check if entities are
+ within this area.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Double |
+distance(org.bukkit.Location location)
+Calculate the ESTIMATED distance from the center of this
+ area, to the given location WARNING: This uses newton's method,
+ be careful on how accurate you need this.
+ |
+
org.bukkit.Location |
+getLocation()
+Get the defined center location
+ |
+
org.bukkit.entity.Entity[] |
+getNearbyEntities()
+Get ALL entities within the area.
+ |
+
org.bukkit.entity.Entity[] |
+getNearbyEntities(Class<? extends org.bukkit.entity.Entity> entityClass)
+Get nearby entities which match the following class
+ |
+
org.bukkit.entity.Entity[] |
+getNearbyEntities(org.bukkit.entity.EntityType type)
+Get all nearby entities matching the given entity type
+ |
+
org.bukkit.entity.Player[] |
+getNearbyPlayers()
+Get all players within the area.
+ |
+
Double |
+getRadius()
+Gets the area's radius
+ |
+
boolean |
+hasEntities()
+But does it have any entities?
+ |
+
boolean |
+isWithin(org.bukkit.Location location)
+Check to see weather a location is within the area
+ |
+
org.bukkit.Location |
+random()
+Pick a random location in this radius
+ |
+
void |
+setLocation(org.bukkit.Location location)
+Set the defined center location
+ |
+
void |
+setRadius(Double radius)
+Set the area's radius
+ |
+
Double |
+slowDistance(org.bukkit.Location location)
+Calculate the EXACT distance from the center of this
+ area, to the given location WARNING: This uses the sqrt function,
+ be careful on how heavy you call this.
+ |
+
Cuboid |
+toCuboid() |
+
static boolean |
+within(org.bukkit.Location center,
+ org.bukkit.Location target,
+ double rad) |
+
public Area(org.bukkit.Location location, + Double radius)+
location - The center location of the arearadius - The radius used as a double.public Area(org.bukkit.Location location, + Integer radius)+
location - The center location of the arearadius - The radius used as an int.public static boolean within(org.bukkit.Location center, + org.bukkit.Location target, + double rad)+
public Cuboid toCuboid()+
public Double distance(org.bukkit.Location location)+
location - The given location to calculate a distance from the center.public Double slowDistance(org.bukkit.Location location)+
location - The given location to calculate a distance from the center.public boolean isWithin(org.bukkit.Location location)+
location - The location to measure from the center.public boolean hasEntities()+
public org.bukkit.entity.Entity[] getNearbyEntities(org.bukkit.entity.EntityType type)+
type - the entity typepublic org.bukkit.entity.Entity[] getNearbyEntities(Class<? extends org.bukkit.entity.Entity> entityClass)+
entityClass - the entity classpublic org.bukkit.entity.Entity[] getNearbyEntities()+
public org.bukkit.entity.Player[] getNearbyPlayers()+
public org.bukkit.Location getLocation()+
public void setLocation(org.bukkit.Location location)+
location - The new location to be setpublic Double getRadius()+
public void setRadius(Double radius)+
radius - The new radius to be setpublic org.bukkit.Location random()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/BlastResistance.html b/docs/phantom/world/BlastResistance.html new file mode 100644 index 000000000..b08c3b7b7 --- /dev/null +++ b/docs/phantom/world/BlastResistance.html @@ -0,0 +1,2126 @@ + + + + + + +public enum BlastResistance +extends Enum<BlastResistance>+
| Modifier and Type | +Method and Description | +
|---|---|
static int |
+get(org.bukkit.Material m) |
+
int |
+getBlastResistance() |
+
static BlastResistance |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static BlastResistance[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final BlastResistance BARRIER+
public static final BlastResistance BEDROCK+
public static final BlastResistance COMMAND+
public static final BlastResistance ENDER_PORTAL+
public static final BlastResistance ENDER_PORTAL_FRAME+
public static final BlastResistance ANVIL+
public static final BlastResistance ENCHANTMENT_TABLE+
public static final BlastResistance OBSIDIAN+
public static final BlastResistance ENDER_CHEST+
public static final BlastResistance WATER+
public static final BlastResistance LAVA+
public static final BlastResistance STATIONARY_WATER+
public static final BlastResistance DRAGON_EGG+
public static final BlastResistance ENDER_STONE+
public static final BlastResistance COAL_BLOCK+
public static final BlastResistance DIAMOND_BLOCK+
public static final BlastResistance EMERALD_BLOCK+
public static final BlastResistance GOLD_BLOCK+
public static final BlastResistance IRON_BLOCK+
public static final BlastResistance REDSTONE_BLOCK+
public static final BlastResistance BRICK+
public static final BlastResistance BRICK_STAIRS+
public static final BlastResistance HARD_CLAY+
public static final BlastResistance STONE+
public static final BlastResistance SMOOTH_BRICK+
public static final BlastResistance SMOOTH_STAIRS+
public static final BlastResistance DOUBLE_STONE_SLAB2+
public static final BlastResistance STONE_SLAB2+
public static final BlastResistance IRON_DOOR+
public static final BlastResistance IRON_DOOR_BLOCK+
public static final BlastResistance IRON_TRAPDOOR+
public static final BlastResistance MOB_SPAWNER+
public static final BlastResistance WEB+
public static final BlastResistance DISPENSER+
public static final BlastResistance DROPPER+
public static final BlastResistance FURNACE+
public static final BlastResistance BURNING_FURNACE+
public static final BlastResistance BEACON+
public static final BlastResistance COAL_ORE+
public static final BlastResistance COCOA+
public static final BlastResistance DIAMOND_ORE+
public static final BlastResistance EMERALD_ORE+
public static final BlastResistance FENCE+
public static final BlastResistance FENCE_GATE+
public static final BlastResistance ACACIA_FENCE_GATE+
public static final BlastResistance BIRCH_FENCE_GATE+
public static final BlastResistance DARK_OAK_FENCE_GATE+
public static final BlastResistance SPRUCE_FENCE_GATE+
public static final BlastResistance JUNGLE_FENCE_GATE+
public static final BlastResistance ACACIA_FENCE+
public static final BlastResistance BIRCH_FENCE+
public static final BlastResistance DARK_OAK_FENCE+
public static final BlastResistance SPRUCE_FENCE+
public static final BlastResistance JUNGLE_FENCE+
public static final BlastResistance ACACIA_WOOD_STAIRS+
public static final BlastResistance BIRCH_WOOD_STAIRS+
public static final BlastResistance DARK_OAK_WOOD_STAIRS+
public static final BlastResistance SPRUCE_WOOD_STAIRS+
public static final BlastResistance JUNGLE_WOOD_STAIRS+
public static final BlastResistance QUARTZ_STAIRS+
public static final BlastResistance COBBLESTONE_STAIRS+
public static final BlastResistance SANDSTONE_STAIRS+
public static final BlastResistance NETHER_BRICK_STAIRS+
public static final BlastResistance WOOD_STAIRS+
public static final BlastResistance RED_SANDSTONE_STAIRS+
public static final BlastResistance ACACIA_DOOR+
public static final BlastResistance BIRCH_DOOR+
public static final BlastResistance DARK_OAK_DOOR+
public static final BlastResistance SPRUCE_DOOR+
public static final BlastResistance JUNGLE_DOOR+
public static final BlastResistance GOLD_ORE+
public static final BlastResistance HOPPER+
public static final BlastResistance IRON_ORE+
public static final BlastResistance LAPIS_BLOCK+
public static final BlastResistance LAPIS_ORE+
public static final BlastResistance QUARTZ_ORE+
public static final BlastResistance REDSTONE_ORE+
public static final BlastResistance TRAP_DOOR+
public static final BlastResistance WOOD+
public static final BlastResistance CHEST+
public static final BlastResistance TRAPPED_CHEST+
public static final BlastResistance WORKBENCH+
public static final BlastResistance CAULDRON+
public static final BlastResistance LOG+
public static final BlastResistance LOG_2+
public static final BlastResistance BOOKSHELF+
public static final BlastResistance BANNER+
public static final BlastResistance STANDING_BANNER+
public static final BlastResistance WALL_BANNER+
public static final BlastResistance JACK_O_LANTERN+
public static final BlastResistance MELON_BLOCK+
public static final BlastResistance SKULL+
public static final BlastResistance PUMPKIN+
public static final BlastResistance SIGN+
public static final BlastResistance SIGN_POST+
public static final BlastResistance WALL_SIGN+
public static final BlastResistance QUARTZ_BLOCK+
public static final BlastResistance NOTE_BLOCK+
public static final BlastResistance RED_SANDSTONE+
public static final BlastResistance SANDSTONE+
public static final BlastResistance WOOL+
public static final BlastResistance MONSTER_EGG+
public static final BlastResistance RAILS+
public static final BlastResistance ACTIVATOR_RAIL+
public static final BlastResistance DETECTOR_RAIL+
public static final BlastResistance POWERED_RAIL+
public static final BlastResistance CLAY+
public static final BlastResistance DIRT+
public static final BlastResistance GRASS+
public static final BlastResistance GRAVEL+
public static final BlastResistance SPONGE+
public static final BlastResistance BREWING_STAND+
public static final BlastResistance STONE_BUTTON+
public static final BlastResistance WOOD_BUTTON+
public static final BlastResistance CAKE_BLOCK+
public static final BlastResistance ICE+
public static final BlastResistance PACKED_ICE+
public static final BlastResistance LEVER+
public static final BlastResistance MYCEL+
public static final BlastResistance PISTON_BASE+
public static final BlastResistance PISTON_EXTENSION+
public static final BlastResistance PISTON_MOVING_PIECE+
public static final BlastResistance PISTON_STICKY_BASE+
public static final BlastResistance GOLD_PLATE+
public static final BlastResistance IRON_PLATE+
public static final BlastResistance STONE_PLATE+
public static final BlastResistance WOOD_PLATE+
public static final BlastResistance SAND+
public static final BlastResistance SOUL_SAND+
public static final BlastResistance CACTUS+
public static final BlastResistance LADDER+
public static final BlastResistance NETHERRACK+
public static final BlastResistance GLASS+
public static final BlastResistance THIN_GLASS+
public static final BlastResistance STAINED_GLASS+
public static final BlastResistance STAINED_GLASS_PANE+
public static final BlastResistance GLOWSTONE+
public static final BlastResistance REDSTONE_LAMP_OFF+
public static final BlastResistance REDSTONE_LAMP_ON+
public static final BlastResistance SEA_LANTERN+
public static final BlastResistance BED_BLOCK+
public static final BlastResistance DAYLIGHT_DETECTOR+
public static final BlastResistance DAYLIGHT_DETECTOR_INVERTED+
public static final BlastResistance HUGE_MUSHROOM_1+
public static final BlastResistance HUGE_MUSHROOM_2+
public static final BlastResistance LEAVES+
public static final BlastResistance LEAVES_2+
public static final BlastResistance SNOW+
public static BlastResistance[] values()+
+for (BlastResistance c : BlastResistance.values()) + System.out.println(c); +
public static BlastResistance valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic int getBlastResistance()+
public static int get(org.bukkit.Material m)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Blocks.html b/docs/phantom/world/Blocks.html new file mode 100644 index 000000000..1d8531522 --- /dev/null +++ b/docs/phantom/world/Blocks.html @@ -0,0 +1,327 @@ + + + + + + +public class Blocks +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static org.bukkit.Location |
+getCenter(org.bukkit.block.Block block)
+Get the center of the block
+ |
+
static void |
+update(org.bukkit.block.Block block)
+Update the block physics
+ |
+
static void |
+updateAround(org.bukkit.block.Block block)
+Update the block and the facing blocks (7 updates)
+ |
+
public static org.bukkit.Location getCenter(org.bukkit.block.Block block)+
block - the blockpublic static void update(org.bukkit.block.Block block)+
block - the blockpublic static void updateAround(org.bukkit.block.Block block)+
block - the blockCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Chunklet.html b/docs/phantom/world/Chunklet.html new file mode 100644 index 000000000..543e62d91 --- /dev/null +++ b/docs/phantom/world/Chunklet.html @@ -0,0 +1,791 @@ + + + + + + +public class Chunklet +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected org.bukkit.World |
+world |
+
protected int |
+x |
+
protected int |
+z |
+
| Constructor and Description | +
|---|
Chunklet(int x,
+ int z,
+ org.bukkit.World world)
+Create a new chunklet
+ |
+
Chunklet(org.bukkit.Location location)
+Create a new chunklet from the current location
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+contains(org.bukkit.Chunk chunk)
+Does this chunklet contain?
+ |
+
boolean |
+contains(org.bukkit.Location l)
+Does this chunklet contain?
+ |
+
boolean |
+contains(org.bukkit.entity.Player p)
+Does this chunklet contain?
+ |
+
boolean |
+equals(Object object) |
+
GList<org.bukkit.Location> |
+getBorder(int level,
+ Direction d)
+Get a strip line of an edge of this chunklet
+ |
+
org.bukkit.Chunk |
+getChunk()
+Get the chunk this chunklet resides in
+ |
+
GList<Chunklet> |
+getCircle(int radius)
+Get a circle of chunklets
+ |
+
GList<org.bukkit.entity.Entity> |
+getEntities()
+Get entities in this chunklet
+ |
+
org.bukkit.Location |
+getMax()
+Get the max corner of this chunklet
+ |
+
org.bukkit.Location |
+getMin()
+Get the min corner of this chunklet
+ |
+
GList<Chunklet> |
+getNeighbors()
+Get all chunklet neighbors
+ |
+
GList<org.bukkit.entity.Player> |
+getPlayers()
+Get all players inside this chunklet
+ |
+
Chunklet |
+getRelative(Direction d)
+Get the relative chunklet based on direction
+ |
+
org.bukkit.World |
+getWorld()
+Get the world this chunklet resides in
+ |
+
int |
+getX()
+Get the x chunklet coord
+ |
+
int |
+getZ()
+Get the z coord
+ |
+
GList<Chunklet> |
+inThisChunk()
+Get all the chunklets in the chunk that this chunklet resides
+ |
+
Iterator<org.bukkit.block.Block> |
+iterator()
+Get an iterator of blocks from this chunklet
+ |
+
void |
+setWorld(org.bukkit.World world)
+Set the world of this chunklet
+ |
+
void |
+setX(int x)
+Set the chunklet x coord
+ |
+
void |
+setZ(int z)
+Set the z coord
+ |
+
protected int x+
protected int z+
protected org.bukkit.World world+
public Chunklet(int x, + int z, + org.bukkit.World world)+
x - the x coordz - the z coordworld - the worldpublic Chunklet(org.bukkit.Location location)+
location - the given locationpublic GList<Chunklet> inThisChunk()+
public GList<org.bukkit.entity.Player> getPlayers()+
public GList<org.bukkit.entity.Entity> getEntities()+
public org.bukkit.Chunk getChunk()+
public boolean contains(org.bukkit.Location l)+
l - the objectpublic boolean contains(org.bukkit.entity.Player p)+
p - the objectpublic boolean contains(org.bukkit.Chunk chunk)+
chunk - the objectpublic org.bukkit.Location getMin()+
public org.bukkit.Location getMax()+
public Iterator<org.bukkit.block.Block> iterator()+
public Chunklet getRelative(Direction d)+
d - the directionpublic GList<Chunklet> getNeighbors()+
public GList<Chunklet> getCircle(int radius)+
radius - the chunklet radiuspublic GList<org.bukkit.Location> getBorder(int level, + Direction d)+
level - the leveld - the direction (face)public int getX()+
public void setX(int x)+
x - the x coordpublic int getZ()+
public void setZ(int z)+
z - the chunklet z coordpublic org.bukkit.World getWorld()+
public void setWorld(org.bukkit.World world)+
world - the worldCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/ChunkletMesh.html b/docs/phantom/world/ChunkletMesh.html new file mode 100644 index 000000000..151128916 --- /dev/null +++ b/docs/phantom/world/ChunkletMesh.html @@ -0,0 +1,434 @@ + + + + + + +public class ChunkletMesh +extends Object+
| Constructor and Description | +
|---|
ChunkletMesh(org.bukkit.World world)
+Create a chunklet mesh for fast reading
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(Chunklet c)
+Add a chunklet to the mesh and rebuild the reference list
+ |
+
boolean |
+contains(org.bukkit.entity.Entity e)
+Check if this mesh contains an entity based on location
+ |
+
boolean |
+contains(org.bukkit.Location l)
+Check if this mesh contains a location
+ |
+
boolean |
+contains(org.bukkit.entity.Player p)
+Check if this mesh contains a player based on location
+ |
+
GList<Chunklet> |
+getChunklets()
+Get all chunklets from the rebuilt reference
+ |
+
GList<org.bukkit.entity.Entity> |
+getEntities()
+Get a list of all the entities in the given chunklet mesh
+ |
+
GList<org.bukkit.entity.Player> |
+getPlayers()
+Get a list of all the players in the given chunklet mesh
+ |
+
void |
+rebuildReferences()
+Rebuilds the list of chunklets from the map reference
+ |
+
public ChunkletMesh(org.bukkit.World world)+
world - the worldpublic void rebuildReferences()+
public GList<Chunklet> getChunklets()+
public boolean contains(org.bukkit.Location l)+
l - the locationpublic boolean contains(org.bukkit.entity.Player p)+
p - the playerpublic boolean contains(org.bukkit.entity.Entity e)+
e - the entitypublic GList<org.bukkit.entity.Player> getPlayers()+
public GList<org.bukkit.entity.Entity> getEntities()+
public void add(Chunklet c)+
c - the chunkletCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Chunks.html b/docs/phantom/world/Chunks.html new file mode 100644 index 000000000..3d141b3a7 --- /dev/null +++ b/docs/phantom/world/Chunks.html @@ -0,0 +1,559 @@ + + + + + + +public class Chunks +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static GList<org.bukkit.Chunk> |
+getLoadedChunks()
+Get all loaded chunks in all worlds
+ |
+
static GList<org.bukkit.Chunk> |
+getLoadedChunks(org.bukkit.World world)
+Get all loaded chunks in the world
+ |
+
static GList<org.bukkit.Chunk> |
+getRadius(org.bukkit.Chunk center,
+ int radius)
+Get chunks in a radius
+ |
+
static boolean |
+isLoaded(String world,
+ int x,
+ int z)
+Is the given chunk loaded?
+ |
+
static boolean |
+isLoaded(org.bukkit.World world,
+ int x,
+ int z)
+Is the given chunk loaded?
+ |
+
static void |
+load(GList<org.bukkit.Chunk> chunks)
+Load all chunks
+ |
+
static boolean |
+unload(org.bukkit.Chunk chunk)
+Unload the given chunk
+ |
+
static boolean |
+unload(org.bukkit.Chunk chunk,
+ boolean save)
+Unload the given chunk
+ |
+
static boolean |
+unload(org.bukkit.Chunk chunk,
+ boolean save,
+ boolean safe)
+Unload the given chunk
+ |
+
static int |
+unload(GList<org.bukkit.Chunk> chunks)
+Unload all given chunks
+ |
+
static int |
+unload(GList<org.bukkit.Chunk> chunks,
+ boolean save)
+Unload all given chunks
+ |
+
static int |
+unload(GList<org.bukkit.Chunk> chunks,
+ boolean save,
+ boolean safe)
+Unload all given chunks
+ |
+
public static GList<org.bukkit.Chunk> getLoadedChunks(org.bukkit.World world)+
world - the given worldpublic static GList<org.bukkit.Chunk> getLoadedChunks()+
public static GList<org.bukkit.Chunk> getRadius(org.bukkit.Chunk center, + int radius)+
center - the center chunkradius - the radiuspublic static boolean unload(org.bukkit.Chunk chunk, + boolean save, + boolean safe)+
chunk - the chunksave - should this chunk be savedsafe - if set to true, the chunk will not be unloaded if players are
+ nearbypublic static boolean unload(org.bukkit.Chunk chunk, + boolean save)+
chunk - the chunksave - should this chunk be saved?public static boolean unload(org.bukkit.Chunk chunk)+
chunk - the chunkpublic static int unload(GList<org.bukkit.Chunk> chunks, + boolean save, + boolean safe)+
chunks - the chunks to unloadsave - should these chunks be saved?safe - should we ignore chunks with players nearby?public static int unload(GList<org.bukkit.Chunk> chunks, + boolean save)+
chunks - the chunks to unloadsave - should these chunks be saved?public static int unload(GList<org.bukkit.Chunk> chunks)+
chunks - the chunks to unloadpublic static boolean isLoaded(String world, + int x, + int z)+
world - the worldx - the xz - the zpublic static boolean isLoaded(org.bukkit.World world, + int x, + int z)+
world - the worldx - the xz - the zpublic static void load(GList<org.bukkit.Chunk> chunks)+
chunks - the chunksCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Cuboid.CuboidDirection.html b/docs/phantom/world/Cuboid.CuboidDirection.html new file mode 100644 index 000000000..e7936092b --- /dev/null +++ b/docs/phantom/world/Cuboid.CuboidDirection.html @@ -0,0 +1,456 @@ + + + + + + +public static enum Cuboid.CuboidDirection +extends Enum<Cuboid.CuboidDirection>+
| Enum Constant and Description | +
|---|
Both |
+
Down |
+
East |
+
Horizontal |
+
North |
+
South |
+
Unknown |
+
Up |
+
Vertical |
+
West |
+
| Modifier and Type | +Method and Description | +
|---|---|
Cuboid.CuboidDirection |
+opposite() |
+
static Cuboid.CuboidDirection |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Cuboid.CuboidDirection[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Cuboid.CuboidDirection North+
public static final Cuboid.CuboidDirection East+
public static final Cuboid.CuboidDirection South+
public static final Cuboid.CuboidDirection West+
public static final Cuboid.CuboidDirection Up+
public static final Cuboid.CuboidDirection Down+
public static final Cuboid.CuboidDirection Horizontal+
public static final Cuboid.CuboidDirection Vertical+
public static final Cuboid.CuboidDirection Both+
public static final Cuboid.CuboidDirection Unknown+
public static Cuboid.CuboidDirection[] values()+
+for (Cuboid.CuboidDirection c : Cuboid.CuboidDirection.values()) + System.out.println(c); +
public static Cuboid.CuboidDirection valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Cuboid.CuboidDirection opposite()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Cuboid.CuboidIterator.html b/docs/phantom/world/Cuboid.CuboidIterator.html new file mode 100644 index 000000000..8c863ea99 --- /dev/null +++ b/docs/phantom/world/Cuboid.CuboidIterator.html @@ -0,0 +1,339 @@ + + + + + + +| Constructor and Description | +
|---|
CuboidIterator(org.bukkit.World w,
+ int x1,
+ int y1,
+ int z1,
+ int x2,
+ int y2,
+ int z2) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+hasNext() |
+
org.bukkit.block.Block |
+next() |
+
void |
+remove() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitforEachRemainingpublic CuboidIterator(org.bukkit.World w, + int x1, + int y1, + int z1, + int x2, + int y2, + int z2)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Cuboid.html b/docs/phantom/world/Cuboid.html new file mode 100644 index 000000000..5e106a693 --- /dev/null +++ b/docs/phantom/world/Cuboid.html @@ -0,0 +1,1371 @@ + + + + + + +public class Cuboid +extends Object +implements Iterable<org.bukkit.block.Block>, Cloneable, org.bukkit.configuration.serialization.ConfigurationSerializable+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+Cuboid.CuboidDirection |
+
class |
+Cuboid.CuboidIterator |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+worldName |
+
protected int |
+x1 |
+
protected int |
+x2 |
+
protected int |
+y1 |
+
protected int |
+y2 |
+
protected int |
+z1 |
+
protected int |
+z2 |
+
| Constructor and Description | +
|---|
Cuboid(Cuboid other)
+Copy constructor.
+ |
+
Cuboid(org.bukkit.Location l1)
+Construct a one-block Cuboid at the given Location of the Cuboid.
+ |
+
Cuboid(org.bukkit.Location l1,
+ org.bukkit.Location l2)
+Construct a Cuboid given two Location objects which represent any two corners
+ of the Cuboid.
+ |
+
Cuboid(Map<String,Object> map) |
+
Cuboid(org.bukkit.World world,
+ int x1,
+ int y1,
+ int z1,
+ int x2,
+ int y2,
+ int z2)
+Construct a Cuboid in the given World and xyz co-ordinates
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
byte |
+averageLightLevel()
+Get the average light level of all empty (air) blocks in the Cuboid.
+ |
+
Cuboid |
+clone() |
+
boolean |
+contains(org.bukkit.block.Block b)
+Check if the given Block is contained within this Cuboid.
+ |
+
boolean |
+contains(int x,
+ int y,
+ int z)
+Return true if the point at (x,y,z) is contained within this Cuboid.
+ |
+
boolean |
+contains(org.bukkit.Location l)
+Check if the given Location is contained within this Cuboid.
+ |
+
boolean |
+containsOnly(org.bukkit.Material material)
+Check if the Cuboid contains only blocks of the given type
+ |
+
Cuboid |
+contract()
+Contract the Cuboid, returning a Cuboid with any air around the edges
+ removed, just large enough to include all non-air blocks.
+ |
+
Cuboid |
+contract(Cuboid.CuboidDirection dir)
+Contract the Cuboid in the given direction, returning a new Cuboid which has
+ no exterior empty space.
+ |
+
org.bukkit.block.Block[] |
+corners()
+Get the Blocks at the eight corners of the Cuboid.
+ |
+
Cuboid |
+expand(Cuboid.CuboidDirection dir,
+ int amount)
+Expand the Cuboid in the given direction by the given amount.
+ |
+
void |
+fill(int blockId,
+ byte data)
+Deprecated.
+
+use
+#fill(MaterialData, MassBlockUpdate) |
+
Cuboid |
+flatten(int level) |
+
Cuboid |
+getBoundingCuboid(Cuboid other)
+Get the Cuboid big enough to hold both this Cuboid and the given one.
+ |
+
org.bukkit.Location |
+getCenter()
+Get the the centre of the Cuboid
+ |
+
List<org.bukkit.Chunk> |
+getChunks()
+Get a list of the chunks which are fully or partially contained in this
+ cuboid.
+ |
+
Dimension |
+getDimension()
+Get the cuboid dimensions
+ |
+
Cuboid |
+getFace(Cuboid.CuboidDirection dir)
+Get the Cuboid representing the face of this Cuboid.
+ |
+
org.bukkit.Location |
+getLowerNE()
+Get the Location of the lower northeast corner of the Cuboid (minimum XYZ
+ co-ordinates).
+ |
+
int |
+getLowerX()
+Get the minimum X co-ordinate of this Cuboid
+ |
+
int |
+getLowerY()
+Get the minimum Y co-ordinate of this Cuboid
+ |
+
int |
+getLowerZ()
+Get the minimum Z co-ordinate of this Cuboid
+ |
+
org.bukkit.block.Block |
+getRelativeBlock(int x,
+ int y,
+ int z)
+Get a block relative to the lower NE point of the Cuboid.
+ |
+
org.bukkit.block.Block |
+getRelativeBlock(org.bukkit.World w,
+ int x,
+ int y,
+ int z)
+Get a block relative to the lower NE point of the Cuboid in the given World.
+ |
+
int |
+getSizeX()
+Get the size of this Cuboid along the X axis
+ |
+
int |
+getSizeY()
+Get the size of this Cuboid along the Y axis
+ |
+
int |
+getSizeZ()
+Get the size of this Cuboid along the Z axis
+ |
+
org.bukkit.Location |
+getUpperSW()
+Get the Location of the upper southwest corner of the Cuboid (maximum XYZ
+ co-ordinates).
+ |
+
int |
+getUpperX()
+Get the maximum X co-ordinate of this Cuboid
+ |
+
int |
+getUpperY()
+Get the maximum Y co-ordinate of this Cuboid
+ |
+
int |
+getUpperZ()
+Get the maximum Z co-ordinate of this Cuboid
+ |
+
org.bukkit.World |
+getWorld()
+Get the Cuboid's world.
+ |
+
Cuboid |
+inset(Cuboid.CuboidDirection dir,
+ int amount)
+Inset (shrink) the Cuboid in the given direction by the given amount.
+ |
+
Iterator<org.bukkit.block.Block> |
+iterator()
+Reset the light level of all blocks within this Cuboid.
+ |
+
Cuboid |
+outset(Cuboid.CuboidDirection dir,
+ int amount)
+Outset (grow) the Cuboid in the given direction by the given amount.
+ |
+
Map<String,Object> |
+serialize() |
+
void |
+set(org.bukkit.Location l1,
+ org.bukkit.Location l2)
+Set the locations
+ |
+
Cuboid |
+shift(Cuboid.CuboidDirection dir,
+ int amount)
+Shift the Cuboid in the given direction by the given amount.
+ |
+
String |
+toString() |
+
int |
+volume()
+Get the volume of this Cuboid.
+ |
+
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitforEach, spliteratorprotected final String worldName+
protected int x1+
protected int y1+
protected int z1+
protected int x2+
protected int y2+
protected int z2+
public Cuboid(org.bukkit.Location l1, + org.bukkit.Location l2)+
l1 - one of the cornersl2 - the other cornerpublic Cuboid(org.bukkit.Location l1)+
l1 - location of the Cuboidpublic Cuboid(Cuboid other)+
other - the Cuboid to copypublic Cuboid(org.bukkit.World world, + int x1, + int y1, + int z1, + int x2, + int y2, + int z2)+
world - the Cuboid's worldx1 - X co-ordinate of corner 1y1 - Y co-ordinate of corner 1z1 - Z co-ordinate of corner 1x2 - X co-ordinate of corner 2y2 - Y co-ordinate of corner 2z2 - Z co-ordinate of corner 2public void set(org.bukkit.Location l1, + org.bukkit.Location l2)+
l1 - al2 - bpublic Map<String,Object> serialize()+
serialize in interface org.bukkit.configuration.serialization.ConfigurationSerializablepublic Cuboid flatten(int level)+
public org.bukkit.Location getLowerNE()+
public org.bukkit.Location getUpperSW()+
public org.bukkit.Location getCenter()+
public org.bukkit.World getWorld()+
IllegalStateException - if the world is not loadedpublic int getSizeX()+
public int getSizeY()+
public int getSizeZ()+
public Dimension getDimension()+
public int getLowerX()+
public int getLowerY()+
public int getLowerZ()+
public int getUpperX()+
public int getUpperY()+
public int getUpperZ()+
public org.bukkit.block.Block[] corners()+
public Cuboid expand(Cuboid.CuboidDirection dir, + int amount)+
dir - the direction in which to expandamount - the number of blocks by which to expandpublic Cuboid shift(Cuboid.CuboidDirection dir, + int amount)+
dir - the direction in which to shiftamount - the number of blocks by which to shiftpublic Cuboid outset(Cuboid.CuboidDirection dir, + int amount)+
dir - the direction in which to outset (must be Horizontal, Vertical, or
+ Both)amount - the number of blocks by which to outsetpublic Cuboid inset(Cuboid.CuboidDirection dir, + int amount)+
dir - the direction in which to inset (must be Horizontal, Vertical, or
+ Both)amount - the number of blocks by which to insetpublic boolean contains(int x, + int y, + int z)+
x - the X co-ordinatey - the Y co-ordinatez - the Z co-ordinatepublic boolean contains(org.bukkit.block.Block b)+
b - the Block to check forpublic boolean contains(org.bukkit.Location l)+
l - the Location to check forpublic int volume()+
public byte averageLightLevel()+
public Cuboid contract()+
public Cuboid contract(Cuboid.CuboidDirection dir)+
dir - the direction in which to contractpublic Cuboid getFace(Cuboid.CuboidDirection dir)+
dir - which face of the Cuboid to getpublic boolean containsOnly(org.bukkit.Material material)+
material - the material to check forpublic Cuboid getBoundingCuboid(Cuboid other)+
other - the other Cuboid to includepublic org.bukkit.block.Block getRelativeBlock(int x, + int y, + int z)+
x - the X co-ordinatey - the Y co-ordinatez - the Z co-ordinatepublic org.bukkit.block.Block getRelativeBlock(org.bukkit.World w, + int x, + int y, + int z)+
w - the Worldx - the X co-ordinatey - the Y co-ordinatez - the Z co-ordinatepublic List<org.bukkit.Chunk> getChunks()+
@Deprecated +public void fill(int blockId, + byte data)+
#fill(MaterialData, MassBlockUpdate)blockId - the block IDdata - the block datapublic Iterator<org.bukkit.block.Block> iterator()+
public Cuboid clone() + throws CloneNotSupportedException+
clone in class ObjectCloneNotSupportedExceptionCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/CuboidException.html b/docs/phantom/world/CuboidException.html new file mode 100644 index 000000000..c49611c92 --- /dev/null +++ b/docs/phantom/world/CuboidException.html @@ -0,0 +1,267 @@ + + + + + + +public class CuboidException +extends Exception+
| Constructor and Description | +
|---|
CuboidException(String string) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Dimension.html b/docs/phantom/world/Dimension.html new file mode 100644 index 000000000..bd5ac6b59 --- /dev/null +++ b/docs/phantom/world/Dimension.html @@ -0,0 +1,361 @@ + + + + + + +public class Dimension +extends Object+
| Constructor and Description | +
|---|
Dimension(int width,
+ int height)
+Make a dimension
+ |
+
Dimension(int width,
+ int height,
+ int depth)
+Make a dimension
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getDepth() |
+
int |
+getHeight() |
+
DimensionFace |
+getPane()
+Get the direction of the flat part of this dimension (null if no thin
+ face)
+ |
+
int |
+getWidth() |
+
public Dimension(int width, + int height, + int depth)+
width - width of this (X)height - the height (Y)depth - the depth (Z)public Dimension(int width, + int height)+
width - width of this (X)height - the height (Y)public DimensionFace getPane()+
public int getWidth()+
public int getHeight()+
public int getDepth()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/DimensionFace.html b/docs/phantom/world/DimensionFace.html new file mode 100644 index 000000000..45fd1a77d --- /dev/null +++ b/docs/phantom/world/DimensionFace.html @@ -0,0 +1,369 @@ + + + + + + +public enum DimensionFace +extends Enum<DimensionFace>+
| Enum Constant and Description | +
|---|
X
+The X dimension (width)
+ |
+
Y
+The Y dimension (height)
+ |
+
Z
+The Z dimension (depth)
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static DimensionFace |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static DimensionFace[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final DimensionFace X+
public static final DimensionFace Y+
public static final DimensionFace Z+
public static DimensionFace[] values()+
+for (DimensionFace c : DimensionFace.values()) + System.out.println(c); +
public static DimensionFace valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/Direction.html b/docs/phantom/world/Direction.html new file mode 100644 index 000000000..87b52f42d --- /dev/null +++ b/docs/phantom/world/Direction.html @@ -0,0 +1,519 @@ + + + + + + +public enum Direction +extends Enum<Direction>+
| Enum Constant and Description | +
|---|
D |
+
E |
+
N |
+
S |
+
U |
+
W |
+
| Modifier and Type | +Method and Description | +
|---|---|
byte |
+byteValue()
+Get the byte value represented in some directional blocks
+ |
+
Cuboid.CuboidDirection |
+f() |
+
static Direction |
+fromByte(byte b)
+Get the directional value from the given byte from common directional blocks
+ (MUST BE BETWEEN 0 and 5 INCLUSIVE)
+ |
+
static GList<Direction> |
+news() |
+
static GList<Direction> |
+udnews() |
+
static Direction |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Direction[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
int |
+x() |
+
int |
+y() |
+
int |
+z() |
+
public static final Direction U+
public static final Direction D+
public static final Direction N+
public static final Direction S+
public static final Direction E+
public static final Direction W+
public static Direction[] values()+
+for (Direction c : Direction.values()) + System.out.println(c); +
public static Direction valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic int x()+
public int y()+
public int z()+
public Cuboid.CuboidDirection f()+
public static Direction fromByte(byte b)+
b - the bytepublic byte byteValue()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/MaterialBlock.html b/docs/phantom/world/MaterialBlock.html new file mode 100644 index 000000000..ada3edd8a --- /dev/null +++ b/docs/phantom/world/MaterialBlock.html @@ -0,0 +1,414 @@ + + + + + + +public class MaterialBlock +extends Object+
| Constructor and Description | +
|---|
MaterialBlock() |
+
MaterialBlock(org.bukkit.Location location) |
+
MaterialBlock(org.bukkit.Material material) |
+
MaterialBlock(org.bukkit.Material material,
+ Byte data)
+Create a materialblock
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
Byte |
+getData() |
+
org.bukkit.Material |
+getMaterial() |
+
int |
+hashCode() |
+
void |
+setData(Byte data) |
+
void |
+setMaterial(org.bukkit.Material material) |
+
String |
+toString() |
+
public MaterialBlock(org.bukkit.Material material, + Byte data)+
material - the materialdata - the datapublic MaterialBlock(org.bukkit.Material material)+
public MaterialBlock(org.bukkit.Location location)+
public MaterialBlock()+
public org.bukkit.Material getMaterial()+
public void setMaterial(org.bukkit.Material material)+
public Byte getData()+
public void setData(Byte data)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/PE.html b/docs/phantom/world/PE.html new file mode 100644 index 000000000..9e440a2ff --- /dev/null +++ b/docs/phantom/world/PE.html @@ -0,0 +1,1002 @@ + + + + + + +public class PE
+extends org.bukkit.potion.PotionEffect
+| Modifier and Type | +Field and Description | +
|---|---|
static PE |
+ABSORPTION |
+
static PE |
+BLINDNESS |
+
static PE |
+CONFUSION |
+
static PE |
+DAMAGE_RESISTANCE |
+
static PE |
+FAST_DIGGING |
+
static PE |
+FIRE_RESISTANCE |
+
static PE |
+GLOWING |
+
static PE |
+HARM |
+
static PE |
+HEAL |
+
static PE |
+HEALTH_BOOST |
+
static PE |
+HUNGER |
+
static PE |
+INCREASE_DAMAGE |
+
static PE |
+INVISIBILITY |
+
static PE |
+JUMP |
+
static PE |
+LEVITATION |
+
static PE |
+LUCK |
+
static PE |
+NIGHT_VISION |
+
static PE |
+POISON |
+
static PE |
+REGENERATION |
+
static PE |
+SATURATION |
+
static PE |
+SLOW |
+
static PE |
+SLOW_DIGGING |
+
static PE |
+SPEED |
+
static PE |
+UNLUCK |
+
static PE |
+WATER_BREATHING |
+
static PE |
+WEAKNESS |
+
static PE |
+WITHER |
+
| Constructor and Description | +
|---|
PE(Map<String,Object> map) |
+
PE(org.bukkit.potion.PotionEffectType type,
+ int duration,
+ int amplifier) |
+
PE(org.bukkit.potion.PotionEffectType type,
+ int duration,
+ int amplifier,
+ boolean ambient) |
+
PE(org.bukkit.potion.PotionEffectType type,
+ int duration,
+ int amplifier,
+ boolean ambient,
+ boolean particles) |
+
| Modifier and Type | +Method and Description | +
|---|---|
PE |
+a(int amp)
+Set the potion amp
+ |
+
boolean |
+apply(org.bukkit.entity.LivingEntity entity) |
+
org.bukkit.potion.PotionEffect |
+c()
+Create the effect
+ |
+
void |
+c(org.bukkit.entity.LivingEntity l)
+Apply an effect to a player/entity
+ |
+
void |
+crm(org.bukkit.entity.LivingEntity l) |
+
PE |
+d(int duration)
+Set the potion duration
+ |
+
static PE |
+defaulted(org.bukkit.potion.PotionEffectType type) |
+
boolean |
+equals(Object obj) |
+
int |
+getAmplifier() |
+
int |
+getDuration() |
+
org.bukkit.potion.PotionEffectType |
+getType() |
+
int |
+hashCode() |
+
boolean |
+hasParticles() |
+
boolean |
+isAmbient() |
+
void |
+rm(org.bukkit.entity.LivingEntity l) |
+
Map<String,Object> |
+serialize() |
+
String |
+toString() |
+
public static PE ABSORPTION+
public static PE BLINDNESS+
public static PE CONFUSION+
public static PE DAMAGE_RESISTANCE+
public static PE FAST_DIGGING+
public static PE FIRE_RESISTANCE+
public static PE GLOWING+
public static PE HARM+
public static PE HEAL+
public static PE HEALTH_BOOST+
public static PE HUNGER+
public static PE INCREASE_DAMAGE+
public static PE INVISIBILITY+
public static PE JUMP+
public static PE LEVITATION+
public static PE LUCK+
public static PE NIGHT_VISION+
public static PE POISON+
public static PE REGENERATION+
public static PE SATURATION+
public static PE SLOW+
public static PE SLOW_DIGGING+
public static PE SPEED+
public static PE UNLUCK+
public static PE WATER_BREATHING+
public static PE WEAKNESS+
public static PE WITHER+
public PE(org.bukkit.potion.PotionEffectType type, + int duration, + int amplifier, + boolean ambient, + boolean particles)+
public PE(org.bukkit.potion.PotionEffectType type, + int duration, + int amplifier, + boolean ambient)+
public PE(org.bukkit.potion.PotionEffectType type, + int duration, + int amplifier)+
public Map<String,Object> serialize()+
serialize in interface org.bukkit.configuration.serialization.ConfigurationSerializableserialize in class org.bukkit.potion.PotionEffectpublic boolean apply(org.bukkit.entity.LivingEntity entity)+
apply in class org.bukkit.potion.PotionEffectpublic boolean equals(Object obj)+
equals in class org.bukkit.potion.PotionEffectpublic int getAmplifier()+
getAmplifier in class org.bukkit.potion.PotionEffectpublic int getDuration()+
getDuration in class org.bukkit.potion.PotionEffectpublic org.bukkit.potion.PotionEffectType getType()+
getType in class org.bukkit.potion.PotionEffectpublic boolean isAmbient()+
isAmbient in class org.bukkit.potion.PotionEffectpublic boolean hasParticles()+
hasParticles in class org.bukkit.potion.PotionEffectpublic int hashCode()+
hashCode in class org.bukkit.potion.PotionEffectpublic String toString()+
toString in class org.bukkit.potion.PotionEffectpublic static PE defaulted(org.bukkit.potion.PotionEffectType type)+
public PE d(int duration)+
duration - the durationpublic PE a(int amp)+
amp - the amppublic org.bukkit.potion.PotionEffect c()+
public void c(org.bukkit.entity.LivingEntity l)+
l - the living entitypublic void crm(org.bukkit.entity.LivingEntity l)+
public void rm(org.bukkit.entity.LivingEntity l)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/RayTrace.html b/docs/phantom/world/RayTrace.html new file mode 100644 index 000000000..1cac8eedc --- /dev/null +++ b/docs/phantom/world/RayTrace.html @@ -0,0 +1,468 @@ + + + + + + +public class RayTrace +extends Object+
| Constructor and Description | +
|---|
RayTrace(org.bukkit.Location start,
+ org.bukkit.util.Vector direction,
+ Double maxDistance,
+ Double step)
+Create a RayTrace instance to be fired with trace() and overridden with
+ onTrace(Location l)
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
org.bukkit.util.Vector |
+getDirection() |
+
Double |
+getDistanceCovered() |
+
Double |
+getMaxDistance() |
+
org.bukkit.Location |
+getStart() |
+
Double |
+getStep() |
+
void |
+onTrace(org.bukkit.Location location)
+Called each iteration in the raytrace
+ |
+
void |
+setDirection(org.bukkit.util.Vector direction) |
+
void |
+setDistanceCovered(Double distanceCovered) |
+
void |
+setMaxDistance(Double maxDistance) |
+
void |
+setStart(org.bukkit.Location start) |
+
void |
+setStep(Double step) |
+
void |
+stop()
+Stops the raytrace.
+ |
+
void |
+trace()
+Begins the raytrace operation and calls onTrace(Location l) each step
+ |
+
public RayTrace(org.bukkit.Location start, + org.bukkit.util.Vector direction, + Double maxDistance, + Double step)+
start - the starting location for this tracedirection - the direction this trace should gomaxDistance - the max distance this trace can coverstep - the step. 1 for normal. 0.5 for twice as many hits, 2 for half
+ as many.public void trace()+
public void stop()+
public void onTrace(org.bukkit.Location location)+
location - the location hitpublic org.bukkit.Location getStart()+
public void setStart(org.bukkit.Location start)+
public org.bukkit.util.Vector getDirection()+
public void setDirection(org.bukkit.util.Vector direction)+
public Double getMaxDistance()+
public void setMaxDistance(Double maxDistance)+
public Double getDistanceCovered()+
public void setDistanceCovered(Double distanceCovered)+
public Double getStep()+
public void setStep(Double step)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/SnowLevel.html b/docs/phantom/world/SnowLevel.html new file mode 100644 index 000000000..e9a7e315e --- /dev/null +++ b/docs/phantom/world/SnowLevel.html @@ -0,0 +1,312 @@ + + + + + + +public class SnowLevel +extends Object+
| Constructor and Description | +
|---|
SnowLevel(byte power)
+Create redstone power
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
byte |
+getLevel()
+Get the level of snow
+ |
+
void |
+setLevel(byte level)
+Set the snow level
+ |
+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/VariableBlock.html b/docs/phantom/world/VariableBlock.html new file mode 100644 index 000000000..bd834b1dd --- /dev/null +++ b/docs/phantom/world/VariableBlock.html @@ -0,0 +1,462 @@ + + + + + + +public class VariableBlock +extends Object+
| Constructor and Description | +
|---|
VariableBlock() |
+
VariableBlock(org.bukkit.Material material)
+Add a materialblock into this variable block
+ |
+
VariableBlock(MaterialBlock... blocks)
+Create a variable block
+ |
+
VariableBlock(org.bukkit.Material material,
+ Byte data)
+Add a materialblock into this variable block
+ |
+
VariableBlock(String data) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addBlock(MaterialBlock block)
+Add a block to the list
+ |
+
void |
+fromString(String string) |
+
GList<MaterialBlock> |
+getBlocks()
+Get all variable blocks
+ |
+
boolean |
+is(MaterialBlock block)
+Is the given block this block? Does the variable block contain this block
+ |
+
MaterialBlock |
+random() |
+
void |
+removeBlock(MaterialBlock block)
+Remove a block from the list
+ |
+
String |
+toString() |
+
public VariableBlock()+
public VariableBlock(String data)+
public VariableBlock(MaterialBlock... blocks)+
blocks - blockspublic VariableBlock(org.bukkit.Material material, + Byte data)+
material - the materialdata - the datapublic VariableBlock(org.bukkit.Material material)+
material - the materialpublic GList<MaterialBlock> getBlocks()+
public MaterialBlock random()+
public boolean is(MaterialBlock block)+
block - the given blockpublic void addBlock(MaterialBlock block)+
block - the blockpublic void removeBlock(MaterialBlock block)+
block - the blockpublic void fromString(String string)+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/VectorSchematic.html b/docs/phantom/world/VectorSchematic.html new file mode 100644 index 000000000..fc002a5c1 --- /dev/null +++ b/docs/phantom/world/VectorSchematic.html @@ -0,0 +1,428 @@ + + + + + + +public class VectorSchematic +extends Object+
| Constructor and Description | +
|---|
VectorSchematic()
+Create a vector schematic
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+clear()
+Clear the schematic
+ |
+
boolean |
+contains(MaterialBlock mb)
+Does the vector schematic's variable blocks contain the given material
+ block?
+ |
+
boolean |
+containsMultiple(MaterialBlock mb)
+Does this vector schematic contain multiple of the given material blocks
+ |
+
boolean |
+equals(Object obj) |
+
GList<org.bukkit.util.Vector> |
+find(MaterialBlock mb)
+Find all vector references that match the given material block
+ |
+
GMap<org.bukkit.util.Vector,VariableBlock> |
+getSchematic()
+Get the schematic
+ |
+
int |
+hashCode() |
+
GMap<org.bukkit.util.Vector,org.bukkit.Location> |
+match(org.bukkit.Location location)
+Match the location as part of a multiblock structure
+ |
+
public VectorSchematic()+
public boolean contains(MaterialBlock mb)+
mb - the material blockpublic boolean containsMultiple(MaterialBlock mb)+
mb - the materialblockpublic GList<org.bukkit.util.Vector> find(MaterialBlock mb)+
mb - the materialblockpublic GMap<org.bukkit.util.Vector,org.bukkit.Location> match(org.bukkit.Location location)+
location - the locationpublic GMap<org.bukkit.util.Vector,VariableBlock> getSchematic()+
public void clear()+
Copyright © 2018. All rights reserved.
+ + diff --git a/docs/phantom/world/W.html b/docs/phantom/world/W.html index 231cdaf71..a04b9b6db 100644 --- a/docs/phantom/world/W.html +++ b/docs/phantom/world/W.html @@ -2,9 +2,9 @@ - + -