Image Field

Like what your seeing?

Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude. These articles are made possible by our GitHub Sponsors ... become a sponsor today!

Introduction

A sub struct used by the built in FriendProfile to define the settings for image fields on that control. The ImageField struct simply provides a pointer to an image to be used a flag to enable or disable the use of coloring options and the values for the color options to be used.

public struct FriendProfile.ImageField

Fields and Attributes

image

public Image image

A reference to the image to be used

useStatusColors

public bool useStatusColors

A boolean indicating rather or not the system should apply colouring to the image based on status.

inThisGame

public Color inThisGame

The color to be applied to the image when the related user is found to be playing the same App ID as the App ID for this instance of Steam API.

inOtherGame

public Color inOtherGame

The color to be applied to the image when the related user is found to be in an App other than the App for this instance of Steam API.

isOnlineActive

public Color isOnlineActive

The color to be applied to the image when the related user is not in a game/app but is online and is active.

isOnlineInactive

public Color isOnlineInactive

The color to be applied to the image when the related user is not in a game/app but is online and is not active.

isOffline

public Color isOffline

The color to be applied to the image when the related user is not online at all.

Methods

SetValue

public void SetValue(bool inGame, bool inThisGame, EPersonaState state)

Called when setting the value of the image and provides information about the related user.