BEEP-8 Helper Lib 1.0.0
Loading...
Searching...
No Matches
CObj Class Referenceabstract
Inheritance diagram for CObj:
CPadObj CShellObj

Public Member Functions

u32 GetId () const
 Get the ID of the object.
 
HObj GetHandle () const
 Get the handle of the object.
 
void SetHandle (HObj hObj_)
 Set the handle of the object.
 
void SetPriority (u32 priority_)
 Set the priority of the object.
 
u32 GetPriority () const
 Get the priority of the object.
 
void ReqKill ()
 Request to kill the object.
 
bool IsReqKill () const
 Check if the object is requested to be killed.
 
u32 GetTypeId ()
 Get the type ID of the object.
 
bool IsTypeOf (u32 type_id_)
 Check if the object is of a specific type.
 

Protected Member Functions

void SetTypeId (u32 type_id_)
 Set the type ID of the object.
 

Friends

void CObjHolder_Step (b8PpuCmd *cmd_)
 

Member Function Documentation

◆ GetHandle()

HObj CObj::GetHandle ( ) const
inline

Get the handle of the object.

Returns
The handle of the object.

◆ GetId()

u32 CObj::GetId ( ) const
inline

Get the ID of the object.

Returns
The ID of the object.

◆ GetPriority()

u32 CObj::GetPriority ( ) const
inline

Get the priority of the object.

Returns
The priority of the object.

◆ GetTypeId()

u32 CObj::GetTypeId ( )
inline

Get the type ID of the object.

Returns
The type ID of the object.

◆ IsReqKill()

bool CObj::IsReqKill ( ) const
inline

Check if the object is requested to be killed.

Returns
True if the object is requested to be killed, false otherwise.

◆ IsTypeOf()

bool CObj::IsTypeOf ( u32 type_id_)
inline

Check if the object is of a specific type.

Parameters
type_id_The type ID to check.
Returns
True if the object is of the specified type, false otherwise.

◆ SetHandle()

void CObj::SetHandle ( HObj hObj_)
inline

Set the handle of the object.

Parameters
hObj_The handle to set.

◆ SetPriority()

void CObj::SetPriority ( u32 priority_)
inline

Set the priority of the object.

Parameters
priority_The priority to set.

◆ SetTypeId()

void CObj::SetTypeId ( u32 type_id_)
inlineprotected

Set the type ID of the object.

Parameters
type_id_The type ID to set.

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