Difference between revisions of "Talk:Missing Documentation"
(why I didn't document them) |
(slight edits, removed reset because I added it to docs) |
||
| Line 1: | Line 1: | ||
| − | == Some things that have prevented me from documenting | + | == Some things that have prevented me from documenting these functions == |
| − | |||
| − | |||
| − | |||
=== SpriteBatch:lock, SpriteBatch:unlock=== | === SpriteBatch:lock, SpriteBatch:unlock=== | ||
| − | The lock method has a mysterious light userdata return value. I have no idea what | + | 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 === | === ParticleSystem:setRelativeDirection === | ||
| − | This sets the flag in the C++ particle system object, but this flag does not affect any | + | 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 === | === Shape:getGroupIndex, Shape:setGroupIndex === | ||
Revision as of 15:47, 31 March 2010
Contents
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
