Talk:Missing Documentation

Some things that have prevented me from documenting these functions

SpriteBatch:lock, SpriteBatch:unlock

The lock method has a mysterious light userdata return value. I have no idea what its use is on the Lua side. They also didn't seem to affect the performance of drawing operation in any measurable way, so I left them for later.

ParticleSystem:setRelativeDirection

This sets the flag in the C++ particle system object, but this flag does not affect any calculations. I assume it is a feature that is meant to be implemented in the future, but is not done yet.

Shape:getGroupIndex, Shape:setGroupIndex

These don't seem to appear in CircleShape and PolygonShape, so I suspect they cannot be used yet. I might just have missed something.

-- Pekka