search

eakosin / TheExplorerProject

A 2D MMO-PVE dungeon crawler with item based character progression.
4 stars 3 forks source link

Add comments to world.lua #21

Closed rgbryant closed 10 years ago

rgbryant commented 10 years ago

This file needs to be commented. For now we will only be doing function header comments. The format is as follows:

--]] functionName: description ]]-- --param1 --param2 --returns

eakosin commented 10 years ago

Preliminary function descriptions: world.fillEventQueue() - Tell all active world objects to add events based upon current object state. world.processEventQueue() - Iterate through and empty all event queues calling each queue's process function. world.processWorldEvent() - Process the global world events. world.process(Level|Character|Enemy|Projectile)Event() - Send the event to all objects the event has listed. world.processChanges() - Process state changes from event processing results. world.configureCamera() - Set the position for the camera. world.draw() - Call the draw function of every active object. world.initalize() - Initialize world variables and state and initialize global objects.