flixel-docs icon indicating copy to clipboard operation
flixel-docs copied to clipboard

Published 20 hours ago • verified publisher icon HaxeFlixel

FlxSound pitch is missing

Open T1mL3arn opened this issue 2 years ago • 3 comments

  1. go to https://api.haxeflixel.com/flixel/system/FlxSound.html
  2. try to find pitch
  3. see no results

Pitch prop was added with https://github.com/HaxeFlixel/flixel/pull/2564 .

T1mL3arn avatar Feb 18 '23 08:02 T1mL3arn

I believe there's a specific compiler flag we should use to expose fields to the api page, I forgot what it is so we'll have to find it

Geokureli avatar Feb 18 '23 17:02 Geokureli

The flag is FLX_PITCH and it is set by flixel on targets except flash. But the doc is built for flash target, so the pitch property is not generated.

Possible solutions:

  • build doc for non flash target, e.g. neko
  • wrap pitch prop in #if doc_gen

T1mL3arn avatar Mar 09 '23 04:03 T1mL3arn

after some investigation this sorta thing seems to affect other "non-flash target" related defines FlxG.android, FlxG.accelerometer. Neither have documentation generated!

ninjamuffin99 avatar Jan 27 '24 08:01 ninjamuffin99