AccessPoint

AccessPoint

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• GameCenter_AccessPoint_SetActive
• GameCenter_AccessPoint_GetActive
• GameCenter_AccessPoint_SetLocation
• GameCenter_AccessPoint_GetLocation
• GameCenter_AccessPoint_IsPresentingGameCenter
• GameCenter_AccessPoint_IsVisible
• GameCenter_AccessPoint_SetShowHighlights
• GameCenter_AccessPoint_GetShowHighlights
• GameCenter_AccessPoint_GetCoordinate
• GameCenter_AccessPoint_PresentWithState
• GameCenter_AccessPoint_Present

Constants

This module includes a set of predefined constants that can be utilized for various purposes. Browse through the available constants to find values relevant to your needs and enhance the efficiency of your code.

• GameCenter_AccessPoint_Location
• GameCenter_AccessPoint_Coordinate
• GameCenter_AccessPoint_State

---

Back To Top

GameCenter_AccessPoint_SetActive

Set a boolean value that determines whether to display the access point.

Syntax:

GameCenter_AccessPoint_SetActive(isActive)

Argument	Type	Description
isActive	Boolean	Whether the access point should be active.

Returns:

N/A

Example:

GameCenter_AccessPoint_SetActive(true);

---

Back To Top

GameCenter_AccessPoint_GetActive

Get a boolean value that determines whether to display the access point.

Syntax:

GameCenter_AccessPoint_GetActive()

Returns:

Boolean

Example:

var _active = GameCenter_AccessPoint_GetActive();

---

Back To Top

GameCenter_AccessPoint_SetLocation

Set the corner of the screen to display the access point.

Syntax:

GameCenter_AccessPoint_SetLocation(pointlocation)

Argument	Type	Description
pointlocation	GameCenter_AccessPoint_Location	The corner of the screen to display the access point.

Returns:

N/A

Example:

GameCenter_AccessPoint_SetLocation(GameCenter_AccessPoint_Location_BottomLeading);

---

Back To Top

GameCenter_AccessPoint_GetLocation

Get the corner of the screen to display the access point.

Syntax:

GameCenter_AccessPoint_GetLocation()

Returns:

GameCenter_AccessPoint_Location

Example:

var _location = GameCenter_AccessPoint_GetLocation();
switch(_location) {
    case GameCenter_AccessPoint_Location_TopLeading:
        break;
    case GameCenter_AccessPoint_Location_TopTrailing:
        break;
    case GameCenter_AccessPoint_Location_BottomLeading:
        break;
    case GameCenter_AccessPoint_Location_BottomTrailing:
        break;
 }

---

Back To Top

GameCenter_AccessPoint_IsPresentingGameCenter

A boolean value that indicates whether the game is presenting the Game Center dashboard.

Syntax:

GameCenter_AccessPoint_IsPresentingGameCenter()

Returns:

Boolean

Example:

var _presenting = GameCenter_AccessPoint_IsPresentingGameCenter();

---

Back To Top

GameCenter_AccessPoint_IsVisible

A boolean value that indicates whether the access point is visible.

Syntax:

GameCenter_AccessPoint_IsVisible()

Returns:

Boolean

Example:

var _visible = GameCenter_AccessPoint_IsVisible();

---

Back To Top

GameCenter_AccessPoint_SetShowHighlights

Set a boolean value that indicates whether to display highlights for achievements and current ranks for leaderboards.

Syntax:

GameCenter_AccessPoint_SetShowHighlights(show)

Argument	Type	Description
show	Boolean	Whether to display highlights for achievements and current ranks for leaderboards.

Returns:

N/A

Example:

GameCenter_AccessPoint_SetShowHighlights(true);

---

Back To Top

GameCenter_AccessPoint_GetShowHighlights

Get a boolean value that indicates whether to display highlights for achievements and current ranks for leaderboards.

Syntax:

GameCenter_AccessPoint_GetShowHighlights()

Returns:

Boolean

Example:

var _highlights = GameCenter_AccessPoint_GetShowHighlights();

---

Back To Top

GameCenter_AccessPoint_GetCoordinate

Get information on the frame of the access point in screen coordinates.

Syntax:

GameCenter_AccessPoint_GetCoordinate(coordinate)

Argument	Type	Description
coordinate	GameCenter_AccessPoint_Coordinate	The type of coordinate to get.

Returns:

Real

Example:

var _origin = [
    GameCenter_AccessPoint_GetCoordinate(GameCenter_AccessPoint_Coordinate_OriginX),
    GameCenter_AccessPoint_GetCoordinate(GameCenter_AccessPoint_Coordinate_OriginY)
];

---

Back To Top

GameCenter_AccessPoint_PresentWithState

This function displays the Game Center dashboard in the specified state.

Syntax:

GameCenter_AccessPoint_PresentWithState(state)

Argument	Type	Description
state	GameCenter_AccessPoint_State	The state in which to display the dashboard.

Returns:

N/A

Example:

GameCenter_AccessPoint_PresentWithState(GameCenter_AccessPoint_State_Achievements);

---

Back To Top

GameCenter_AccessPoint_Present

This function displays the Game Center dashboard.

Syntax:

GameCenter_AccessPoint_Present()

Returns:

N/A

Example:

GameCenter_AccessPoint_Present();

---

Back To Top

GameCenter_AccessPoint_Location

Location of the access point

These constants are referenced by the following functions:

• GameCenter_AccessPoint_SetLocation
• GameCenter_AccessPoint_GetLocation

Member	Description
GameCenter_AccessPoint_Location_TopLeading	The access point is in the upper-left corner of the screen.
GameCenter_AccessPoint_Location_TopTrailing	The access point is in the upper-right corner of the screen.
GameCenter_AccessPoint_Location_BottomLeading	The access point is in the lower-left corner of the screen.
GameCenter_AccessPoint_Location_BottomTrailing	The access point is in the lower-right corner of the screen.

---

Back To Top

GameCenter_AccessPoint_Coordinate

Coordinate of the access point

These constants are referenced by the following functions:

• GameCenter_AccessPoint_GetCoordinate

Member	Description
GameCenter_AccessPoint_Coordinate_OriginX	The origin position x coordinate of the access point
GameCenter_AccessPoint_Coordinate_OriginY	The origin position y coordinate of the access point
GameCenter_AccessPoint_Coordinate_SizeWidth	The width of the access point
GameCenter_AccessPoint_Coordinate_SizeHeight	The height of the access point

---

Back To Top

GameCenter_AccessPoint_State

State of the access point

These constants are referenced by the following functions:

• GameCenter_AccessPoint_PresentWithState

Member	Description
GameCenter_AccessPoint_State_Default	The access point presents the default screen.
GameCenter_AccessPoint_State_Leaderboards	The access point presents leaderboard sets or leaderboards if there are no sets.
GameCenter_AccessPoint_State_Achievements	The access point presents a list of achievements.
GameCenter_AccessPoint_State_Challenges	The access point presents a list of challenges.
GameCenter_AccessPoint_State_LocalPlayerProfile	The access point presents the local player’s profile.
GameCenter_AccessPoint_State_Dashboard	The access point presents the dashboard.
GameCenter_AccessPoint_State_LocalPlayerFriendsList	The access point presents the friends list.