Skip to main content

B2Action_BookRead

  • Description
    * ===============
    * Plays synchronized reader/book loop montages while a character reads a carriable book object, accumulating elapsed reading time until the book's total read time (or homework progress) completes, then finishes with the book's finish script.
    * ===============
    * Param:
    * S1: RootAnimId - animation id played on the reading character (self)
    * S2: BookAnimId - animation id played on the book object (target)
    * F1: -
    * F2: -
    * Note:
    * OnInit(): resolves BookDtId/BookAnimId, queues async anim loads for both self and the book, and computes ProgressTime.
    * OnPlay(): resets loop/tick state, runs the book's start script, and starts the Default-section loop montage.
    * OnFinish(): runs the book's finish script, notifies FB2MissionComponent of the completed read, and resets the root montage delegates.
    * OnCanceled(): plays the End section montage if the loop hadn't already reached End.
    * OnTick(): accumulates elapsed reading ticks while in the Loop section and finishes (via End section) once total read time or homework progress completes.
PropertyTypeDescriptionMetadata
BookReadTickTimeint64Accumulated elapsed reading time in ticks, compared against the book's TotalReadTime to know when to end the loop
BookDtIdFNameBook data table id of the target carriable book, resolved at init and used for all book table lookups
BookAnimIdFNameBook-side animation id (from Action.S2), used to resolve the book object's montage
BookAnimMontageNameFNameResolved montage row id for the book object's animation, used to play the montage
ProgressTimefloatTotal time this reading session should take, computed from the book's TotalReadTime and current game time scale
AnimationIdFNameAnimation id to play, resolved via the overridable GetAnimationId() hook
LoopCountint32Requested number of times to play the montage's Loop section (0 normalized to 1, -1 means infinite)
RemainLoopCountint32Remaining loop iterations, decremented each time the Loop section finishes; drives when looping stops
StartLocationFVectorReferenced in GetLogString() for debug logging, but never assigned by this class or any subclass - the log always shows the zero-vector default
StartRotationFRotatorReferenced in GetLogString() for debug logging, but never assigned by this class or any subclass - the log always shows the zero-rotator default
AnimMontageNameFNameResolved montage asset name used to play/track the animation, set by SetAnim()
SectionNameFNameCurrent montage section of MAIN ANIMATION (Default/Loop/End), tracked via montage delegates and used to drive finish/cancel decisions
PlayingComponentNameFNameAnim component the montage is played on (e.g. Root vs. other), resolved by SetAnim().
SetAnim() clears this on entry, so it stays None whenever the resolve fails; a non-None value means the latest resolve succeeded.
TotalPlayLengthfloatTotal play length of the resolved montage, used in progress-time and one-loop-length calculations
LoopPlayLengthfloatPlay length of a single loop of the resolved montage, used in progress-time calculation
RateScalefloatPlayback rate scale of the resolved montage, used in progress-time calculation
PausedboolWhether the montage is currently held in a paused blend state
PhaseEB2PlayAnimPhasePhase of PlayAnim Action
AddOnAnimDataFB2AddOnAnimDataAddOnAnim Data
ActionIdFNameIdentifier of this action instance (used for interaction tracking and mission time accounting)
StateEB2ActionStateCurrent lifecycle state of this action
MergeTypeEB2ActionMergeTypeMerge type flags for this action (e.g. interaction merge, checked in Finish())
ResultEB2InteractionResultResult of this action once it stops playing (Finish/Failed/Canceled)
SelfEntityIdFB1EntityIdEntity id performing this action
TargetEntityIdFB1EntityIdEntity id targeted by this action
GrabEntityIdFB1EntityIdEntity id grabbed/carried by self entity for this action
NonTargetLocationFVectorLocation used for script/condition context when there is no target entity
ActionFB1ActionInfoAction table data (S1/S2/F1/F2, script id lists, etc.) driving this instance
TickCalcValuefloatAccumulated tick delta time since this action started ticking
CurrentNotifyIndexint32Index into Action.NotifyScriptIds for the next notify script to run
AsyncLoadAnimInfoTArrayAnimations to async-load for this action's start/notify/tick/finish/cancel scripts
AddActionTimeIntervalfloatInterval in seconds between OnTickAddActionExecuteTime() calls
AccumAddActionTimefloatElapsed time accumulator compared against AddActionTimeInterval
StartActionTickTimeint64Tick timestamp used to measure elapsed action execution time for mission tracking
ActionKeyFB2ActionKeyKey identifying this action's slot/queue within the interaction system
TimeTaskIdFB1TimeTaskIdId of the scheduled time task used for delayed Determine/Finish
IsForceCancelableboolWhether this action is force-cancelable, copied from Action.IsForceCancelable
IsFirstActionboolMarks the first action in an interaction sequence; set on actions[0] by FB2InteractionPlayer::LinkActions(), read by FB2ActionPlayer
bMultiFlagboolSet by looping actions (PlayAnim, BookRead, Eat, WaitTalkSequence) once a loop iteration completes; read/reset by FB2ActionPlayer to gate multi-interaction selection
TalkInstanceIdFB1TalkInstanceIdId of the talk instance this action is linked to, set externally by FB2InteractionPlayer::LinkActions()
TalkSubjectEntityIdFB1EntityIdEntity id of the talk subject linked to this action, set externally by FB2InteractionPlayer::LinkActions()/OnTalkSpaceParamChanged()
bIsWaitFinishEventboolCached copy of Action.IsWaitFinishAction taken at Init(); read directly by FB2ActionPlayer for sequencing (the IsWaitFinishAction() getter instead reads Action.IsWaitFinishAction live)
AutoInsertTypeEB2ActionAutoInsertTypeType of action that was auto-inserted before this one (e.g. WalkTo, ChangePosture)