Artemis Artemis
Artemis Artemis

Search Results for

    Class ProfileScript

    Represents a script bound to a specific Profile processed by a ScriptingProvider.

    Inheritance
    object
    CorePropertyChanged
    Script
    ProfileScript
    Implements
    IDisposable
    Inherited Members
    Script.Dispose(bool)
    Script.OnScriptContentChanged()
    Script.Dispose()
    Script.ScriptingProvider
    Script.ScriptConfiguration
    Script.ScriptContentChanged
    Namespace: Artemis.Core.ScriptingProviders
    Assembly: Artemis.Core.dll
    Syntax
    public abstract class ProfileScript : Script, IDisposable

    Constructors

    ProfileScript(Profile, ScriptConfiguration)

    Declaration
    protected ProfileScript(Profile profile, ScriptConfiguration configuration)
    Parameters
    Type Name Description
    Profile profile
    ScriptConfiguration configuration

    Properties

    Profile

    Gets the profile this script is bound to

    Declaration
    public Profile Profile { get; }
    Property Value
    Type Description
    Profile

    ScriptType

    Gets the script type of this script

    Declaration
    public override ScriptType ScriptType { get; }
    Property Value
    Type Description
    ScriptType
    Overrides
    Script.ScriptType

    Methods

    OnProfileRendered(SKCanvas, SKRect)

    Called whenever the profile has been rendered

    Declaration
    public virtual void OnProfileRendered(SKCanvas canvas, SKRect bounds)
    Parameters
    Type Name Description
    SKCanvas canvas

    The profile canvas

    SKRect bounds

    The area to be filled, covers the entire canvas

    OnProfileRendering(SKCanvas, SKRect)

    Called whenever the profile is about to render

    Declaration
    public virtual void OnProfileRendering(SKCanvas canvas, SKRect bounds)
    Parameters
    Type Name Description
    SKCanvas canvas

    The profile canvas

    SKRect bounds

    The area to be filled, covers the entire canvas

    OnProfileUpdated(double)

    Called whenever the profile has been updated

    Declaration
    public virtual void OnProfileUpdated(double deltaTime)
    Parameters
    Type Name Description
    double deltaTime

    Seconds passed since last update

    OnProfileUpdating(double)

    Called whenever the profile is about to update

    Declaration
    public virtual void OnProfileUpdating(double deltaTime)
    Parameters
    Type Name Description
    double deltaTime

    Seconds passed since last update

    Implements

    IDisposable
    Content is available under the PolyForm Noncommercial License, by Artemis RGB.