Skip to main content

FB2MovieScreen

Overview

No description available.

Metadata

Field	Value
Kind	`struct`
Environment	B2 - Simulation
Category	`structs`
Extends	`FB2GameObject`
Require	`require('Objects.B2MovieScreen')`

Properties (10)

Name	Type	Description
`AllTimeAudiences`	`table<FB1EntityId, boolean>`
`CurrentAudiences`	`table<FB1EntityId, integer>`
`IntervalBuffContexts`	`FB2MovieBuffContext[]`
`LocalMovieFilePath`	`string`
`MovieId`	`string`
`StartTicks`	`integer`
`StaticBuffContexts`	`FB2MovieBuffContext[]`
`StaticBuffElapsedTicks`	`integer`
`StopTicks`	`integer`
`bLoopMode`	`boolean`

Functions (12)

Function	Parameters	Returns	Description
`AddCurrentAudience`	InAudienceEntityId: `FB1EntityId`, InInteractionQueueId: `integer`	`-`	Adds Current Audience.
`ChangeMovie`	InMovieId: `string`	`-`
`GetMovieId`	`-`	`string`	Returns Movie Id.
`IsLoopMode`	`-`	`boolean`	Returns whether Loop Mode.
`IsPlaying`	`-`	`boolean`	Returns whether Playing.
`OnMovieFinished`	`-`	`-`	Callback invoked on Movie Finished.
`RemoveCurrentAudience`	InAudienceEntityId: `FB1EntityId`	`-`	Removes Current Audience.
`SetLocalFilePath`	InFilePath: `string`	`-`	Sets Local File Path.
`SetLoopMode`	bInLoopMode: `boolean`	`-`	Sets Loop Mode.
`SetMovieDuration`	InDurationMinutes: `number`	`-`	Sets Movie Duration.
`StopMovie`	`-`	`-`	Stops Movie.
`SyncTime`	`-`	`-`

Override points (6)

Implement these in Lua as FB2MovieScreen.Override_Name = function(...) end.

Function	Parameters	Returns	Description
`Override_AddCurrentAudience`	InAudienceEntityId: `FB1EntityId`, InInteractionQueueId: `integer`	`-`	Adds Current Audience.
`Override_ChangeMovie`	InMovieId: `string`	`-`
`Override_OnMovieFinished`	`-`	`-`	Callback invoked on Movie Finished.
`Override_RemoveCurrentAudience`	InAudienceEntityId: `FB1EntityId`	`-`	Removes Current Audience.
`Override_StopMovie`	`-`	`-`	Stops Movie.
`Override_SyncTime`	`-`	`-`