Show / Hide Table of Contents

    Interface IRoomTransitions

    Allows to set the room transitions (and to get some information on the transitions)

    Namespace: AGS.API
    Assembly: AGS.API.dll
    Syntax
    public interface IRoomTransitions

    Properties

    | Improve this Doc View Source

    Transition

    Gets or sets the room transition. All future room transitions will use this transition until a new one has been set.

    Declaration
    IRoomTransition Transition { get; set; }
    Property Value
    Type Description
    IRoomTransition

    The transition.

    Examples

    Let's set a box out transition:

    _gameState.RoomTransitions.Transition = AGSRoomTransitions.BoxOut();

    Methods

    | Improve this Doc View Source

    SetOneTimeNextTransition(IRoomTransition)

    Sets a one time transition. This transition will only be used once (for the next room transition), and then the old transition will be used again.

    Declaration
    void SetOneTimeNextTransition(IRoomTransition transition)
    Parameters
    Type Name Description
    IRoomTransition transition

    The room transition to be used once.

    Examples

    Let's set a dissolve transition, only for the next room transition:

    _gameState.RoomTransitions.SetOneTimeNextTransition(AGSRoomTransitions.Dissolve());
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX