CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomExSequencer Class Reference

A class for controlling the Sequence data. More...

Classes

struct  CriAtomExSequenceEventInfo
 Structure to get information about a sequence event More...
 

Public Member Functions

delegate void EventCbFunc (string eventParamsString)
 Sequence callback (string argument) More...
 
delegate void EventCallback (ref CriAtomExSequenceEventInfo criAtomExSequenceInfo)
 Sequence callback More...
 

Static Public Member Functions

static void SetEventCallback (CriAtomExSequencer.EventCbFunc func, string separator="\t")
 Registering sequence event callbacks (for string argument delegates) More...
 

Properties

static EventCallback OnCallback
 Registers the Sequence event callback More...
 

Detailed Description

A class for controlling the Sequence data.

Description:
A class for using the Sequence data created on CRI Atom Craft.

Member Function Documentation

delegate void EventCbFunc ( string  eventParamsString)

Sequence callback (string argument)

Parameters
eventParamsStringEvent parameter string
Description:
A Sequence callback function type.
The argument string contains the following information:
  1. Event position
  2. Event ID
  3. Playback ID
  4. Event type
  5. Event tag string
Each piece of information is concatenated and passed as one string with the specified delimiter character in between.
Parse the required parameters from the string before use.
See also
CriAtomExSequencer::SetEventCallback
delegate void EventCallback ( ref CriAtomExSequenceEventInfo  criAtomExSequenceInfo)

Sequence callback

Parameters
criAtomExSequenceInfo>Event information structure
Description:
Sequence callback function type.
The structure passed as argument contains the following information:
  1. Event position
  2. Player handler pointer
  3. Data embedded string
  4. Playback ID
  5. Event type
  6. Data embedded value .
static void SetEventCallback ( CriAtomExSequencer.EventCbFunc  func,
string  separator = "\t" 
)
inlinestatic

Registering sequence event callbacks (for string argument delegates)

Deprecated:
削除予定の非推奨APIです。 CriAtomExSequencer.OnCallback event の使用を検討してください。
Parameters
funcSequence callback function
separatorEvent parameter delimiting string (up to 15 characters)
Description:
Registers the callback function that receives the callback information embedded in the Sequence data.
The registered callback function is called at the update timing of the application main thread immediately after processing the callback event.
Note:
Only one callback function can be registered.
If you do the registration multiple times, the callback function already registered is overwritten by the one registered later.

Property Documentation

EventCallback OnCallback
staticaddremove

Registers the Sequence event callback

Description:
Registers a callback function to be executed by the callback marker synchronization embedded in the Cue.
The registered callback function will be executed when the application main thread is updated immediately after processing the callback event.

The documentation for this class was generated from the following file: