Push Method (Object, , )

ScoreFlash Push Method (Object, , )

ScoreFlash API Documentation V4.6.0

Shows msg using style or styleHighDensity depending on whether we are on a normal density or high density screen (determined using IsHighDensityDisplay. It's up to you to make sure that style works correctly. It is recommended that it has alignment set to UpperCenter and wordWrap set to false (word wrap is automatically activated if the message is too long to be properly displayed on screen with minPaddingX.

Namespace: (Default Namespace)
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0

Syntax

C++

Copy to Clipboard Print

public static ScoreMessage Push(
	Object message,
	GUIStyle style,
	GUIStyle styleHighDensity
)

public static ScoreMessage Push(
	Object message,
	GUIStyle style,
	GUIStyle styleHighDensity
)

Parameters

message: Type: System Object
The message to be animated by ScoreFlash. This can be a string, a fully configured custom renderer, an int, long, float, double or any object with a useful ToString() method

style: Type: GUIStyle
a custom style to be used on normal density screens, or null to use the custom style ScoreFlash of skin (this parameter is optional!) If you have a specific color assigned to that style that you want to be used, you need to have "Colors / Color Selection Mode" set to UseColorFromSkin (see colorSelectionMode, ScoreFlash ColorControl).

styleHighDensity: Type: GUIStyle
the style to be used for the message on high density screens

Return Value

the ScoreMessage representing the message

Remarks

Internally, this uses Instance, so it only works when ensureSingleton is true and/or there is only one instance of ScoreFlash in the current scene.