Update JavaDocs
This commit is contained in:
parent
6206c437b9
commit
e2db11e181
|
@ -18,16 +18,28 @@ import net.shadowfacts.simplemultipart.util.MultipartPlacementContext;
|
||||||
* Analogous to {@link net.minecraft.item.block.BlockItem}.
|
* Analogous to {@link net.minecraft.item.block.BlockItem}.
|
||||||
*
|
*
|
||||||
* @author shadowfacts
|
* @author shadowfacts
|
||||||
* @since 0.1.0
|
* @since 0.1.1
|
||||||
*/
|
*/
|
||||||
public class MultipartItem extends Item {
|
public class MultipartItem extends Item {
|
||||||
|
|
||||||
protected Multipart part;
|
protected Multipart part;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Multipart Item for the given part with.
|
||||||
|
*
|
||||||
|
* @param part The multipart.
|
||||||
|
*/
|
||||||
public MultipartItem(Multipart part) {
|
public MultipartItem(Multipart part) {
|
||||||
this(part, new Settings());
|
this(part, new Settings());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Multipart Item for the given part with the given item settings.
|
||||||
|
*
|
||||||
|
* @param part The multipart.
|
||||||
|
* @param settings The settings for this item.
|
||||||
|
* @since 0.1.2
|
||||||
|
*/
|
||||||
public MultipartItem(Multipart part, Settings settings) {
|
public MultipartItem(Multipart part, Settings settings) {
|
||||||
super(settings);
|
super(settings);
|
||||||
this.part = part;
|
this.part = part;
|
||||||
|
|
|
@ -103,6 +103,7 @@ public abstract class Multipart {
|
||||||
* @param self The state for this part.
|
* @param self The state for this part.
|
||||||
* @param other The other part that already exists.
|
* @param other The other part that already exists.
|
||||||
* @return If the multiparts can coexist.
|
* @return If the multiparts can coexist.
|
||||||
|
* @since 0.1.2
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public boolean canIntersectWith(MultipartState self, MultipartState other) {
|
public boolean canIntersectWith(MultipartState self, MultipartState other) {
|
||||||
|
@ -164,6 +165,7 @@ public abstract class Multipart {
|
||||||
* Can be overriden, should only be called via {@link MultipartState#onPartAdded(MultipartView)}
|
* Can be overriden, should only be called via {@link MultipartState#onPartAdded(MultipartView)}
|
||||||
*
|
*
|
||||||
* @param view The view of this part.
|
* @param view The view of this part.
|
||||||
|
* @since 0.1.1
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public void onPartAdded(MultipartView view) {
|
public void onPartAdded(MultipartView view) {
|
||||||
|
@ -176,6 +178,7 @@ public abstract class Multipart {
|
||||||
*
|
*
|
||||||
* @param view The view of this part.
|
* @param view The view of this part.
|
||||||
* The multipart entity and container in this view are still present, but the part is no longer in the container.
|
* The multipart entity and container in this view are still present, but the part is no longer in the container.
|
||||||
|
* @since 0.1.1
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public void onPartRemoved(MultipartView view) {
|
public void onPartRemoved(MultipartView view) {
|
||||||
|
|
Loading…
Reference in New Issue