Skip to content

Commit aa47964

Browse files
committed
[docs] Expose more from AllApi.hx to generate more comprehensive API docs
1 parent ae5a103 commit aa47964

File tree

1 file changed

+227
-9
lines changed

1 file changed

+227
-9
lines changed

runtime/src/ceramic/AllApi.hx

Lines changed: 227 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,30 @@ package ceramic;
22

33
/**
44
* Central import file that includes all Ceramic API classes.
5-
*
5+
*
66
* AllApi serves as a comprehensive import manifest for the Ceramic framework,
77
* ensuring all classes are included in the compiled output. This is particularly
88
* important for dynamic environments like scripting where classes need to be
99
* available at runtime.
10-
*
10+
*
1111
* Features:
1212
* - Imports all core Ceramic classes and systems
1313
* - Imports all plugin classes when plugins are enabled
1414
* - Provides HScript configuration for scripting environments
1515
* - Ensures DCE (Dead Code Elimination) doesn't remove needed classes
16-
*
16+
*
1717
* The file is organized into sections:
1818
* - Standard Haxe imports
1919
* - Tracker framework imports
2020
* - Core Ceramic classes
2121
* - Plugin-specific imports (conditional compilation)
2222
* - HScript configuration method
23-
*
23+
*
2424
* Usage:
2525
* This file is typically imported by the build system or main application
2626
* to ensure all necessary classes are available. The @:keep metadata
2727
* prevents the class from being eliminated during compilation.
28-
*
28+
*
2929
* @see App
3030
* @see ceramic.scriptable
3131
*/
@@ -286,6 +286,44 @@ import ceramic.Visual;
286286
import ceramic.VisualTransition;
287287
import ceramic.WatchDirectory;
288288
import ceramic.WaitCallbacks;
289+
import ceramic.AntialiasedTriangle;
290+
import ceramic.AppXUpdatesHandler;
291+
import ceramic.AtlasAsset;
292+
import ceramic.CardinalSpline;
293+
import ceramic.CeramicLogo;
294+
import ceramic.ConvertColor;
295+
import ceramic.DynamicData;
296+
import ceramic.Either;
297+
import ceramic.EntityData;
298+
import ceramic.FieldMeta;
299+
import ceramic.Float32;
300+
import ceramic.Float32Utils;
301+
import ceramic.Graphics;
302+
import ceramic.Immediate;
303+
import ceramic.ImageType;
304+
import ceramic.InputMapBase;
305+
import ceramic.InputMapRebinder;
306+
import ceramic.MeshUtils;
307+
import ceramic.NineSlice;
308+
import ceramic.NineSliceRendering;
309+
import ceramic.ParticleEmitter;
310+
import ceramic.Pinch;
311+
import ceramic.Preloadable;
312+
import ceramic.PreloadStatus;
313+
import ceramic.Preloader;
314+
import ceramic.Rect;
315+
import ceramic.Repeat;
316+
import ceramic.RenderPrimitiveType;
317+
import ceramic.RoundedRect;
318+
import ceramic.SpinLock;
319+
import ceramic.StateMachineImpl;
320+
import ceramic.TextureAtlasPacker;
321+
import ceramic.TextureWrap;
322+
import ceramic.TimelineBoolKeyframe;
323+
import ceramic.TimelineBoolTrack;
324+
import ceramic.TimelineFloatArrayKeyframe;
325+
import ceramic.TimelineFloatArrayTrack;
326+
import ceramic.Zoomer;
289327

290328
#if plugin_script
291329
import ceramic.Script;
@@ -296,9 +334,11 @@ import ceramic.ScriptUtils;
296334

297335
#if plugin_http
298336
import ceramic.Http;
337+
import ceramic.HttpHeaders;
299338
import ceramic.HttpMethod;
300339
import ceramic.HttpRequestOptions;
301340
import ceramic.HttpResponse;
341+
import ceramic.MimeType;
302342
#end
303343

