CommonLibSSE (Parapets fork)
RE::BSSoundHandle Struct Reference

#include <BSSoundHandle.h>

Public Types

enum  : std::uint32_t { kInvalidID = static_cast<std::uint32_t>(-1) }
 
enum class  AssumedState { kInitialized = 0 , kPlaying = 1 , kStopped = 2 , kPaused = 3 }
 
enum class  LoopType { kNone = 0 , kWholeFile = 1 , kEnvFast = 2 , kEnvSlow = 3 }
 

Public Member Functions

 BSSoundHandle ()
 
 ~BSSoundHandle ()=default
 
bool IsValid () const
 
bool SetPosition (NiPoint3 a_pos)
 
void SetObjectToFollow (NiAVObject *a_node)
 
bool Stop ()
 
bool Play ()
 

Public Attributes

std::uint32_t soundID
 
bool assumeSuccess
 
std::uint8_t pad05
 
std::uint16_t pad06
 
stl::enumeration< AssumedState, std::uint32_t > state
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : std::uint32_t
Enumerator
kInvalidID 

◆ AssumedState

Enumerator
kInitialized 
kPlaying 
kStopped 
kPaused 

◆ LoopType

Enumerator
kNone 
kWholeFile 
kEnvFast 
kEnvSlow 

Constructor & Destructor Documentation

◆ BSSoundHandle()

RE::BSSoundHandle::BSSoundHandle ( )

◆ ~BSSoundHandle()

RE::BSSoundHandle::~BSSoundHandle ( )
default

Member Function Documentation

◆ IsValid()

bool RE::BSSoundHandle::IsValid ( ) const

◆ Play()

bool RE::BSSoundHandle::Play ( )

◆ SetObjectToFollow()

void RE::BSSoundHandle::SetObjectToFollow ( NiAVObject a_node)

◆ SetPosition()

bool RE::BSSoundHandle::SetPosition ( NiPoint3  a_pos)

◆ Stop()

bool RE::BSSoundHandle::Stop ( )

Member Data Documentation

◆ assumeSuccess

bool RE::BSSoundHandle::assumeSuccess

◆ pad05

std::uint8_t RE::BSSoundHandle::pad05

◆ pad06

std::uint16_t RE::BSSoundHandle::pad06

◆ soundID

std::uint32_t RE::BSSoundHandle::soundID

◆ state

stl::enumeration<AssumedState, std::uint32_t> RE::BSSoundHandle::state

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