Detailed Description

Catalogue for listing servers from backend. User needs to be authenticated (see BackendAuthenticatorApi for more) to be able to send requests.

You can switch to different modes which will determine source from which it will search for servers - Internet / LAN This only influences list of available servers but details will be still fetched from the backend.

Catalogue has functionality to cache and pre-load data for faster availability but only for consecutive data. This works for limited amount of previously loaded or single next page in direction you are requesting pages. When requesting page 1 we will automatically request page 2 and afterwards when requesting page 2 it will load immediately. Page 1 will stay cached in case user will want to switch back.

You can request data either by specific pages or by offset. Both basically works same but pages have fixed offsets by currently set size to prevent need to manually calculate where every individual page begins on the offset.

Note: You must first initialize size of the catalogue before you can request any data. Refer to SetSize() method for more details.

Definition at line 31 of file ServerCatalogueApi.c.

The documentation for this class was generated from the following file:

scripts/GameLib/generated/online/server/ServerCatalogueApi.c