Extracts main modeller object entity from loaded BRS scene.
Takes sceneHandle (scene handle from b3dLoadBRSFile).
Returns entity handle of main modeller object.
3D Graphics
Parameters & Returns
Parameters
sceneHandleInt
Returns
Int
Quick Summary
Extracts main modeller object entity from loaded BRS scene.
Takes sceneHandle (scene handle from b3dLoadBRSFile).
Returns entity handle of main modeller object.
Technical Exegesis...
Extracts main modeller object entity from loaded BRS scene. Takes sceneHandle (scene handle from b3dLoadBRSFile, valid loaded BRS scene). Returns entity handle of main modeller object as Int (standard entity handle usable with all entity functions, 0 or negative if failed).
Extracts main modeller object entity from loaded BRS scene. Takes sceneHandle (scene handle from b3dLoadBRSFile, valid loaded BRS scene). Returns entity handle of main modeller object as Int (standard entity handle usable with all entity functions, 0 or negative if failed).
Modeller object: primary/main object in BRS scene (typically scene root or most important model, main terrain, building, character, or level geometry), single modeller object per BRS scene (main focus of scene, other objects accessed as props). Returned entity: standard BambooBasic entity handle (use with b3dPositionEntity, b3dRotateEntity, b3dShowEntity, etc, can create physics body, add to scene hierarchy, manipulate like any loaded mesh).
Workflow: load BRS (scene = b3dLoadBRSFile("level.brs")), extract modeller object (main = b3dGetBRSModellerObject(scene)), use entity (b3dPositionEntity(main, x, y, z), b3dCreatePhysicsBody(main, ...), etc). Use cases: (1) Extract main level geometry (terrain or building structure), (2) Get primary character model (main avatar or NPC), (3) Access scene root (parent of prop objects).
Validation: returns 0 or negative if sceneHandle invalid (scene not loaded or corrupted), returns 0 if BRS has no modeller object (rare, malformed BRS file). Error handling: check return value (if main <= 0 then error), may indicate BRS file issue.
Related: b3dLoadBRSFile loads BRS scene (call before this function to get sceneHandle), b3dGetBRSPropObject extracts named prop objects (additional objects in scene beyond modeller object).