304344
#if plugin_arcade
@@ -323,20 +363,24 @@ import ceramic.AutoTile;
323363
import ceramic.AutoTileKind;
324364
import ceramic.AutoTiler;
325365
import ceramic.ConvertTilemapData;
366+
import ceramic.TileSlope;
326367
import ceramic.Tilemap;
327368
import ceramic.TilemapAsset;
328369
import ceramic.TilemapData;
329370
import ceramic.TilemapEditor;
330371
import ceramic.TilemapLayer;
331372
import ceramic.TilemapLayerData;
373+
import ceramic.TilemapMesh;
332374
import ceramic.TilemapOrientation;
333375
import ceramic.TilemapParser;
334376
import ceramic.TilemapPlugin;
335377
import ceramic.TilemapQuad;
336378
import ceramic.TilemapRenderOrder;
379+
import ceramic.TilemapRenderType;
337380
import ceramic.TilemapStaggerAxis;
338381
import ceramic.TilemapStaggerIndex;
339382
import ceramic.TilemapTile;
383+
import ceramic.TilemapTmxParser;
340384
import ceramic.Tileset;
341385
import ceramic.TilesetGridOrientation;
342386
import ceramic.TilesetImage;
@@ -348,6 +392,7 @@ import ceramic.AsepriteJsonParser;
348392
import ceramic.ConvertSpriteSheet;
349393
import ceramic.Sprite;
350394
import ceramic.SpriteAsset;
395+
import ceramic.SpritePlugin;
351396
import ceramic.SpriteSheet;
352397
import ceramic.SpriteSheetAnimation;
353398
import ceramic.SpriteSheetFrame;
@@ -401,6 +446,7 @@ import ceramic.CollectionViewItemPosition;
401446
import ceramic.CollectionViewItemsBehavior;
402447
import ceramic.CollectionViewLayout;
403448
import ceramic.ColumnLayout;
449+
import ceramic.ComputedViewSize;
404450
import ceramic.ImageView;
405451
import ceramic.ImageViewScaling;
406452
import ceramic.LayersLayout;
@@ -409,6 +455,8 @@ import ceramic.LayoutDirection;
409455
import ceramic.LayoutHorizontalAlign;
410456
import ceramic.LayoutVerticalAlign;
411457
import ceramic.LinearLayout;
458+
import ceramic.PagerView;
459+
import ceramic.PagerViewDataSource;
412460
import ceramic.RowLayout;
413461
import ceramic.ScrollView;
414462
import ceramic.TextView;
@@ -428,10 +476,102 @@ import ceramic.GifCapture;
428476
#end
429477

