Class KaijuOverlay

Handles Steam overlay functionality.

Inheritance

System.Object

KaijuOverlay

Namespace: KaijuSolutions.MultiplayerEngine

Syntax

public static class KaijuOverlay

Properties

Enabled

If the overlay is running and the user can access it.

Declaration

public static bool Enabled { get; }

Property Value

Type	Description
System.Boolean

Methods

AcceptFriend(UInt64)

Open the overlay for accepting a friend request with minimal prompting.

Declaration

public static bool AcceptFriend(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Achievements()

Open the achievements overlay.

Declaration

public static bool Achievements()

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Achievements(UInt64)

Open the overlay to open the achievements of a user.

Declaration

public static bool Achievements(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

AchievementsBindable()

Open the achievements overlay.

Declaration

public static void AchievementsBindable()

AddFriend(UInt64)

Open the overlay for accepting a friend with minimal prompting.

Declaration

public static bool AddFriend(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

BottomLeft()

Set the notification position to the bottom left.

Declaration

public static bool BottomLeft()

Returns

Type	Description
System.Boolean	If the notification position was successfully set.

BottomLeftBindable()

Set the notification position to the bottom left.

Declaration

public static void BottomLeftBindable()

BottomRight()

Set the notification position to the bottom right.

Declaration

public static bool BottomRight()

Returns

Type	Description
System.Boolean	If the notification position was successfully set.

BottomRightBindable()

Set the notification position to the bottom right.

Declaration

public static void BottomRightBindable()

Chat(UInt64)

Open the overlay to chat with a user.

Declaration

public static bool Chat(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Community()

Open the community overlay.

Declaration

public static bool Community()

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

CommunityBindable()

Open the community overlay.

Declaration

public static void CommunityBindable()

Friends()

Open the friends overlay.

Declaration

public static bool Friends()

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

FriendsBindable()

Open the friends overlay.

Declaration

public static void FriendsBindable()

IgnoreFriend(UInt64)

Open the overlay for ignoring a friend request with minimal prompting.

Declaration

public static bool IgnoreFriend(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Inset(Int32)

Set the notification inset.

Declaration

public static bool Inset(int distance)

Parameters

Type	Name	Description
System.Int32	distance	The distance for both the horizontal and vertical distances in pixels from the corner.

Returns

Type	Description
System.Boolean	If the notification inset was set.

Inset(Int32, Int32)

Set the notification inset.

Declaration

public static bool Inset(int horizontal, int vertical)

Parameters

Type	Name	Description
System.Int32	horizontal	The horizontal distance in pixels from the corner.
System.Int32	vertical	The vertical distance in pixels from the corner.

Returns

Type	Description
System.Boolean	If the notification inset was set.

InsetReset()

Reset the notification inset.

Declaration

public static bool InsetReset()

Returns

Type	Description
System.Boolean	If the notification inset was reset.

InsetResetBindable()

Reset the notification inset.

Declaration

public static void InsetResetBindable()

Invite()

Open the invite overlay. Only works if currently in a lobby that has open space.

Declaration

public static bool Invite()

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

InviteBindable()

Open the invite overlay. Only works if currently in a lobby that has open space.

Declaration

public static void InviteBindable()

OfficialGameGroup()

Open the official game group overlay.

Declaration

public static bool OfficialGameGroup()

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

OfficialGameGroupBindable()

Open the official game group overlay.

Declaration

public static void OfficialGameGroupBindable()

Players()

Open the players overlay.

Declaration

public static bool Players()

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

PlayersBindable()

Open the players overlay.

Declaration

public static void PlayersBindable()

Profile(UInt64)

Open the overlay to a user's profile.

Declaration

public static bool Profile(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

RemoveFriend(UInt64)

Open the overlay for removing a friend with minimal prompting.

Declaration

public static bool RemoveFriend(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Settings()

Open the settings overlay.

Declaration

public static bool Settings()

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

SettingsBindable()

Open the settings overlay.

Declaration

public static void SettingsBindable()

Stats()

Open the stats overlay.

Declaration

public static bool Stats()

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Stats(UInt64)

Open the overlay to open the stats of a user.

Declaration

public static bool Stats(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

StatsBindable()

Open the stats overlay.

Declaration

public static void StatsBindable()

Store(Boolean)

Open the overlap to the store page of this app.

Declaration

public static bool Store(bool addToCart = false)

Parameters

Type	Name	Description
System.Boolean	addToCart	If this should automatically add this item to the cart or not.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Store(UInt32, Boolean)

Open the overlap to the store page of the given app.

Declaration

public static bool Store(uint app, bool addToCart = false)

Parameters

Type	Name	Description
System.UInt32	app	The app to open the store page to.
System.Boolean	addToCart	If this should automatically add this item to the cart or not.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

StoreAddToCartBindable()

Open the overlap to the store page of this app and add it to the user's cart.

Declaration

public static void StoreAddToCartBindable()

StoreBindable()

Open the overlap to the store page of this app.

Declaration

public static void StoreBindable()

TopLeft()

Set the notification position to the top left.

Declaration

public static bool TopLeft()

Returns

Type	Description
System.Boolean	If the notification position was successfully set.

TopLeftBindable()

Set the notification position to the top left.

Declaration

public static void TopLeftBindable()

TopRight()

Set the notification position to the top right.

Declaration

public static bool TopRight()

Returns

Type	Description
System.Boolean	If the notification position was successfully set.

TopRightBindable()

Set the notification position to the top right.

Declaration

public static void TopRightBindable()

Trade(UInt64)

Open the overlay to trade with a user.

Declaration

public static bool Trade(ulong user)

Parameters

Type	Name	Description
System.UInt64	user	The user.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Web(String, Boolean)

Open the overlay to a specific URL.

Declaration

public static bool Web(string url, bool only = false)

Parameters

Type	Name	Description
System.String	url	The URL. This must be a complete URL, starting with either "https://" or "http://". If it starts with neither, "http://" will be appended to the start.
System.Boolean	only	If this should open in a special overlay configuration which hides all other windows that the user has open in the overlay. When the user closes the overlay, the browser window will also close. When the user closes the browser window, the overlay will automatically close.

Returns

Type	Description
System.Boolean	If the overlay was opened or not.

Events

OnOverlayDisabled

Callback for the overlay being disabled.

Declaration

public static event KaijuMultiplayerManager.EmptyEventHandler OnOverlayDisabled

Event Type

Type	Description
KaijuMultiplayerManager.EmptyEventHandler

OnOverlayEnabled

Callback for the overlay being enabled.

Declaration

public static event KaijuMultiplayerManager.EmptyEventHandler OnOverlayEnabled

Event Type

Type	Description
KaijuMultiplayerManager.EmptyEventHandler