DotPeek¶
Namespace: WellFired.Peek.Application.Unity
Implements: WellFired.Peek.Application.IDotPeekSessionListener
Description¶
This is a public wrapper around .:ref:Peek<namespacewellfired_peek> application. It gives access to different utilities allowing a total control of .:ref:Peek<namespacewellfired_peek>.
Properties¶
IDotPeekListener | Listener { get; set; } |
IVCS | CustomVCS { get; set; } |
Storage | Storage { get; set; } |
public-static-attrib¶
bool | SessionStarted |
IDotPeekSession | CurrentSession |
Public Static Methods¶
void | StartSession ( BuildTarget target ) |
void | EndSession ( ) |
void | OpenWindow ( ) |
Public Methods¶
void | DoBuildReportGenerated ( string reportAbsolutePath ) |
Breakdown¶
IDotPeekListener Listener { get; set; }
Description
Give access to .:ref:Peek<namespacewellfired_peek> callbacks, like when the report is generated and where it is stored for example.
IVCS CustomVCS { get; set; }
Description
Allows to provide a custom commit id to .:ref:Peek<namespacewellfired_peek> when it is generating the build report.
Storage Storage { get; set; }
Description
Allows to read or modify .:ref:Peek<namespacewellfired_peek> settings on the disk.
bool SessionStarted
Description
Returns true if a session was started already.
IDotPeekSession CurrentSession
Description
Returns the current IDotPeekSession.
void StartSession ( BuildTarget target )
Description
Creates a new IDotPeekSession that will receive the different callbacks from the game engine when build is being processed. When a new session is started, then the previous one is not referenced anymore.
void EndSession ( )
Description
Finishes a IDotPeekSession.
void OpenWindow ( )
Description
Open the DotPeek window in Unity.
void DoBuildReportGenerated ( string reportAbsolutePath )
Description
This is called after the build report was generated and saved on the disk.