430478
#if plugin_elements
431-
import elements.Im;
479+
import elements.ArrayPointer;
480+
import elements.BaseTextFieldView;
481+
import elements.BiBorderedTriangle;
482+
import elements.BoolPointer;
483+
import elements.BooleanFieldView;
484+
import elements.Button;
485+
import elements.CellCollectionView;
486+
import elements.CellView;
487+
import elements.CheckStatus;
488+
import elements.ChoiceStatus;
489+
import elements.ClickableIconView;
490+
import elements.ColorFieldView;
491+
import elements.ColorPickerHSBGradientView;
492+
import elements.ColorPickerHSBSpectrumView;
493+
import elements.ColorPickerHSLuvGradientView;
494+
import elements.ColorPickerHSLuvSpectrumView;
495+
import elements.ColorPickerPaletteColorView;
496+
import elements.ColorPickerView;
497+
import elements.ConfirmStatus;
432498
import elements.Context;
499+
import elements.CrossX;
500+
import elements.DragDrop;
501+
import elements.EditTextStatus;
502+
import elements.Entypo;
503+
import elements.EntypoIconView;
504+
import elements.EnumAbstractInfo;
505+
import elements.EnumValuePointer;
506+
import elements.FieldSystem;
507+
import elements.FieldUtils;
508+
import elements.FieldView;
509+
import elements.FilePickerView;
510+
import elements.FloatPointer;
511+
import elements.FormLayout;
512+
import elements.Handle;
513+
import elements.Im;
514+
import elements.ImRowLayout;
515+
import elements.ImSystem;
516+
import elements.InfoStatus;
517+
import elements.InputStyle;
518+
// IntPointer is a typedef in Im.hx, not a separate module
519+
import elements.ItalicText;
520+
import elements.LabelPosition;
521+
import elements.LabelView;
522+
import elements.LabeledFieldGroupView;
523+
import elements.LabeledFieldView;
524+
import elements.LabeledView;
525+
import elements.ListStatus;
526+
import elements.ListView;
527+
import elements.PendingDialog;
528+
import elements.PromptStatus;
529+
import elements.RelatedToFieldView;
530+
import elements.Sanitize;
531+
import elements.SanitizeTextField;
532+
import elements.Scrollbar;
533+
import elements.ScrollbarVisibility;
534+
import elements.ScrollingLayout;
535+
import elements.SelectFieldView;
536+
import elements.SelectListView;
537+
import elements.Separator;
538+
import elements.SliderFieldView;
539+
import elements.StringPointer;
540+
import elements.TabFocus;
541+
import elements.TabFocusable;
542+
import elements.TabState;
543+
import elements.TabsLayout;
544+
import elements.TextFieldView;
545+
import elements.TextUtils;
433546
import elements.Theme;
547+
import elements.Tooltip;
548+
import elements.UserData;
549+
import elements.VisualContainerView;
550+
import elements.VisualContainerViewScaling;
434551
import elements.Window;
552+
import elements.WindowData;
553+
import elements.WindowItem;
554+
import elements.WindowItemKind;
555+
#end
556+
557+
#if plugin_dialogs
558+
import ceramic.Dialogs;
559+
import ceramic.DialogsFileFilter;
560+
import ceramic.DialogsPlugin;
561+
#end
562+
563+
#if plugin_midi
564+
import ceramic.MidiOut;
565+
#end
566+
567+
#if plugin_loreline
568+
import ceramic.LorelineAsset;
569+
import ceramic.LorelinePlugin;
570+
#end
571+
572+
#if plugin_shade
573+
import shade.BaseSampler2D;
574+
import shade.BaseShader;
435575
#end
436576

