Files
Patryk Gensch df6cf2f3d3
Some checks failed
docs / deploy (push) Has been cancelled
docs / build (push) Has been cancelled
Added part of docs
2026-05-19 20:51:59 +02:00

3.8 KiB
Raw Permalink Blame History

SEQUENCE

Sekwencja animacji. Plik .SEQ zawiera zdarzenia sekwencji — opisy ciągów animacji (ANIMO) odtwarzanych jednocześnie z towarzyszącymi im efektami dźwiękowymi (SOUND). Pozwala synchronizować ze sobą obraz i dźwięk w jednej, sterowanej skryptowo jednostce.

Pola

FILENAME

STRING FILENAME

Ścieżka do pliku .SEQ z definicją sekwencji.

Metody

GETEVENTNAME

STRING GETEVENTNAME()

Zwraca nazwę aktualnie odtwarzanego zdarzenia sekwencji.

Zwraca: nazwa zdarzenia.

Przykłady

SEQSFX^GETEVENTNAME();

GETPLAYING

STRING GETPLAYING()

Zwraca nazwę zmiennej typu ANIMO odtwarzanej w ramach aktualnie aktywnego zdarzenia. Jeżeli żadne zdarzenie nie jest aktywne, zwracany jest pusty ciąg.

Zwraca: nazwa animacji lub "".

HIDE

void HIDE()

Ukrywa wszystkie animacje, które należą do sekwencji.

Przykłady

SEQJEAN^HIDE();
SEQKRET^HIDE();

ISPLAYING

BOOL ISPLAYING()

Sprawdza, czy sekwencja jest aktualnie odtwarzana.

Zwraca: BOOLTRUE, jeżeli sekwencja jest w trakcie odtwarzania.

Przykłady

SEQBLANK^ISPLAYING();
SEQMANDOLINA^ISPLAYING();

PAUSE

void PAUSE()

Wstrzymuje odtwarzanie sekwencji.

Przykłady

SEQCS^PAUSE();

PLAY

void PLAY(STRING eventName)

Rozpoczyna odtwarzanie zdarzenia sekwencji o podanej nazwie. Po starcie emitowany jest sygnał ONSTARTED z nazwą zdarzenia.

Parametry

  • eventName — nazwa zdarzenia z pliku .SEQ.

Przykłady

GADAJA2^PLAY("KOGF2");
SEQNARRATOR^PLAY(VARSTRING0);
SEQLAB^PLAY(["PLAYER"+VARINT0]);
SEQREKSIO^PLAY($1);

RESUME

void RESUME()

Wznawia sekwencję wstrzymaną przez PAUSE.

Przykłady

SEQCS^RESUME();

SETFREQ

void SETFREQ(INTEGER sampleRate)

Ustawia próbkowanie odtwarzania dźwięku przypisanego do aktualnie aktywnego zdarzenia sekwencji. Działanie równoważne wywołaniu SETFREQ na obiekcie SOUND tego zdarzenia.

Parametry

  • sampleRate — docelowe próbkowanie w Hz.

SETPAN

void SETPAN(INTEGER pan)

Ustawia panoramę stereo (rozkład lewyprawy) dźwięku aktywnego zdarzenia. Wartość 400 odpowiada panoramie wycentrowanej, 0 — pełnemu kanałowi lewemu, 800 — pełnemu kanałowi prawemu.

Parametry

  • pan — wartość panoramy w zakresie 0800.

SETVOLUME

void SETVOLUME(INTEGER volume)

Ustawia głośność dźwięku aktywnego zdarzenia. Wartość 1600 odpowiada maksymalnej głośności, 0 — wyciszeniu.

Parametry

  • volume — wartość głośności w zakresie 01600.

SHOW

void SHOW()

Pokazuje wszystkie animacje należące do sekwencji.

STOP

void STOP([BOOL emitSignal])

Zatrzymuje odtwarzanie sekwencji.

Parametry

  • emitSignal — (opcjonalnie) jeżeli FALSE, sygnał ONFINISHED nie zostanie wyemitowany. Domyślnie sygnał jest emitowany.

Przykłady

SEQBLANK^STOP(FALSE);
SEQMENU^STOP(TRUE);
SEQZMIANAWAGIREX^STOP();

Sygnały

ONINIT

Wywoływany w momencie inicjalizacji obiektu.

ONSTARTED

Wywoływany po rozpoczęciu odtwarzania zdarzenia sekwencji. Argumentem ($1) jest nazwa rozpoczętego zdarzenia.

ONFINISHED

Wywoływany po zakończeniu odtwarzania zdarzenia sekwencji (naturalnym lub przez metodę STOP bez argumentu FALSE). Argumentem ($1) jest nazwa zakończonego zdarzenia. Sygnał jest parametryzowany tą nazwą, więc można podpiąć obsługę pod konkretne zdarzenie:

SEKWENCJA:ONFINISHED^IDLE=BEHAFTERIDLE

ONSIGNAL

Wywoływany po otrzymaniu sygnału (zobacz Zdarzenia i sygnały).