codeninjasllc/codecombat
1
0
Fork 0
mirror of https://github.com/codeninjasllc/codecombat.git synced 2025-03-14 07:00:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adds direct links to the backend controlling logic. Also begins to explain a basic understanding of the World system and its parts.

Josh Callebaut 2015-09-18 21:08:24 -07:00
parent 67a8c97916
commit a0a1039981
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
Component-Authoring-Guide.md

@ -2,6 +2,33 @@
Contained within will be some tips and tricks as well as solutions for common "gotchas" that might afflict the inexperienced Artisan.
##General Tips
###Structure
The following is a broad overview of what occurs under the hood:
####World
[World Base Class](https://github.com/codecombat/codecombat/blob/master/app/lib/world/world.coffee)
The world contains a set of Systems, Thangs and their Components.
####System
[System Base Class](https://github.com/codecombat/codecombat/blob/master/app/lib/world/system.coffee)
Systems are a set of actions that are performed on applicable Thangs.
* The Collision System ensures collision objects don't overlap.
* The AI System controls the logic for the NPCs, such as Yaks or Ogres.
####Thang
[Thang Base Class](https://github.com/codecombat/codecombat/blob/master/app/lib/world/thang.coffee)
Thangs are individual entities which contain Components.
* An Arrow is a Thang.
* An Ogre is a Thang.
####Component
[Component Base Class](https://github.com/codecombat/codecombat/blob/master/app/lib/world/component.coffee)
Components are parts which sum to make an entire Thang.
* A common Peasant is made up of the following:
* Acts
* FindsPaths
* Allied
...
* Sees
###Spells
Describe how to efficiently make a spell here.
###Abilities