mirror of https://github.com/FabricMC/yarn.git
Disambiguate and document getEntities methods (#1514)
* Disambiguate and document getEntities methods * Apply suggestions from code review Co-authored-by: liach <7806504+liach@users.noreply.github.com> Co-authored-by: Yanis48 <doublecraft.official@gmail.com> * Edit param docs * Edit return docs * periods are terrible * Apply suggestions from code review Changes to some parameter docs to reflect method naming. Co-authored-by: i509VCB <i509vcb@gmail.com> * getSurroundingEntities -> getOtherEntities * clarify 'subclass' * Some clarification * Remove unnecessary exception specification Co-authored-by: liach <7806504+liach@users.noreply.github.com> Co-authored-by: Yanis48 <doublecraft.official@gmail.com> Co-authored-by: i509VCB <i509vcb@gmail.com> Co-authored-by: modmuss50 <modmuss50@gmail.com>
This commit is contained in:
Thalia Nero
GitHub
parent
f0cb45fab9
commit
fa9df32fd8
|
|
@ -83,7 +83,18 @@ CLASS net/minecraft/class_3218 net/minecraft/server/world/ServerWorld
|
|||
ARG 1 x
|
||||
ARG 2 z
|
||||
ARG 3 forced
|
||||
METHOD method_18198 getEntities (Lnet/minecraft/class_1299;Ljava/util/function/Predicate;)Ljava/util/List;
|
||||
METHOD method_18198 getEntitiesByType (Lnet/minecraft/class_1299;Ljava/util/function/Predicate;)Ljava/util/List;
|
||||
COMMENT Computes a list of entities of the given type.
|
||||
COMMENT
|
||||
COMMENT <strong>Warning:<strong> If {@code null} is passed as the entity type filter, care should be
|
||||
COMMENT taken that the type argument {@code T} is set to {@link Entity}, otherwise heap pollution
|
||||
COMMENT in the returned list or {@link ClassCastException} can occur.
|
||||
COMMENT
|
||||
COMMENT @return a list of entities of the given type
|
||||
ARG 1 type
|
||||
COMMENT the entity type of the returned entities, or {@code null} for any type of entity
|
||||
ARG 2 predicate
|
||||
COMMENT a predicate which returned entities must satisfy
|
||||
METHOD method_18199 (Lnet/minecraft/class_1309;)Z
|
||||
ARG 1 entity
|
||||
METHOD method_18203 tickChunk (Lnet/minecraft/class_2818;I)V
|
||||
|
|
|
|||
|
|
@ -76,19 +76,39 @@ CLASS net/minecraft/class_1924 net/minecraft/world/EntityView
|
|||
ARG 1 entityClass
|
||||
ARG 2 box
|
||||
ARG 3 predicate
|
||||
METHOD method_8333 getEntities (Lnet/minecraft/class_1297;Lnet/minecraft/class_238;Ljava/util/function/Predicate;)Ljava/util/List;
|
||||
METHOD method_8333 getOtherEntities (Lnet/minecraft/class_1297;Lnet/minecraft/class_238;Ljava/util/function/Predicate;)Ljava/util/List;
|
||||
COMMENT Computes a list of entities within some box, excluding the given entity, that satisfy the given predicate.
|
||||
COMMENT
|
||||
COMMENT @return a list of entities within a box, excluding the given entity, all satisfying the given predicate
|
||||
ARG 1 except
|
||||
COMMENT the entity the box logically surrounds. This entity is ignored if it is inside the box.
|
||||
ARG 2 box
|
||||
COMMENT the box in which to search for entities
|
||||
ARG 3 predicate
|
||||
METHOD method_8335 getEntities (Lnet/minecraft/class_1297;Lnet/minecraft/class_238;)Ljava/util/List;
|
||||
COMMENT a predicate which entities must satisfy in order to be included in the returned list.
|
||||
METHOD method_8335 getOtherEntities (Lnet/minecraft/class_1297;Lnet/minecraft/class_238;)Ljava/util/List;
|
||||
COMMENT Computes a list of entities within some box, excluding the given entity, that are not spectators.
|
||||
COMMENT
|
||||
COMMENT @return a list of entities within a box, excluding the given entity
|
||||
COMMENT @see #getSurroundingEntities(Entity, Box, Predicate)
|
||||
COMMENT @see Entity#isSpectator()
|
||||
ARG 1 except
|
||||
COMMENT the entity the box logically surrounds. This entity is ignored if it is inside the box.
|
||||
ARG 2 box
|
||||
COMMENT the box in which to search for entities
|
||||
METHOD method_8338 (Lnet/minecraft/class_1297;Lnet/minecraft/class_1297;)Z
|
||||
ARG 1 e
|
||||
METHOD method_8390 getEntities (Ljava/lang/Class;Lnet/minecraft/class_238;Ljava/util/function/Predicate;)Ljava/util/List;
|
||||
METHOD method_8390 getEntitiesByClass (Ljava/lang/Class;Lnet/minecraft/class_238;Ljava/util/function/Predicate;)Ljava/util/List;
|
||||
COMMENT Computes a list of entities within some box whose runtime Java class is the same as or is
|
||||
COMMENT a subclass of the given class.
|
||||
COMMENT
|
||||
COMMENT @return a list of entities within the box whose runtime class is a subclass of the given class
|
||||
ARG 1 entityClass
|
||||
COMMENT the class the list of entities must extend
|
||||
ARG 2 box
|
||||
COMMENT the box in which to search for entities
|
||||
ARG 3 predicate
|
||||
COMMENT a predicate which entities must satisfy in order to be included in the returned list
|
||||
METHOD method_8604 getClosestPlayer (DDDDLjava/util/function/Predicate;)Lnet/minecraft/class_1657;
|
||||
ARG 1 x
|
||||
ARG 3 y
|
||||
|
|
|
|||
|
|
@ -56,10 +56,20 @@ CLASS net/minecraft/class_1937 net/minecraft/world/World
|
|||
ARG 1 mapState
|
||||
METHOD method_17891 getMapState (Ljava/lang/String;)Lnet/minecraft/class_22;
|
||||
ARG 1 id
|
||||
METHOD method_18023 getEntities (Lnet/minecraft/class_1299;Lnet/minecraft/class_238;Ljava/util/function/Predicate;)Ljava/util/List;
|
||||
METHOD method_18023 getEntitiesByType (Lnet/minecraft/class_1299;Lnet/minecraft/class_238;Ljava/util/function/Predicate;)Ljava/util/List;
|
||||
COMMENT Computes a list of entities of the given type within some region that satisfy the given predicate.
|
||||
COMMENT
|
||||
COMMENT <strong>Warning:<strong> If {@code null} is passed as the entity type filter, care should be
|
||||
COMMENT taken that the type argument {@code T} is set to {@link Entity}, otherwise heap pollution
|
||||
COMMENT in the output list or {@link ClassCastException} can occur.
|
||||
COMMENT
|
||||
COMMENT @return a list of entities
|
||||
ARG 1 type
|
||||
COMMENT the entity type of the returned entities, or {@code null} to return entities of all types
|
||||
ARG 2 box
|
||||
COMMENT the box in which to search for entities
|
||||
ARG 3 predicate
|
||||
COMMENT a predicate which entities must satisfy in order to be considered
|
||||
METHOD method_18471 tickBlockEntities ()V
|
||||
METHOD method_18472 tickEntity (Ljava/util/function/Consumer;Lnet/minecraft/class_1297;)V
|
||||
ARG 1 tickConsumer
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ CLASS net/minecraft/class_2818 net/minecraft/world/chunk/WorldChunk
|
|||
METHOD method_12204 loadBlockEntity (Lnet/minecraft/class_2338;Lnet/minecraft/class_2487;)Lnet/minecraft/class_2586;
|
||||
ARG 1 pos
|
||||
ARG 2 tag
|
||||
METHOD method_12205 getEntities (Lnet/minecraft/class_1297;Lnet/minecraft/class_238;Ljava/util/List;Ljava/util/function/Predicate;)V
|
||||
METHOD method_12205 collectOtherEntities (Lnet/minecraft/class_1297;Lnet/minecraft/class_238;Ljava/util/List;Ljava/util/function/Predicate;)V
|
||||
ARG 1 except
|
||||
ARG 2 box
|
||||
ARG 3 entityList
|
||||
|
|
@ -60,11 +60,17 @@ CLASS net/minecraft/class_2818 net/minecraft/world/chunk/WorldChunk
|
|||
ARG 1 levelTypeProvider
|
||||
METHOD method_12208 createBlockEntity (Lnet/minecraft/class_2338;)Lnet/minecraft/class_2586;
|
||||
ARG 1 pos
|
||||
METHOD method_12210 getEntities (Ljava/lang/Class;Lnet/minecraft/class_238;Ljava/util/List;Ljava/util/function/Predicate;)V
|
||||
METHOD method_12210 collectEntitiesByClass (Ljava/lang/Class;Lnet/minecraft/class_238;Ljava/util/List;Ljava/util/function/Predicate;)V
|
||||
COMMENT Collects a list of entities of some runtime type and appends them to the given list. The runtime
|
||||
COMMENT class of each collected entity will be the same as or a subclass of the given class.
|
||||
ARG 1 entityClass
|
||||
COMMENT the class object representing the type collected entities must extend
|
||||
ARG 2 box
|
||||
ARG 3 entityList
|
||||
COMMENT the box in which to collect entities
|
||||
ARG 3 result
|
||||
COMMENT a list in which to store the collected entities
|
||||
ARG 4 predicate
|
||||
COMMENT a predicate which entities must satisfy in order to be collected
|
||||
METHOD method_12212 (Lnet/minecraft/class_3195;)Lit/unimi/dsi/fastutil/longs/LongSet;
|
||||
ARG 0 structure
|
||||
METHOD method_12214 getBlockEntities ()Ljava/util/Map;
|
||||
|
|
@ -95,11 +101,20 @@ CLASS net/minecraft/class_2818 net/minecraft/world/chunk/WorldChunk
|
|||
ARG 1 x
|
||||
ARG 2 y
|
||||
ARG 3 z
|
||||
METHOD method_18029 getEntities (Lnet/minecraft/class_1299;Lnet/minecraft/class_238;Ljava/util/List;Ljava/util/function/Predicate;)V
|
||||
METHOD method_18029 collectEntities (Lnet/minecraft/class_1299;Lnet/minecraft/class_238;Ljava/util/List;Ljava/util/function/Predicate;)V
|
||||
COMMENT Collects a list of entities and appends them to the given list according to the specified criteria.
|
||||
COMMENT
|
||||
COMMENT <strong>Warning:<strong> If {@code null} is passed as the entity type filter, care should be
|
||||
COMMENT taken that the type argument {@code T} is set to {@link Entity}, otherwise heap pollution in
|
||||
COMMENT the output list or {@link ClassCastException} can occur.
|
||||
ARG 1 type
|
||||
COMMENT the entity type of the entities to collect, or {@code null} to collect entities of all types.
|
||||
ARG 2 box
|
||||
ARG 3 entityList
|
||||
COMMENT the box within which collected entities must be
|
||||
ARG 3 result
|
||||
COMMENT a list in which to store the collected entities
|
||||
ARG 4 predicate
|
||||
COMMENT a predicate which entities must satisfy in order to be collected
|
||||
METHOD method_18089 (Lnet/minecraft/class_1297;)Lnet/minecraft/class_1297;
|
||||
ARG 1 entity
|
||||
METHOD method_18319 (ILnet/minecraft/class_2338;)Z
|
||||
|
|
|
|||
Loading…
Reference in New Issue