System ArrowKey

Bribe

vJass errors are legion
Reaction score
67
It would be:

JASS:
method onKeyEvent integer key, boolean press returns nothing
    call MoveHero(hero[this])
endmethod


Really short API. I am not going to add the same parameter twice.
 

tooltiperror

Super Moderator
Reaction score
231
I was very eager to review this system, and I was waiting to get all my work done before reviewing it. As per Bribe's request, let's get going.

1. The code commentation is superb. Just really superb. Most functions are described, important blots have headers describing them, the code has sections marked off, and you got everything good. This is a script I'll be referring to people when it comes to commenting on code. Really well done. The documentation, on the other hand, I will address below.

2. [LJASS]ALL_FEATURES[/LJASS] is a really good implementation detail, and it is excellent that you included it. From my C++ influence I would prefer a function such as [LJASS]ArrowKeyActivateAllFeatures()[/LJASS] or something of the like, but from a developmental stand point, you should know all the functions you are using before you use them. However, this means that systems and scripts requiring ArrowKey must point out that [LJASS]ALL_FEATURES[/LJASS] should be [LJASS]true[/LJASS].

3. "[ljass]private module M[/ljass]" should have a comment explaining why it is a module (vJASS initialization order).

4. When we get to the constants, this is where I get a little more upset with your coding style. [LJASS]ArrowKey.LEFT[/ljass] looks absolutely hideous. Most languages with object oriented features use symbols or functions to get around this ugly stuff, so you should change them to regular global constants, probably [LJASS]ARROW_KEY_LEFT[/LJASS]. Remember that, while OOP is nice, Jass is a multiparadigm language.

5. At [ljass]ArrowKey.registerEvent[/LJASS] you do not note that you need to take the arguments. Awful commenting mistake.

6. Again, all your debug functions show how your coding triumphs the other recent prominent Jassers. Also, the section headers are another good addition to your code, and shows how structured it is.

7. At "[ljass]implement M[/ljass]" you should note that it is the initialization module.

8. It would be wiser to rename "onKeyEvent" to "onArrowKeyEvent" to as not conflict with something like, say, any key being pressed. Despite Warcraft III having a limitation to not detect all keypresses, it is probably philosophically wrong.

9. I really don't see why this style of documentation is becoming more popular. Also, a mistake, on the .LEFT and .RIGHT and so on constants, you didn't mention they were static. You also don't describe what the axes are, or what a negative value is for a key. Here, Earth-Fury beats you by so much, his documentation is far superior.

One last note: Where are the imperative style wrappers?
 

Sgqvur

FullOfUltimateTruthsAndEt ernalPrinciples, i.e shi
Reaction score
62
tooltiperror:
1. ArrowKey.LEFT looks absolutely hideous.

2. Most languages with object oriented features use symbols or functions to get around this ugly stuff, so you should change them to regular global constants, probably ARROW_KEY_LEFT.

3. Remember that, while OOP is nice, Jass is a multiparadigm language.

1. "From my Jass2 influence" I do prefer/like more ARROW _KEY_LEFT than ArrowKey.LEFT (but ArrowKey.LEFT is not really that bad because it could be way worse -> c_keyLeft).

2. What languages are you writing about? Can you elaborate more on "symbols or functions to get around". I am 99% sure no OOP guy thinks ArrowKey.LEFT is "ugly stuff".

3. Which paradigms are you writing about again? Cause it seams to me Jass2 is pretty much imperative all the way.
 

tooltiperror

Super Moderator
Reaction score
231
I am not responding to your post unless you use typical forum post writing conventions. This "1. 2. 3." business is nonsense. You can use "greentexting" (the > character) or [NOPARSE]
[/NOPARSE] to write a reply as much of the rest of the forum does.

Good day to you sir.
 

Sgqvur

FullOfUltimateTruthsAndEt ernalPrinciples, i.e shi
Reaction score
62
tooltiperror:

1. This "1. 2. 3." business is nonsense.

2. I am not responding to your post unless you use typical forum post writing conventions.

1. And you think it's nonsense because?
The reason I use 1 -> 1, 2 -> 2, ..., n -> n statement matchup is because I think it's the second best thing after a table (I don't think/know if tables can be made in this editor). It's pretty clear which statement of the author is being addressed, and replying to multiple people in a single post is not a problem.

2. It's your choice to respond/reply to my post, but ignoring it because of the "style" of expression is kinda childish.
 

Bribe

