ScoreFlashLayout MembersScoreFlash API Documentation V4.6.0

The ScoreFlashLayout type exposes the following members.
Constructors

  NameDescription
Public methodScoreFlashLayout
Back to Top
Methods

  NameDescription
Public methodCreateDesignerMessage
Creates a ScoreMessage to be used in the designer.
(Overrides ScoreFlashBase CreateDesignerMessage(String).)
Public methodPush(Object)
Shortcut for pushing messages directly using this ScoreFlashLayout instance.
Public methodPush(Object, Color)
Shortcut for pushing messages in a specific color directly using this ScoreFlashLayout instance.
Public methodUpgradeCheck
Performs a couple of checks to ensure that everything is set up correctly after an upgrade to a new version.
(Overrides ScoreFlashBase UpgradeCheck .)
Back to Top
Fields

  NameDescription
Public fielddefaultScoreFlash
If assigned, instead of using ScoreFlash.Instance, this ScoreFlashLayout will use the assigned ScoreFlash instance when messages are pushed directly via Push(Object).
Public fielddesignText
Message that is shown while in design mode.
Public fieldenableDeselectHack
Unity doesn't properly support updating the GameView when an object is deselected, so if you disable this, the design will stay in the game view until it is updated once more. I have a hack for this - but unfortunately, it's causing trouble when the object is being deleted (there's an exception that I cannot catch). Both is not a real problem, it's just a little annoying.
Public fieldfreezeOnRead
Freeze any message pushed directly to this ScoreFlashLayout at its read state.
Public fieldinnerAnchor
Use this to control the anchor / alignment of the messages sent using this instance of ScoreFlashLayout.
Public fieldisDesignMode
Design mode allows you to use the scene view to set up the positioning of this ScoreFlashLayout. This works both while playing and while not playing, however, if you have moving options, you might want to pause the game to set things up (otherwise you might chase your messages around ;-) ).
Public fieldisTestAutogenerateMessages
Use this to show random messages.
Public fieldlockInnerAnchor
Locks the innerAnchor to screenAlign.
Public fieldlockScreenAlign
Locks the screen alignment. This is only used by the visual designer.
Public fieldmaxWidth
Maximum width of the message before it's wrapped. This works together with minPaddingX.
Public fieldminPaddingX
Minimum distance between the message and the left/right screen borders before the message is wrapped in two (or more) lines. This works together with maxWidth.
Public fieldposition
Public fieldscreenAlign
Controls whether the message is aligned to top, middle or bottom of the screen. Defines how position is applied. Possible values are defined by NGAlignment ScreenAlign.
Public fieldtestMessageDelaySeconds
The usual delay between two messages in seconds. Use this to increase or decrease the frequency in which test messages are being sent to ScoreFlash. NOTE: This does not have an effect on messages sent via includeMessageSpam (these are always sent in a burst without any delay. Also be aware that this is based on real time (so Time.timeScale has no effect).
Back to Top
Properties

  NameDescription
Public propertyCurrentMessage
Provides access to the current message, which is always the last message that was sent through Push(Object) or Push(Object, Color). You can use this to change the message without going through the animations. This is usually used together with freezeOnRead.
Public propertyDefaultScoreFlash
Publicly accessibly ScoreFlash instance that this ScoreFlashLayout uses. If it is not assigned, simply returns ScoreFlash.Instance.
(Overrides ScoreFlashBase DefaultScoreFlash.)
Public propertyInnerAnchor
The inner anchor for this layout instance. See innerAnchor.
(Overrides ScoreFlashBase InnerAnchor.)
Public propertyIsDesignMode
Is the designer actually switched on? See isDesignMode.
(Overrides ScoreFlashBase IsDesignMode.)
Public propertyLockInnerAnchor
Is the inner anchor currently locked to the screen alignment? See lockInnerAnchor.
(Overrides ScoreFlashBase LockInnerAnchor.)
Public propertyLockScreenAlign
Shall we lock screen align? See lockScreenAlign.
(Overrides ScoreFlashBase LockScreenAlign.)
Public propertyMaxWidth
The maximum width of the items. See maxWidth.
(Overrides ScoreFlashBase MaxWidth.)
Public propertyMinPaddingX
The minimum padding of the items. See minPaddingX.
(Overrides ScoreFlashBase MinPaddingX.)
Public propertyPosition
The position, see position.
(Overrides ScoreFlashBase Position.)
Public propertyPositionWorld
Always return null.
(Overrides ScoreFlashBase PositionWorld.)
Public propertyScreenAlign
The screen align for this layout instance. See screenAlign.
(Overrides ScoreFlashBase ScreenAlign.)
Public propertySupportsInnerAnchor
Returns true.
(Overrides ScoreFlashBase SupportsInnerAnchor.)
Public propertySupportsScreenAlign
Returns true.
(Overrides ScoreFlashBase SupportsScreenAlign.)
Back to Top
See Also