On Mon, Jul 5, 2010 at 2:26 AM, Richard Jones <[email protected]>wrote:
> Hi all,
>
> Attached is my first attempt at a quick reference for Cocos2d. It's
> not covered everything, just the stuff I think beginners should know
> about.
It is a valuable resource. Can we include the .pdf in the docs ?
> I've got a bit of room left - any thoughts? Or just comments?
Suggestions?
>
Some glitches, that probably you have spotted and intended to fix later, but
I will mention just in case, and some possible additions:
- The director block has all the descriptions area taken by the init
parameters; should be one description for each method listed
- I see 'sprite' or 'layer or sprite' in positions where a cocosnode arg
is needed. I know it can be a useful rhetoric choice, but how about that:
- Add a section cocosnode, List there the important subclasses (
Sprite, Canvas, Layer, Scene,... ). If you want to list there the main
methods, better.
- replace the 'sprite' and 'layer or sprite' with 'cocosnode' when
appropriate
- In the block for layer, the line
is_event_handler = False True to register the event handlers of this layer
should be:
is_event_handler = False True to register the _stock_ pyglet event handlers
of this layer
- the line 'section from pyglet.window import key' can have the left text as
'key constants and keyboard status handler'
- A section listing available events can be handy (the pyglet ones and the
on_cocos_resize)
- A section for transitions similar to the one for actions ?
- In the actions combine section there is a confusion between Repeat an
Loop, and Loop is not mentioned ( Loop repeats n times, Repeat repeats
forever)
> The original source is OS X Pages format, so I'm not sure how useful
it would be to share it :-)
>
Long term it should make sense to write the document in .rst , so it can be
maintained from any platform, and render that to pdf and html.
Also long term, there can be a 'thin' and 'fat' cheatsheets:
- 'fat' includes sections handy but not so critical, like perhaps the
transitions section, and for each feature one or two links to examples (
test_*.py) using the feature
>
>
> Richard
>
>
The document is usable as it is, don't feel compelled to implement any
changes - suggestions. But if you have choices while writing the sources
that would facilitate convert to .rst, then steer in that direction if
possible.
Fine addition !
--
claudio
--
You received this message because you are subscribed to the Google Groups
"cocos2d discuss" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cocos-discuss?hl=en.
