Changed FlowableFluid getVelocity method name to getFlowDirectionVect… #3284
Conversation
…or. Changed the argument in the same method with name 'state' to 'mainFluidState'. Also added a documentation for the method.
enbrain
added
refactor
| ARG 1 world | ||
| ARG 2 pos | ||
| ARG 3 state | ||
| ARG 3 mainFluidState |
There was a problem hiding this comment.
Since there is only one fluid state from the API user perspective, state is less confusing imo. Ideally, local variables should get descriptive names but we can't rename them at the moment.
There was a problem hiding this comment.
I kinda prefer mainFluidState because it tells me that from all the other states in the method, that is the main one related to the desired operation. But since in most of the code the name is just state I guess it makes sense to keep it the same. I have changed it back in 5076644
| METHOD method_15782 (Lnet/minecraft/class_1922;Lnet/minecraft/class_2338;Lnet/minecraft/class_3610;)Lnet/minecraft/class_243; | ||
| COMMENT Gets a 3D vector indicating the direction the given fluid state will flow towards | ||
| COMMENT | ||
| COMMENT Example: a return of (0, 0, -1) means the given {@link FluidState} will flow towards negative-Z in the game which is towards the North. | ||
| COMMENT Likewise (0, 0, 1) means the given {@link FluidState} will flow towards positive-Z in the game which is South. | ||
| COMMENT | ||
| COMMENT @param world the world that will be queried for the fluid states around the fluid state whose direction of flow is desired | ||
| COMMENT @param pos the {@link BlockPos} containing the position of the fluid state whose direction of flow is desired | ||
| COMMENT @param mainFluidState the {@link FluidState} whose direction of flow is desired to be known | ||
| COMMENT @return a {@link Vec3D} vector indicating the direction the given {@link FluidState} should flow |
There was a problem hiding this comment.
I think these docs should be in the parent Fluid#getFlowDirectionVector since they are not specific to this implementation.
There was a problem hiding this comment.
Yes, I fixed it to be in the Fluid class instead on 5076644
| @@ -27,10 +27,10 @@ CLASS net/minecraft/class_3611 net/minecraft/fluid/Fluid | |||
| ARG 1 fluid | |||
| METHOD method_15781 setDefaultState (Lnet/minecraft/class_3610;)V | |||
| ARG 1 state | |||
| METHOD method_15782 getVelocity (Lnet/minecraft/class_1922;Lnet/minecraft/class_2338;Lnet/minecraft/class_3610;)Lnet/minecraft/class_243; | |||
| METHOD method_15782 getFlowDirectionVector (Lnet/minecraft/class_1922;Lnet/minecraft/class_2338;Lnet/minecraft/class_3610;)Lnet/minecraft/class_243; | |||
There was a problem hiding this comment.
FluidState#getVelocity should also be renamed for consistency.
There was a problem hiding this comment.
Done. I have changed it there so that every method that overrides or implements will get the Javadocs. 5076644
…or. Changed the argument in the same method with name 'state' to 'mainFluidState'. Also added a documentation for the method.
… the FluidState getVelocity to getFlowDirectionVector which will cascade to overriding classes. Changed the argument in the same method with name 'mainFluidState' back to 'state'. Also moved documentation for the method to the Fluid class. This allows the documentation to cascade to overriding methods.
Co-authored-by: enbrain <[email protected]>
Co-authored-by: enbrain <[email protected]>
Co-authored-by: enbrain <[email protected]>
Co-authored-by: enbrain <[email protected]>
|
I just committed the suggestions. |
This might be good to include in the javadoc |
apple502j
added
the
update-base
|
🚀 Target branch has been updated to 22w42a |
apple502j
removed
the
update-base
Changed FlowableFluid
getVelocitymethod name togetFlowDirectionVector. Changed the argument in the same method with namestatetomainFluidState. Also added a documentation for the method. This method tells the game the direction a fluid should flow by evaluating the level of other fluid blocks around it. It returns a 3D vector with numbers -1 OR 0 OR 1 for each component of the 3D vector to indicate what direction the fluid should flow towards.I thought about using just
getFlowDirection, but given thatDirectionis already a class that indicates something else, I went withgetFlowDirectionVectorto indicate in the name it returns a vector and not aDirectionobject. It is still a vector that is used to know the direction of flow from a fluid, but it's not aDirectionobject.stateI changed tomainFluidStateto make it more clear in the code from the method that the variable holds theFluidStatewhose direction is desired since the method creates 2 otherFluidStateobjects inside of it to make the calculations of flow direction.