vJass errors are legion
Reaction score
67
Updates thanks to tooltiperrors's advice:

- Heavily invested in the documentation.
- Re-added function wrappers.
- Split the library into two instead of the static if: ArrowKeyEvent and ArrowKey.
 

tooltiperror

Super Moderator
Reaction score
231
That's some creative use of textmacros :p

Approved. This is now my arrow key library of choice.
 
General chit-chat
Help Users
  • No one is chatting at the moment.
  • The Helper The Helper:
    I am great and it is fantastic to see you my friend!
    +1
  • The Helper The Helper:
    If you are new to the site please check out the Recipe and Food Forum https://www.thehelper.net/forums/recipes-and-food.220/
  • Monovertex Monovertex:
    How come you're so into recipes lately? Never saw this much interest in this topic in the old days of TH.net
  • Monovertex Monovertex:
    Hmm, how do I change my signature?
  • tom_mai78101 tom_mai78101:
    Signatures can be edit in your account profile. As for the old stuffs, I'm thinking it's because Blizzard is now under Microsoft, and because of Microsoft Xbox going the way it is, it's dreadful.
  • The Helper The Helper:
    I am not big on the recipes I am just promoting them - I use the site as a practice place promoting stuff
    +2
  • Monovertex Monovertex:
    @tom_mai78101 I must be blind. If I go on my profile I don't see any area to edit the signature; If I go to account details (settings) I don't see any signature area either.
  • The Helper The Helper:
    You can get there if you click the bell icon (alerts) and choose preferences from the bottom, signature will be in the menu on the left there https://www.thehelper.net/account/preferences
  • The Helper The Helper:
    I think I need to split the Sci/Tech news forum into 2 one for Science and one for Tech but I am hating all the moving of posts I would have to do
  • The Helper The Helper:
    What is up Old Mountain Shadow?
  • The Helper The Helper:
    Happy Thursday!
    +1
  • Varine Varine:
    Crazy how much 3d printing has come in the last few years. Sad that it's not as easily modifiable though
  • Varine Varine:
    I bought an Ender 3 during the pandemic and tinkered with it all the time. Just bought a Sovol, not as easy. I'm trying to make it use a different nozzle because I have a fuck ton of Volcanos, and they use what is basically a modified volcano that is just a smidge longer, and almost every part on this thing needs to be redone to make it work
  • Varine Varine:
    Luckily I have a 3d printer for that, I guess. But it's ridiculous. The regular volcanos are 21mm, these Sovol versions are about 23.5mm
  • Varine Varine:
    So, 2.5mm longer. But the thing that measures the bed is about 1.5mm above the nozzle, so if I swap it with a volcano then I'm 1mm behind it. So cool, new bracket to swap that, but THEN the fan shroud to direct air at the part is ALSO going to be .5mm to low, and so I need to redo that, but by doing that it is a little bit off where it should be blowing and it's throwing it at the heating block instead of the part, and fuck man
  • Varine Varine:
    I didn't realize they designed this entire thing to NOT be modded. I would have just got a fucking Bambu if I knew that, the whole point was I could fuck with this. And no one else makes shit for Sovol so I have to go through them, and they have... interesting pricing models. So I have a new extruder altogether that I'm taking apart and going to just design a whole new one to use my nozzles. Dumb design.
  • Varine Varine:
    Can't just buy a new heatblock, you need to get a whole hotend - so block, heater cartridge, thermistor, heatbreak, and nozzle. And they put this fucking paste in there so I can't take the thermistor or cartridge out with any ease, that's 30 dollars. Or you can get the whole extrudor with the direct driver AND that heatblock for like 50, but you still can't get any of it to come apart
  • Varine Varine:
    Partsbuilt has individual parts I found but they're expensive. I think I can get bits swapped around and make this work with generic shit though
  • Ghan Ghan:
    Heard Houston got hit pretty bad by storms last night. Hope all is well with TH.
  • The Helper The Helper:
    Power back on finally - all is good here no damage
    +2
  • V-SNES V-SNES:
    Happy Friday!
    +1
  • The Helper The Helper:
    New recipe is another summer dessert Berry and Peach Cheesecake - https://www.thehelper.net/threads/recipe-berry-and-peach-cheesecake.194169/

      The Helper Discord

      Members online

      No members online now.

      Affiliates

      Hive Workshop NUON Dome World Editor Tutorials

      Network Sponsors

      Apex Steel Pipe - Buys and sells Steel Pipe.
      Top