adventuregamestudio / ags-manual

AGS documentation.
https://adventuregamestudio.github.io/ags-manual/
MIT License
28 stars 9 forks source link

Document DynamicSprite CreateFromScreenShot render layer parameters #258

Open ericoporto opened 2 days ago

ericoporto commented 2 days ago

https://github.com/adventuregamestudio/ags-manual/wiki/DynamicSprite#dynamicspritecreatefromscreenshot

  /// Creates a dynamic sprite as a copy of the current screen.
  import static DynamicSprite* CreateFromScreenShot(int width=0, int height=0, int layer=eRenderLayerAll);  // $AUTOCOMPLETESTATICONLY$

need to explain that the parameter int layer is to be used like flags of the RenderLayer enum, which accepts either any or a boolean combination of them. See https://adventuregamestudio.github.io/ags-manual/Globalfunctions_Wait.html?highlight=waitinput&case_sensitive=0#waitinput for an example.

The RenderLayer enum should be documented too in standard enums, see #259


@ivan-mogilko should the layer parameter be of the type RenderLayer like in the case of WaitInput ?

ivan-mogilko commented 2 days ago

@ivan-mogilko should the layer parameter be of the type RenderLayer like in the case of WaitInput ?

Yes, that parameter may be changed to the enum.

ericoporto commented 1 day ago

Other idea I had was making the enums that are flag like start with f instead of e, but here I asked about this one specific because I noticed the other case I knew of flag in the API used enum as the parameter type. I didn't remember other case of this...