WeaponInfo docs
#1596
WeaponInfo docs
#1596
Conversation
| static Vec3f sPosAModel = { 0.0f, 400.0f, 1500.0f }; | ||
| static Vec3f sPosBModel = { 0.0f, -400.0f, 1500.0f }; |
There was a problem hiding this comment.
Currently we dont have a convention for naming these types of vectors. So maybe its something we need to solve outside of this PR. But, suffixing "model" isnt all that common so far for these.
Most often youll see "offset" used. As in, posA is 400 units in the y direction and 1500 units in the z direction from the base position of whatever the relevant entity is.
There was a problem hiding this comment.
"offset" makes it sound like it's just an addition though, when in fact the transformation also involves scaling and rotation (or any other linear transform but typically TRS)
It seems more typical/robust to me to specify the coordinates system a position is expressed in, here the "left hand limb (model) space"
I don't like the jumbled mess of words it comes out as either, but I don't really see a better option and apparently this is how I named similar coordinates in this file in the past (e.g. sPlayerFocusHeadLimbModelPos in #1230), it wasn't challenged then (just to say that other stuff would need changing too)
Brainstorming based on sPlayerFocusHeadLimbModelPos
sPlayerFocusPosHeadLimbSpacesPlayerFocusPos_HeadLimbSpacesPlayerFocusPos_HeadLimb
🤔
| // Positions for the tip of melee weapons, in the left hand limb's own model space. | ||
| Vec3f sMeleeWeaponTipLeftHandLimbModelPos0 = { 5000.0f, 400.0f, 0.0f }; | ||
| Vec3f sMeleeWeaponTipLeftHandLimbModelPos1 = { 5000.0f, -400.0f, 1000.0f }; | ||
| Vec3f sMeleeWeaponTipLeftHandLimbModelPos2 = { 5000.0f, 1400.0f, -1000.0f }; | ||
|
|
||
| Vec3f D_801260A4[3] = { | ||
| { 0.0f, 400.0f, 0.0f }, | ||
| { 0.0f, 1400.0f, -1000.0f }, | ||
| { 0.0f, -400.0f, 1000.0f }, | ||
| }; | ||
| // Positions for the base of melee weapons, in the left hand limb's own model space. | ||
| Vec3f sMeleeWeaponBaseLeftHandLimbModelPos0 = { 0.0f, 400.0f, 0.0f }; | ||
| Vec3f sMeleeWeaponBaseLeftHandLimbModelPos1 = { 0.0f, 1400.0f, -1000.0f }; | ||
| Vec3f sMeleeWeaponBaseLeftHandLimbModelPos2 = { 0.0f, -400.0f, 1000.0f }; |
There was a problem hiding this comment.
While the comments help greatly, the variable names themselves are quite confusing for me currently. I initially couldnt tell if this was the position of the left hand or what.
Using "offset" from the previous comment, it would be something like
sMeleeWeaponTipOffsetFromLeftHand0. This tells me that its the position of something relative to something else (and the fact that its in model space is imo clear by its usage instantly, and doesnt need to be in the name)
|
why not just do |
Some docs on WeaponInfo and surroundings
Cf
Player_UpdateWeaponInfofor an explanation of what this is (see if the doc is good enough)Major change is renaming "tip" and "base" to "posA" and "posB" respectively.
This is because tip&base only works for melee weapons (swords, stick, hammer), where the two positions do correspond to a tip and a base:
However this falls apart for range weapons which also use WeaponInfo. For example hookshot uses positions that are basically "left and right" (or "top and bottom" idk)
Link to discord discussion (really me venting that bleh posA and posB) https://discord.com/channels/688807550715560050/688851317593997489/1175953325733199922