mcl_armor documentation #1917

Merged
cora merged 5 commits from AFCMS/MineClone2:armor-doc into master 2022-02-13 21:49:50 +01:00
Member

Fix #1665

  • mcl_armor
    • mcl_armor.register_set()
    • mcl_armor.equip()
    • mcl_armor.unequip()
    • manual armor registering
    • mcl_armor.register_protection_enchantment()
  • mcl_damage
Fix #1665 - [ ] mcl_armor - [x] mcl_armor.register_set() - [x] mcl_armor.equip() - [x] mcl_armor.unequip() - [x] manual armor registering - [ ] mcl_armor.register_protection_enchantment() - [ ] mcl_damage
AFCMS added this to the 0.72.0 milestone 2021-11-23 10:42:12 +01:00
AFCMS added the
API
documentation
labels 2021-11-23 10:42:12 +01:00
AFCMS self-assigned this 2021-11-23 10:42:12 +01:00
AFCMS requested review from LizzyFleckenstein03 2021-11-23 10:44:13 +01:00
AFCMS added this to the 0.72 project 2021-11-23 10:44:18 +01:00
LizzyFleckenstein03 approved these changes 2021-11-30 08:41:38 +01:00
AFCMS requested review from LizzyFleckenstein03 2021-11-30 19:47:33 +01:00
LizzyFleckenstein03 requested changes 2021-12-02 15:44:46 +01:00
@ -0,0 +1,302 @@
# mcl_armor
This mod implement the ability of creating armors.

implement -> implements
creating armors -> registering armor

implement -> implements creating armors -> registering armor
Author
Member

oops

oops
AFCMS marked this conversation as resolved
@ -0,0 +2,4 @@
This mod implement the ability of creating armors.
Armors are basically items that a player can equip on four different slots on him (head, feet, torso and feet) to get advantages.

I don't think it's necessary to document the concept of armor, at least not here. Only document the API.

I don't think it's necessary to document the concept of armor, at least not here. Only document the API.
AFCMS marked this conversation as resolved
@ -0,0 +4,4 @@
Armors are basically items that a player can equip on four different slots on him (head, feet, torso and feet) to get advantages.
These armors have also a texture which is visible to other players, inside inventory or in 3rd person view.

Armors -> armor items

Armors -> armor items
AFCMS marked this conversation as resolved
@ -0,0 +6,4 @@
These armors have also a texture which is visible to other players, inside inventory or in 3rd person view.
## Creating an Armor Set

Creating -> Registering

Creating -> Registering
AFCMS marked this conversation as resolved
@ -0,0 +8,4 @@
## Creating an Armor Set
The `mcl_armor.register_set()` function aims to simplificate the process of creating a full set of armor.

simplificate -> simplify
creating -> registering

simplificate -> simplify creating -> registering
AFCMS marked this conversation as resolved
@ -0,0 +10,4 @@
The `mcl_armor.register_set()` function aims to simplificate the process of creating a full set of armor.
This function register a four piece of armor (head, torso, leggings, feets) using a definition table:

a four piece of armor -> four pieces of armor
using -> based on

a four piece of armor -> four pieces of armor using -> based on
Author
Member

typo

typo
AFCMS marked this conversation as resolved
@ -0,0 +18,4 @@
name = "dummy_armor",
--description of the armor material
--do NOT localize this string, it will be concatenated will each piece of armor's description and result will be automatically fetched from your mod's translation files

localize -> translate

localize -> translate
AFCMS marked this conversation as resolved
@ -0,0 +91,4 @@
end,
},
--WARNING: 2d preview will be deprecated soon

is deprecated and will be removed soon

is deprecated and will be removed soon
AFCMS marked this conversation as resolved
AFCMS requested review from LizzyFleckenstein03 2021-12-02 16:14:44 +01:00
Contributor

Is this still being worked on? From the conversation it looks everything is resolved?

If there's no answer here within a week I will remove 0.72 milestone.

This is "just" documentation it seems so this might just be a matter of removing the WIP and someone checking it ?

Is this still being worked on? From the conversation it looks everything is resolved? If there's no answer here within a week I will remove 0.72 milestone. This is "just" documentation it seems so this might just be a matter of removing the WIP and someone checking it ?
Author
Member

It can be merged like it is.

I didn't add documentation to mcl_damage, but I have more important priorities rn

It can be merged like it is. I didn't add documentation to mcl_damage, but I have more important priorities rn
AFCMS changed title from WIP: armor and damage documentation to armor and damage documentation 2022-02-13 19:09:15 +01:00
AFCMS changed title from armor and damage documentation to `mcl_armor` documentation 2022-02-13 19:09:40 +01:00
Contributor

It can be merged like it is.

I didn't add documentation to mcl_damage, but I have more important priorities rn

yeah sounds good. I was just going through the milestone PRs as probably noticed.

> It can be merged like it is. > > I didn't add documentation to mcl_damage, but I have more important priorities rn yeah sounds good. I was just going through the milestone PRs as probably noticed.
Contributor

Uh can you rebase ? See this is why it's better to make branches in the main repo ^^

Uh can you rebase ? See this is why it's better to make branches in the main repo ^^
AFCMS added 33 commits 2022-02-13 21:13:00 +01:00
9b881df465 Temporarily remove glitchy Elytra crash-damage
If you fly in certain directions with this damage system, you will die. also if you speed up too fast.
Author
Member

Done

Done
Contributor

thx but .. mmmh it still says it's out of date

also if you use rebase you don't get these ugly merge commits - it will just say "force pushed from x to y"

EDIT just git rebase master && git push --force or check the rebase option in the gitea update thingy

thx but .. mmmh it still says it's out of date also if you use rebase you don't get these ugly merge commits - it will just say "force pushed from x to y" EDIT just git rebase master && git push --force or check the rebase option in the gitea update thingy
Contributor

uh yes looks like the latest commit on master is missing (prob forgot to pull before merge ?)

uh yes looks like the latest commit on master is missing (prob forgot to pull before merge ?)
Author
Member

gitea update always break branch informations

gitea update always break branch informations
AFCMS force-pushed armor-doc from 34481c6ef2 to da4952a125 2022-02-13 21:31:10 +01:00 Compare
Author
Member

ok, updated again the right way

ok, updated again the right way
Contributor

alright thx. I will merge.

alright thx. I will merge.
cora merged commit 87427cb8af into master 2022-02-13 21:49:39 +01:00
Sign in to join this conversation.
No reviewers
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: VoxeLibre/VoxeLibre#1917
No description provided.