[2D] Elf_Ears's Understandable Platformer Tutorial

This is a READ-ONLY snapshot of the Godot Community Forums when TwistedTwigleg was the owner, which is hosted for archival reasons only. The current Godot Community Forums can be found here.

Some links may point to external websites, including the current Godot Community Forums. These websites are not associated with TwistedTwigleg.

[2D] Elf_Ears's Understandable Platformer Tutorial

Elf_Ears

EDIT: OH WOW THIS IS TOTALLY OUT OF DATE AND A BIT RUBBISH

DON'T USE AREA2Ds TO CHECK COLLISION WITH GROUND AND CEILING USE THE COLLISION NORMALS RETURNED FROM MOVE_AND_COLLIDE (for 3.0) OR IT'S EQUIVALENT FUNCTION IN 2.0

 

Intro

As a coder, I have certain standards and principle to follow... One of them (which I suggest more people should follow) is that If I do not understand a particular system or piece of code... I do not use it This is for a variety of reasons but to sum it up, It really helps debugging and integration with the rest of the program if you understand what is going on under the hood (and I also just like it out of principle) This is why I have made my own simple to follow platformer script, as I found the demo platforming engines to be far too complicated for my puny human mind All that is required is basic knowledge of Godot (KinematicBody2D, Signals, Input, GDScript etc.) The Player <img alt="" src="http://i.imgur.com/3FTRV80.png" title="Image: http://i.imgur.com/3FTRV80.png" width="760" height="465"> Here is our Player! Let's dissect this! The player in this tutorial consists of a KinematicBody2D, a Sprite and two Area2Ds The KinematicBody2D is just a huge 16x32 (32x64 in pixels, as CollisionShape2D sizes are double for some presumably important reason) rectangle (As dictated by it's CollisionShape2D and fully obscured by the sprite which is it's exact size) The bottom Area2D (Bottom) is a 16x1 (32x2 pixels) area under the KinematicBody2D, it has it's body_enter and body_exit signals linked to the KinematicBody2D (the root node of the scene containing all the scripts) it acts as the player's “feet” The top Area2D (Top) is a 16x0.5 (32x1 pixels) area above the KinematicBody2D and has it's body_enter signal linked to the KinematicBody2D Input <img alt="" src="http://i.imgur.com/jPpjQwt.png" width="306" height="148"> Don't forget to set up your input for this project! (This is my setup) The names are important however you can easily change them in the code... The Code: 

extends KinematicBody2D var grav=100 var speed=100 var grounded=0 var motion var jspeed = 200 #jump power var yspeed var jumping = false func _ready(): yspeed=grav set_fixed_process(true) set_process_input(true) pass func _fixed_process(delta): if (grounded<0): #ensures that the grounded variable never goes under 0 grounded=0 motion=Vector2(0,0) #(basic movement stuff) if (Input.is_action_pressed("move_left")): motion+=Vector2(-1,0) if (Input.is_action_pressed("move_right")): motion+=Vector2(1,0) if (jumping==1): #(if the player has pressed jump) if (grounded>0): #(if the player is detected to be on the ground) jump(jspeed) # sets yspeed to the value of jspeed, jumping grounded=0 jumping=0 motion = motion*speed*delta move(motion) if (self.is_colliding()): #ensures that the character moves against walls properly var n = get_collision_normal() motion = n.slide(motion) move(motion) if (yspeed>grav): #ensures that the player does not exceed the speed of gravity yspeed=grav move(Vector2(0,1)*yspeed*delta) #moves the player vertically if (yspeed<grav): #takes away 4 from the players yspeed every loop, making them fall in a curve yspeed+=4 print(str(grounded)) func jump(jumpvar): yspeed= -jumpvar func _input(event): #fixed controls ensures consistant jump height as jump() is only called once if (event.is_action_pressed("jump")): jumping=1 #Area2D “Bottom”'s body_enter signal func _on_Bottom_body_enter( body ): #adds one to grounded if player's "feet" touch a body grounded+=1 pass # replace with function body #Area2d “Bottom”'s body_exit signal func _on_Bottom_body_exit( body ): #removes one from grounded whenever player's "feet" leave a body grounded-=1 pass #Area2D “Top”'s  body_enter signal func _on_Top_body_enter( body ): #ensures the player does not get stuck in ceiling when hitting a block above them, instead making them bump off yspeed=grav pass

The Test Level <img alt="" src="http://i.imgur.com/4ASLDq5.png" width="618" height="368"> Here I have a tilemap set up (which just consists of a bunch of Sprites with StaticBody2D children) It has a floor, walls so you can't jump out into the void and a ceiling to test that the collision works properly and the player doesn't get stuck Useful Notes The “grounded” system is important as the player's “feet” are usually touching more that one body at a time. I originally had a pseudo boolean system with 0 and 1 (because I was too lazy to change everything to accept True and false) where a boy entering your “feet” set grounded to 1 and a body leaving your “feet” set it to 0. I had problems with jumping (character not jumping when touching the floor, character jumping in the air) but I then realized that a system that counts the number of bodies the player's feet and could jump when it was more than 0 would solve all my problems. (it's actually common for "coding genius" moments like this to stem from glitches or poor/lazy design) Your Thoughts? Hope you enjoyed reading! If you have any comments or ideas on how I could improve this, please reply away!

BinaryOrange

You need to post a complete tutorial. Don't make a post that's essentially empty.All you have done is simply post saying that you have created a tutorial, but didn't actually post it. In the future, please make sure that your post is complete. Just as with other WIP threads, you [i]need[/i] to have something to show, or this could be considered spam.Please update your post as soon as possible.

Kiori

Also, please don't use all caps on your posts. If you think about it, it's really not necessary.

Megalomaniak

[quote author=BinaryOrange link=topic=15486.msg16142#msg16142 date=1462487854]In the future, please make sure that your post is complete. Just as with other WIP threads, you [i]need[/i] to have something to show, or this could be considered spam.[/quote]If you don't mind me asking......what if he had post this into the WIP section?

BinaryOrange

[quote author=Megalomaniak link=topic=15486.msg16151#msg16151 date=1462506329][quote author=BinaryOrange link=topic=15486.msg16142#msg16142 date=1462487854]In the future, please make sure that your post is complete. Just as with other WIP threads, you [i]need[/i] to have something to show, or this could be considered spam.[/quote]If you don't mind me asking......what if he had post this into the WIP section?[/quote]As I said before, a WIP topic needs to have something to show. A post simply containing something like "Hey I'm working on a game" is a waste of everyone's time, including the poster's. Per [url=http://godotdevelopers.org/index.php?topic=14456.0]this thread[/url] in the WIP board, you need to have a minimum of who's working on the project, what's been done, and other such similar things. And then it would have been moved, as tutorials don't belong in the WIP category regardless.In an effort to prevent any further off-topic discussion and total derailment of this topic, Elf_Ears, I'm going to temporarily lock this thread. If you send me a PM as soon as you can I will gladly unlock this for you, once you have updated your first post with something to show.  ;)

BinaryOrange

Great work!  :)

Alekhine

Nice work dude!  ;)

Alice

Ty for tutorial :#