437577
/**
@@ -456,18 +596,18 @@ class AllApi {
456596

457597
/**
458598
* Configures an HScript interpreter with Ceramic API bindings.
459-
*
599+
*
460600
* This method sets up all necessary variable bindings to make Ceramic
461601
* classes and utilities available within HScript environments. It's used
462602
* by the scripting plugin to provide full framework access to scripts.
463-
*
603+
*
464604
* The configuration includes:
465605
* - Global shortcuts (app, screen, audio, etc.)
466606
* - Standard Haxe libraries (Std, Math, StringTools)
467607
* - Tracker framework classes
468608
* - All Ceramic core classes
469609
* - Plugin-specific classes when available
470-
*
610+
*
471611
* @param interp The HScript interpreter to configure
472612
*/
473613
@:plugin('script')
@@ -655,6 +795,84 @@ class AllApi {
655795
interp.variables.set('VisualTransition', ceramic.VisualTransition);
656796
interp.variables.set('WatchDirectory', ceramic.WatchDirectory);
657797

798+
// New core classes (non-abstract only)
799+
interp.variables.set('AntialiasedTriangle', ceramic.AntialiasedTriangle);
800+
interp.variables.set('AppXUpdatesHandler', ceramic.AppXUpdatesHandler);
801+
interp.variables.set('AtlasAsset', ceramic.AtlasAsset);
802+
interp.variables.set('CardinalSpline', ceramic.CardinalSpline);
803+
interp.variables.set('CeramicLogo', ceramic.CeramicLogo);
804+
interp.variables.set('ConvertColor', ceramic.ConvertColor);
805+
interp.variables.set('DynamicData', ceramic.DynamicData);
806+
interp.variables.set('EntityData', ceramic.EntityData);
807+
interp.variables.set('FieldMeta', ceramic.FieldMeta);
808+
interp.variables.set('Float32Utils', ceramic.Float32Utils);
809+
interp.variables.set('Graphics', ceramic.Graphics);
810+
interp.variables.set('Immediate', ceramic.Immediate);
811+
interp.variables.set('InputMapBase', ceramic.InputMapBase);
812+
interp.variables.set('InputMapRebinder', ceramic.InputMapRebinder);
813+
interp.variables.set('MeshUtils', ceramic.MeshUtils);
814+
interp.variables.set('NineSlice', ceramic.NineSlice);
815+
interp.variables.set('ParticleEmitter', ceramic.ParticleEmitter);
816+
interp.variables.set('Pinch', ceramic.Pinch);
817+
interp.variables.set('Preloader', ceramic.Preloader);
818+
interp.variables.set('Rect', ceramic.Rect);
819+
interp.variables.set('Repeat', ceramic.Repeat);
820+
interp.variables.set('RoundedRect', ceramic.RoundedRect);
821+
interp.variables.set('TextureAtlasPacker', ceramic.TextureAtlasPacker);
822+
interp.variables.set('TimelineBoolKeyframe', ceramic.TimelineBoolKeyframe);
823+
interp.variables.set('TimelineBoolTrack', ceramic.TimelineBoolTrack);
824+
interp.variables.set('TimelineFloatArrayKeyframe', ceramic.TimelineFloatArrayKeyframe);
825+
interp.variables.set('TimelineFloatArrayTrack', ceramic.TimelineFloatArrayTrack);
826+
interp.variables.set('Zoomer', ceramic.Zoomer);
827+
828+
#if plugin_dialogs
829+
interp.variables.set('Dialogs', ceramic.Dialogs);
830+
interp.variables.set('DialogsPlugin', ceramic.DialogsPlugin);
831+
#end
832+
833+
#if plugin_midi
834+
interp.variables.set('MidiOut', ceramic.MidiOut);
835+
#end
836+
837+
#if plugin_loreline
838+
interp.variables.set('LorelineAsset', ceramic.LorelineAsset);
839+
interp.variables.set('LorelinePlugin', ceramic.LorelinePlugin);
840+
#end
841+
842+
#if plugin_shade
843+
interp.variables.set('Bloom', shaders.Bloom);
844+
interp.variables.set('Blur', shaders.Blur);
845+
interp.variables.set('Fxaa', shaders.Fxaa);
846+
interp.variables.set('GaussianBlur', shaders.GaussianBlur);
847+
interp.variables.set('Glow', shaders.Glow);
848+
interp.variables.set('InnerLight', shaders.InnerLight);
849+
interp.variables.set('Msdf', shaders.Msdf);
850+
interp.variables.set('Outline', shaders.Outline);
851+
interp.variables.set('PixelArtShader', shaders.PixelArt);
852+
interp.variables.set('Textured', shaders.Textured);
853+
interp.variables.set('TintBlack', shaders.TintBlack);
854+
#end
855+
856+
#if plugin_http
857+
interp.variables.set('MimeType', ceramic.MimeType);
858+
#end
859+
860+
#if plugin_ui
861+
interp.variables.set('ComputedViewSize', ceramic.ComputedViewSize);
862+
interp.variables.set('PagerView', ceramic.PagerView);
863+
interp.variables.set('PagerViewDataSource', ceramic.PagerViewDataSource);
864+
#end
865+
866+
#if plugin_tilemap
867+
interp.variables.set('TilemapMesh', ceramic.TilemapMesh);
868+
interp.variables.set('TileSlope', ceramic.TileSlope);
869+
interp.variables.set('TilemapTmxParser', ceramic.TilemapTmxParser);
870+
#end
871+
872+
#if plugin_sprite
873+
interp.variables.set('SpritePlugin', ceramic.SpritePlugin);
874+
#end
875+
658876
}
659877

660878
#end

0 commit comments

Comments
 (0)