Fixes Functions not in TS definition files #60 #61

SimpleProgrammingAU · 2020-12-25T23:49:28Z

As I am new to using react-native-game-engine I am not 100% that all of the correct functions have been exposed. Please review the changes I have made to ensure they match the expected use of the library.

Performs type checking for the renderer property, thus preventing anything other than JSX, or a reference to the React component class. Using the component class rather than a JSX element avoids issues with required props.

bberak · 2021-01-05T01:40:05Z

react-native-game-engine.d.ts


+    type GameEngineEntities = Record<string | number, GameEngineEntity>;
+
    export interface GameEngineProperties {
      systems?: any[];
      entities?: {} | Promise<any>;
      renderer?: any;


Hey @SimpleProgrammingAU - this all looks really good. Quick question, should this line be: renderer?: DefaultRenderer | any; ?

It should probably be renderer: Renderer and change the type definition for DefaultRenderer to Renderer to make it a bit more inclusive.

I see.. I ask because of this change that you made: timer?: DefaultTimer | any; - hence I was thinking we do the same for the renderer for the sake of consistency..

What exactly did you mean by:

and change the type definition for DefaultRenderer to Renderer to make it a bit more inclusive.

Are you saying that the Default in DefaultRenderer is redundant from a naming convention point of view? As in, the DefaultRenderer function should simple adhere to a Renderer function signature?

Lastly, since I'm not 100% across TS, would changing the name break anything from a backwards compatibility, tooling and intellisense (VS Code?) perspective?

Let me have a play around with somethings myself because I'm not 100%, either! I'll get back to you tomorrow (I'm UTC+11) with either a new commit or more commentary =)

@SimpleProgrammingAU I'm curious where this ended up. Any updates on your findings?

drplauska · 2022-05-29T14:59:10Z

@bberak what's the situation for this pull request? is something missing? I'm willing to participate

bberak · 2022-05-29T23:58:27Z

Much appreciated @drplauska,

I think we just need someone who is comfortable with TS to verify that this PR won't break backwards compatibility.

Also, I think we need to rename the following types:

DefaultTimer -> Timer
DefaultRenderer -> Renderer

Then update the GameEngineProperties interface to use the new type names (Timer, Renderer).

drplauska · 2022-05-31T10:35:17Z

react-native-game-engine.d.ts

-      state: any;
-      screen: ScaledSize;
-    }
+    export function DefaultRenderer(entities: any[], screen: ScaledSize, layout:LayoutRectangle): Component;


no such type LayoutRectangle

also no Component

drplauska · 2022-05-31T13:43:06Z

react-native-game-engine.d.ts

+
+    interface GameEngineEntity {
+      [key:string]: any;
+      renderer?: JSX.Element | React.ComponentClass<any. any>;


React.ComponentClass<any>

drplauska · 2022-05-31T13:43:57Z

react-native-game-engine.d.ts

+      dispatch: (event:any) => void;
+      start: () => void;
+      stop: () => void;
+      swap: ({}:any | Promise) => void | Promise<void>


swap: ({}:any | Promise<any>) => void | Promise<void>

as Promise shall have 1 argument

drplauska · 2022-05-31T13:46:49Z

react-native-game-engine.d.ts

+      stop: () => void;
+      subscribe: (callback: () => void) => void;
+      unsubscribe: (callback: () => void) => void;
+    }

    interface TouchProcessorOptions {


it seems like arguments for this interface may be optional because there are default values provided:

export default ({ triggerPressEventBefore = 200, triggerLongPressEventAfter = 700, moveThreshold = 0 }) => {

drplauska · 2022-05-31T13:50:48Z

react-native-game-engine.d.ts


+    type GameEngineEntities = Record<string | number, GameEngineEntity>;


what is this for? Doesn't look like it's used anywhere

drplauska · 2022-05-31T13:54:53Z

react-native-game-engine.d.ts

      running?: boolean;
      onEvent?: any;
      style?: StyleProp<ViewStyle>;
      children?: React.ReactNode;
    }

-    export class GameEngine extends React.Component<GameEngineProperties> {}
+    export class GameEngine extends React.Component<GameEngineProperties> {


add
render: () => JSX.Element;

drplauska · 2022-05-31T13:55:14Z

react-native-game-engine.d.ts

      running?: boolean;
      onUpdate?: (args: GameLoopUpdateEventOptionType) => void;
      style?: StyleProp<ViewStyle>;
      children?: React.ReactNode;
    }

-    export class GameLoop extends React.Component<GameLoopProperties> {}
+    export class GameLoop extends React.Component<GameLoopProperties> {


render: () => JSX.Element;
here too

drplauska · 2022-05-31T13:58:26Z

@bberak this doesn't look too bad, merging this shouldn't cause issues with backwards compatibility.
What would you say about rewriting the lib with typescript? It wouldn't be necessary to maintain type declaration and the project would be easier to jump into for new people
I could work on that, but would probably need a little bit of consulting

bberak · 2022-06-03T11:36:26Z

Hey @drplauska,

Really appreciate your reviews and comments 🙏 . I'm definitely not against rewriting the lib with typescript. I'd probably review the overall design of the components at the same time and perhaps opt for moving to something a bit more modern using hooks and functional components. I'm certainly open to any contributions if you're interested 👍.

drplauska · 2022-06-03T19:59:58Z

@bberak I'm gonna try and rewrite the lib asap

bberak · 2022-06-05T03:43:05Z

Hi @drplauska,

Perhaps we should just fix up the types in this PR first - to unblock people who might be relying on TS?

I'll get in touch regarding a full rewrite (I got your email btw 👍)

shreykul · 2023-10-08T05:53:14Z

Hi @bberak, This seems like a very good lib and it'd be really great if it could be maintained. Was there any conclusion to the above conversation?

bberak · 2023-10-09T03:53:00Z

Hey @shreykul

I just need to sit down and work through this PR to make sure it's working as expected.. Seems like TS support is becoming more essential for adoption these days.. I'll try work through it over the weekend; and also maybe update the handbook repo to work with the latest version of Expo..

shreykul · 2023-10-09T15:04:25Z

@bberak that'd be really great!! Can I try updating the handbook repo with typescript? I'm trying to learn typescript so it'd be a great project for me...

esphung · 2024-01-01T01:02:26Z

Hey guys, I can help too if you want I'm not new to react native or Typescript but I am trying to use this library seriously. I ran into some things that I made a patch for, but could probably fix if you need the extra set of hands. Let me know if you need help.

I can also just submit PRs. I wasn't sure if this repo was maintained because there hasn't been in update in a while

bberak · 2024-01-04T23:03:02Z

Hey @esphung 👋,

Thanks for offering to help. I'm happy to accept PRs (especially around updating/adding typing information). Also happy to chat about any other issues you ran into..

Cheers,

Boris

esphung · 2024-01-04T23:04:03Z

Can you inv me? I tried to make one but I couldn't because I want a member on GH

SimpleProgrammingAU added 2 commits December 26, 2020 10:46

Fixes Functions not in TS definition files bberak#60

ba9cd2d

Allows for type checking on the renderer property

af80426

Performs type checking for the renderer property, thus preventing anything other than JSX, or a reference to the React component class. Using the component class rather than a JSX element avoids issues with required props.

SimpleProgrammingAU mentioned this pull request Dec 27, 2020

Functions not in TypeScript definition files #60

Open

bberak reviewed Jan 5, 2021

View reviewed changes

drplauska reviewed May 31, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes Functions not in TS definition files #60 #61

Fixes Functions not in TS definition files #60 #61

SimpleProgrammingAU commented Dec 25, 2020

bberak Jan 5, 2021

SimpleProgrammingAU Jan 5, 2021

bberak Jan 5, 2021

SimpleProgrammingAU Jan 5, 2021

talon-himself May 20, 2022

drplauska commented May 29, 2022

bberak commented May 29, 2022

drplauska May 31, 2022

drplauska May 31, 2022

drplauska May 31, 2022 •

edited

Loading

drplauska May 31, 2022 •

edited

Loading

drplauska May 31, 2022

drplauska May 31, 2022

drplauska May 31, 2022

drplauska May 31, 2022

drplauska commented May 31, 2022 •

edited

Loading

bberak commented Jun 3, 2022

drplauska commented Jun 3, 2022

bberak commented Jun 5, 2022

shreykul commented Oct 8, 2023

bberak commented Oct 9, 2023

shreykul commented Oct 9, 2023 •

edited

Loading

esphung commented Jan 1, 2024 •

edited

Loading

bberak commented Jan 4, 2024

esphung commented Jan 4, 2024


		type GameEngineEntities = Record<string \| number, GameEngineEntity>;

Fixes Functions not in TS definition files #60 #61

Are you sure you want to change the base?

Fixes Functions not in TS definition files #60 #61

Conversation

SimpleProgrammingAU commented Dec 25, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drplauska commented May 29, 2022

bberak commented May 29, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drplauska May 31, 2022 • edited Loading

Choose a reason for hiding this comment

drplauska May 31, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drplauska commented May 31, 2022 • edited Loading

bberak commented Jun 3, 2022

drplauska commented Jun 3, 2022

bberak commented Jun 5, 2022

shreykul commented Oct 8, 2023

bberak commented Oct 9, 2023

shreykul commented Oct 9, 2023 • edited Loading

esphung commented Jan 1, 2024 • edited Loading

bberak commented Jan 4, 2024

esphung commented Jan 4, 2024

drplauska May 31, 2022 •

edited

Loading

drplauska May 31, 2022 •

edited

Loading

drplauska commented May 31, 2022 •

edited

Loading

shreykul commented Oct 9, 2023 •

edited

Loading

esphung commented Jan 1, 2024 •

edited

Loading