diff --git a/autogen/convert_structs.py b/autogen/convert_structs.py index 64cd6feb7..535d147c5 100644 --- a/autogen/convert_structs.py +++ b/autogen/convert_structs.py @@ -292,8 +292,8 @@ def doc_struct_index(structs): def doc_struct(struct): sid = struct['identifier'] s = '## [%s](#%s)\n\n' % (sid, sid) - s += "| Field | Type |\n" - s += "| ----- | ---- |\n" + s += "| Field | Type | Access |\n" + s += "| ----- | ---- | ------ |\n" # build doc table @@ -305,11 +305,12 @@ def doc_struct(struct): ftype, do_link = translate_type_to_lua(ftype) + restrictions = ('', 'read-only')[fimmutable == 'true'] if do_link: - s += '| %s | [%s](#%s) |\n' % (fid, ftype, ftype) + s += '| %s | [%s](#%s) | %s |\n' % (fid, ftype, ftype, restrictions) continue - s += '| %s | %s |\n' % (fid, ftype) + s += '| %s | %s | %s |\n' % (fid, ftype, restrictions) s += '\n[:arrow_up_small:](#)\n\n
\n' diff --git a/docs/lua/structs.md b/docs/lua/structs.md index e2b51d5a3..742ec495f 100644 --- a/docs/lua/structs.md +++ b/docs/lua/structs.md @@ -53,15 +53,15 @@ ## [Animation](#Animation) -| Field | Type | -| ----- | ---- | -| flags | integer | -| length | integer | -| animYTransDivisor | integer | -| startFrame | integer | -| loopStart | integer | -| loopEnd | integer | -| unusedBoneCount | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| flags | integer | | +| length | integer | | +| animYTransDivisor | integer | | +| startFrame | integer | | +| loopStart | integer | | +| loopEnd | integer | | +| unusedBoneCount | integer | | [:arrow_up_small:](#) @@ -69,18 +69,18 @@ ## [Area](#Area) -| Field | Type | -| ----- | ---- | -| camera | [Camera](#Camera) | -| flags | integer | -| index | integer | -| instantWarps | [InstantWarp](#InstantWarp) | -| musicParam | integer | -| musicParam2 | integer | -| objectSpawnInfos | [SpawnInfo](#SpawnInfo) | -| paintingWarpNodes | [WarpNode](#WarpNode) | -| terrainType | integer | -| warpNodes | [ObjectWarpNode](#ObjectWarpNode) | +| Field | Type | Access | +| ----- | ---- | ------ | +| camera | [Camera](#Camera) | read-only | +| flags | integer | | +| index | integer | | +| instantWarps | [InstantWarp](#InstantWarp) | read-only | +| musicParam | integer | | +| musicParam2 | integer | | +| objectSpawnInfos | [SpawnInfo](#SpawnInfo) | read-only | +| paintingWarpNodes | [WarpNode](#WarpNode) | read-only | +| terrainType | integer | | +| warpNodes | [ObjectWarpNode](#ObjectWarpNode) | read-only | [:arrow_up_small:](#) @@ -88,20 +88,20 @@ ## [Camera](#Camera) -| Field | Type | -| ----- | ---- | -| areaCenX | number | -| areaCenY | number | -| areaCenZ | number | -| cutscene | integer | -| defMode | integer | -| doorStatus | integer | -| focus | [Vec3f](#Vec3f) | -| mode | integer | -| nextYaw | integer | -| pos | [Vec3f](#Vec3f) | -| unusedVec1 | [Vec3f](#Vec3f) | -| yaw | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| areaCenX | number | | +| areaCenY | number | | +| areaCenZ | number | | +| cutscene | integer | | +| defMode | integer | | +| doorStatus | integer | | +| focus | [Vec3f](#Vec3f) | read-only | +| mode | integer | | +| nextYaw | integer | | +| pos | [Vec3f](#Vec3f) | read-only | +| unusedVec1 | [Vec3f](#Vec3f) | read-only | +| yaw | integer | | [:arrow_up_small:](#) @@ -109,16 +109,16 @@ ## [CameraFOVStatus](#CameraFOVStatus) -| Field | Type | -| ----- | ---- | -| decay | integer | -| fov | number | -| fovFunc | integer | -| fovOffset | number | -| shakeAmplitude | number | -| shakePhase | integer | -| shakeSpeed | integer | -| unusedIsSleeping | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| decay | integer | | +| fov | number | | +| fovFunc | integer | | +| fovOffset | number | | +| shakeAmplitude | number | | +| shakePhase | integer | | +| shakeSpeed | integer | | +| unusedIsSleeping | integer | | [:arrow_up_small:](#) @@ -126,12 +126,12 @@ ## [CameraStoredInfo](#CameraStoredInfo) -| Field | Type | -| ----- | ---- | -| cannonYOffset | number | -| focus | [Vec3f](#Vec3f) | -| panDist | number | -| pos | [Vec3f](#Vec3f) | +| Field | Type | Access | +| ----- | ---- | ------ | +| cannonYOffset | number | | +| focus | [Vec3f](#Vec3f) | read-only | +| panDist | number | | +| pos | [Vec3f](#Vec3f) | read-only | [:arrow_up_small:](#) @@ -139,16 +139,16 @@ ## [CameraTrigger](#CameraTrigger) -| Field | Type | -| ----- | ---- | -| area | integer | -| boundsX | integer | -| boundsY | integer | -| boundsYaw | integer | -| boundsZ | integer | -| centerX | integer | -| centerY | integer | -| centerZ | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| area | integer | | +| boundsX | integer | | +| boundsY | integer | | +| boundsYaw | integer | | +| boundsZ | integer | | +| centerX | integer | | +| centerY | integer | | +| centerZ | integer | | [:arrow_up_small:](#) @@ -156,64 +156,64 @@ ## [Character](#Character) -| Field | Type | -| ----- | ---- | -| animOffsetEnabled | integer | -| animOffsetFeet | number | -| animOffsetHand | number | -| animOffsetLowYPoint | number | -| cameraHudHead | integer | -| capEnemyLayer | integer | -| capMetalModelId | integer | -| capMetalWingModelId | integer | -| capModelId | integer | -| capWingModelId | integer | -| modelId | integer | -| name | string | -| soundAttacked | integer | -| soundCoughing1 | integer | -| soundCoughing2 | integer | -| soundCoughing3 | integer | -| soundDoh | integer | -| soundDrowning | integer | -| soundDying | integer | -| soundEeuh | integer | -| soundFreqScale | number | -| soundGameOver | integer | -| soundGroundPoundWah | integer | -| soundHaha | integer | -| soundHaha_2 | integer | -| soundHello | integer | -| soundHereWeGo | integer | -| soundHoohoo | integer | -| soundHrmm | integer | -| soundImaTired | integer | -| soundMamaMia | integer | -| soundOnFire | integer | -| soundOoof | integer | -| soundOoof2 | integer | -| soundPanting | integer | -| soundPantingCold | integer | -| soundPressStartToPlay | integer | -| soundPunchHoo | integer | -| soundPunchWah | integer | -| soundPunchYah | integer | -| soundSnoring1 | integer | -| soundSnoring2 | integer | -| soundSnoring3 | integer | -| soundSoLongaBowser | integer | -| soundTwirlBounce | integer | -| soundUh | integer | -| soundUh2 | integer | -| soundUh2_2 | integer | -| soundWaaaooow | integer | -| soundWah2 | integer | -| soundWhoa | integer | -| soundYahWahHoo | integer | -| soundYahoo | integer | -| soundYahooWahaYippee | integer | -| soundYawning | integer | -| type | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| animOffsetEnabled | integer | read-only | +| animOffsetFeet | number | read-only | +| animOffsetHand | number | read-only | +| animOffsetLowYPoint | number | read-only | +| cameraHudHead | integer | read-only | +| capEnemyLayer | integer | read-only | +| capMetalModelId | integer | read-only | +| capMetalWingModelId | integer | read-only | +| capModelId | integer | read-only | +| capWingModelId | integer | read-only | +| modelId | integer | read-only | +| name | string | read-only | +| soundAttacked | integer | read-only | +| soundCoughing1 | integer | read-only | +| soundCoughing2 | integer | read-only | +| soundCoughing3 | integer | read-only | +| soundDoh | integer | read-only | +| soundDrowning | integer | read-only | +| soundDying | integer | read-only | +| soundEeuh | integer | read-only | +| soundFreqScale | number | read-only | +| soundGameOver | integer | read-only | +| soundGroundPoundWah | integer | read-only | +| soundHaha | integer | read-only | +| soundHaha_2 | integer | read-only | +| soundHello | integer | read-only | +| soundHereWeGo | integer | read-only | +| soundHoohoo | integer | read-only | +| soundHrmm | integer | read-only | +| soundImaTired | integer | read-only | +| soundMamaMia | integer | read-only | +| soundOnFire | integer | read-only | +| soundOoof | integer | read-only | +| soundOoof2 | integer | read-only | +| soundPanting | integer | read-only | +| soundPantingCold | integer | read-only | +| soundPressStartToPlay | integer | read-only | +| soundPunchHoo | integer | read-only | +| soundPunchWah | integer | read-only | +| soundPunchYah | integer | read-only | +| soundSnoring1 | integer | read-only | +| soundSnoring2 | integer | read-only | +| soundSnoring3 | integer | read-only | +| soundSoLongaBowser | integer | read-only | +| soundTwirlBounce | integer | read-only | +| soundUh | integer | read-only | +| soundUh2 | integer | read-only | +| soundUh2_2 | integer | read-only | +| soundWaaaooow | integer | read-only | +| soundWah2 | integer | read-only | +| soundWhoa | integer | read-only | +| soundYahWahHoo | integer | read-only | +| soundYahoo | integer | read-only | +| soundYahooWahaYippee | integer | read-only | +| soundYawning | integer | read-only | +| type | integer | read-only | [:arrow_up_small:](#) @@ -221,18 +221,18 @@ ## [Controller](#Controller) -| Field | Type | -| ----- | ---- | -| buttonDown | integer | -| buttonPressed | integer | -| extStickX | integer | -| extStickY | integer | -| port | integer | -| rawStickX | integer | -| rawStickY | integer | -| stickMag | number | -| stickX | number | -| stickY | number | +| Field | Type | Access | +| ----- | ---- | ------ | +| buttonDown | integer | | +| buttonPressed | integer | | +| extStickX | integer | | +| extStickY | integer | | +| port | integer | | +| rawStickX | integer | | +| rawStickY | integer | | +| stickMag | number | | +| stickX | number | | +| stickY | number | | [:arrow_up_small:](#) @@ -240,9 +240,9 @@ ## [Cutscene](#Cutscene) -| Field | Type | -| ----- | ---- | -| duration | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| duration | integer | | [:arrow_up_small:](#) @@ -250,11 +250,11 @@ ## [CutsceneSplinePoint](#CutsceneSplinePoint) -| Field | Type | -| ----- | ---- | -| index | integer | -| point | [Vec3s](#Vec3s) | -| speed | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| index | integer | | +| point | [Vec3s](#Vec3s) | read-only | +| speed | integer | | [:arrow_up_small:](#) @@ -262,13 +262,13 @@ ## [CutsceneVariable](#CutsceneVariable) -| Field | Type | -| ----- | ---- | -| angle | [Vec3s](#Vec3s) | -| point | [Vec3f](#Vec3f) | -| unused1 | integer | -| unused2 | integer | -| unusedPoint | [Vec3f](#Vec3f) | +| Field | Type | Access | +| ----- | ---- | ------ | +| angle | [Vec3s](#Vec3s) | read-only | +| point | [Vec3f](#Vec3f) | read-only | +| unused1 | integer | | +| unused2 | integer | | +| unusedPoint | [Vec3f](#Vec3f) | read-only | [:arrow_up_small:](#) @@ -276,12 +276,12 @@ ## [FloorGeometry](#FloorGeometry) -| Field | Type | -| ----- | ---- | -| normalX | number | -| normalY | number | -| normalZ | number | -| originOffset | number | +| Field | Type | Access | +| ----- | ---- | ------ | +| normalX | number | | +| normalY | number | | +| normalZ | number | | +| originOffset | number | | [:arrow_up_small:](#) @@ -289,14 +289,14 @@ ## [GraphNode](#GraphNode) -| Field | Type | -| ----- | ---- | -| children | [GraphNode](#GraphNode) | -| flags | integer | -| next | [GraphNode](#GraphNode) | -| parent | [GraphNode](#GraphNode) | -| prev | [GraphNode](#GraphNode) | -| type | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| children | [GraphNode](#GraphNode) | read-only | +| flags | integer | | +| next | [GraphNode](#GraphNode) | read-only | +| parent | [GraphNode](#GraphNode) | read-only | +| prev | [GraphNode](#GraphNode) | read-only | +| type | integer | | [:arrow_up_small:](#) @@ -304,27 +304,27 @@ ## [GraphNodeObject](#GraphNodeObject) -| Field | Type | -| ----- | ---- | -| angle | [Vec3s](#Vec3s) | -| cameraToObject | [Vec3f](#Vec3f) | -| node | [GraphNode](#GraphNode) | -| pos | [Vec3f](#Vec3f) | -| prevAngle | [Vec3s](#Vec3s) | -| prevPos | [Vec3f](#Vec3f) | -| prevScale | [Vec3f](#Vec3f) | -| prevScaleTimestamp | integer | -| prevShadowPos | [Vec3f](#Vec3f) | -| prevShadowPosTimestamp | integer | -| prevThrowMatrixTimestamp | integer | -| prevTimestamp | integer | -| scale | [Vec3f](#Vec3f) | -| sharedChild | [GraphNode](#GraphNode) | -| skipInterpolationTimestamp | integer | -| unk18 | integer | -| unk19 | integer | -| animInfo | [GraphNodeObject_sub](#GraphNodeObject_sub) | -| unk4C | [SpawnInfo](#SpawnInfo) | +| Field | Type | Access | +| ----- | ---- | ------ | +| angle | [Vec3s](#Vec3s) | read-only | +| cameraToObject | [Vec3f](#Vec3f) | read-only | +| node | [GraphNode](#GraphNode) | read-only | +| pos | [Vec3f](#Vec3f) | read-only | +| prevAngle | [Vec3s](#Vec3s) | read-only | +| prevPos | [Vec3f](#Vec3f) | read-only | +| prevScale | [Vec3f](#Vec3f) | read-only | +| prevScaleTimestamp | integer | | +| prevShadowPos | [Vec3f](#Vec3f) | read-only | +| prevShadowPosTimestamp | integer | | +| prevThrowMatrixTimestamp | integer | | +| prevTimestamp | integer | | +| scale | [Vec3f](#Vec3f) | read-only | +| sharedChild | [GraphNode](#GraphNode) | read-only | +| skipInterpolationTimestamp | integer | | +| unk18 | integer | | +| unk19 | integer | | +| animInfo | [GraphNodeObject_sub](#GraphNodeObject_sub) | read-only | +| unk4C | [SpawnInfo](#SpawnInfo) | read-only | [:arrow_up_small:](#) @@ -332,19 +332,19 @@ ## [GraphNodeObject_sub](#GraphNodeObject_sub) -| Field | Type | -| ----- | ---- | -| animAccel | integer | -| animFrame | integer | -| animFrameAccelAssist | integer | -| animID | integer | -| animTimer | integer | -| animYTrans | integer | -| curAnim | [Animation](#Animation) | -| prevAnimFrame | integer | -| prevAnimFrameTimestamp | integer | -| prevAnimID | integer | -| prevAnimPtr | [Animation](#Animation) | +| Field | Type | Access | +| ----- | ---- | ------ | +| animAccel | integer | | +| animFrame | integer | | +| animFrameAccelAssist | integer | | +| animID | integer | | +| animTimer | integer | | +| animYTrans | integer | | +| curAnim | [Animation](#Animation) | read-only | +| prevAnimFrame | integer | | +| prevAnimFrameTimestamp | integer | | +| prevAnimID | integer | | +| prevAnimPtr | [Animation](#Animation) | read-only | [:arrow_up_small:](#) @@ -352,11 +352,11 @@ ## [HandheldShakePoint](#HandheldShakePoint) -| Field | Type | -| ----- | ---- | -| index | integer | -| pad | integer | -| point | [Vec3s](#Vec3s) | +| Field | Type | Access | +| ----- | ---- | ------ | +| index | integer | | +| pad | integer | | +| point | [Vec3s](#Vec3s) | read-only | [:arrow_up_small:](#) @@ -364,11 +364,11 @@ ## [InstantWarp](#InstantWarp) -| Field | Type | -| ----- | ---- | -| area | integer | -| displacement | [Vec3s](#Vec3s) | -| id | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| area | integer | | +| displacement | [Vec3s](#Vec3s) | read-only | +| id | integer | | [:arrow_up_small:](#) @@ -376,43 +376,43 @@ ## [LakituState](#LakituState) -| Field | Type | -| ----- | ---- | -| curFocus | [Vec3f](#Vec3f) | -| curPos | [Vec3f](#Vec3f) | -| defMode | integer | -| focHSpeed | number | -| focVSpeed | number | -| focus | [Vec3f](#Vec3f) | -| focusDistance | number | -| goalFocus | [Vec3f](#Vec3f) | -| goalPos | [Vec3f](#Vec3f) | -| keyDanceRoll | integer | -| lastFrameAction | integer | -| mode | integer | -| nextYaw | integer | -| oldPitch | integer | -| oldRoll | integer | -| oldYaw | integer | -| pos | [Vec3f](#Vec3f) | -| posHSpeed | number | -| posVSpeed | number | -| roll | integer | -| shakeMagnitude | [Vec3s](#Vec3s) | -| shakePitchDecay | integer | -| shakePitchPhase | integer | -| shakePitchVel | integer | -| shakeRollDecay | integer | -| shakeRollPhase | integer | -| shakeRollVel | integer | -| shakeYawDecay | integer | -| shakeYawPhase | integer | -| shakeYawVel | integer | -| skipCameraInterpolationTimestamp | integer | -| unused | integer | -| unusedVec1 | [Vec3f](#Vec3f) | -| unusedVec2 | [Vec3s](#Vec3s) | -| yaw | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| curFocus | [Vec3f](#Vec3f) | read-only | +| curPos | [Vec3f](#Vec3f) | read-only | +| defMode | integer | | +| focHSpeed | number | | +| focVSpeed | number | | +| focus | [Vec3f](#Vec3f) | read-only | +| focusDistance | number | | +| goalFocus | [Vec3f](#Vec3f) | read-only | +| goalPos | [Vec3f](#Vec3f) | read-only | +| keyDanceRoll | integer | | +| lastFrameAction | integer | | +| mode | integer | | +| nextYaw | integer | | +| oldPitch | integer | | +| oldRoll | integer | | +| oldYaw | integer | | +| pos | [Vec3f](#Vec3f) | read-only | +| posHSpeed | number | | +| posVSpeed | number | | +| roll | integer | | +| shakeMagnitude | [Vec3s](#Vec3s) | read-only | +| shakePitchDecay | integer | | +| shakePitchPhase | integer | | +| shakePitchVel | integer | | +| shakeRollDecay | integer | | +| shakeRollPhase | integer | | +| shakeRollVel | integer | | +| shakeYawDecay | integer | | +| shakeYawPhase | integer | | +| shakeYawVel | integer | | +| skipCameraInterpolationTimestamp | integer | | +| unused | integer | | +| unusedVec1 | [Vec3f](#Vec3f) | read-only | +| unusedVec2 | [Vec3s](#Vec3s) | read-only | +| yaw | integer | | [:arrow_up_small:](#) @@ -420,13 +420,13 @@ ## [LinearTransitionPoint](#LinearTransitionPoint) -| Field | Type | -| ----- | ---- | -| dist | number | -| focus | [Vec3f](#Vec3f) | -| pitch | integer | -| pos | [Vec3f](#Vec3f) | -| yaw | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| dist | number | | +| focus | [Vec3f](#Vec3f) | read-only | +| pitch | integer | | +| pos | [Vec3f](#Vec3f) | read-only | +| yaw | integer | | [:arrow_up_small:](#) @@ -434,9 +434,9 @@ ## [MarioAnimation](#MarioAnimation) -| Field | Type | -| ----- | ---- | -| targetAnim | [Animation](#Animation) | +| Field | Type | Access | +| ----- | ---- | ------ | +| targetAnim | [Animation](#Animation) | read-only | [:arrow_up_small:](#) @@ -444,20 +444,20 @@ ## [MarioBodyState](#MarioBodyState) -| Field | Type | -| ----- | ---- | -| action | integer | -| capState | integer | -| eyeState | integer | -| grabPos | integer | -| handState | integer | -| headAngle | [Vec3s](#Vec3s) | -| heldObjLastPosition | [Vec3f](#Vec3f) | -| modelState | integer | -| punchState | integer | -| torsoAngle | [Vec3s](#Vec3s) | -| torsoPos | [Vec3f](#Vec3f) | -| wingFlutter | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| action | integer | | +| capState | integer | | +| eyeState | integer | | +| grabPos | integer | | +| handState | integer | | +| headAngle | [Vec3s](#Vec3s) | read-only | +| heldObjLastPosition | [Vec3f](#Vec3f) | read-only | +| modelState | integer | | +| punchState | integer | | +| torsoAngle | [Vec3s](#Vec3s) | read-only | +| torsoPos | [Vec3f](#Vec3f) | read-only | +| wingFlutter | integer | | [:arrow_up_small:](#) @@ -465,80 +465,80 @@ ## [MarioState](#MarioState) -| Field | Type | -| ----- | ---- | -| action | integer | -| actionArg | integer | -| actionState | integer | -| actionTimer | integer | -| angleVel | [Vec3s](#Vec3s) | -| animation | [MarioAnimation](#MarioAnimation) | -| area | [Area](#Area) | -| bubbleObj | [Object](#Object) | -| capTimer | integer | -| ceil | [Surface](#Surface) | -| ceilHeight | number | -| character | [Character](#Character) | -| collidedObjInteractTypes | integer | -| controller | [Controller](#Controller) | -| curAnimOffset | number | -| currentRoom | integer | -| doubleJumpTimer | integer | -| faceAngle | [Vec3s](#Vec3s) | -| fadeWarpOpacity | integer | -| flags | integer | -| floor | [Surface](#Surface) | -| floorAngle | integer | -| floorHeight | number | -| forwardVel | number | -| framesSinceA | integer | -| framesSinceB | integer | -| freeze | integer | -| healCounter | integer | -| health | integer | -| heldByObj | [Object](#Object) | -| heldObj | [Object](#Object) | -| hurtCounter | integer | -| input | integer | -| intendedMag | number | -| intendedYaw | integer | -| interactObj | [Object](#Object) | -| invincTimer | integer | -| isSnoring | integer | -| marioBodyState | [MarioBodyState](#MarioBodyState) | -| marioObj | [Object](#Object) | -| minimumBoneY | number | -| nonInstantWarpPos | [Vec3f](#Vec3f) | -| numCoins | integer | -| numKeys | integer | -| numLives | integer | -| numStars | integer | -| particleFlags | integer | -| peakHeight | number | -| playerIndex | integer | -| pos | [Vec3f](#Vec3f) | -| prevAction | integer | -| prevNumStarsForDialog | integer | -| quicksandDepth | number | -| riddenObj | [Object](#Object) | -| slideVelX | number | -| slideVelZ | number | -| slideYaw | integer | -| spawnInfo | [SpawnInfo](#SpawnInfo) | -| splineKeyframeFraction | number | -| splineState | integer | -| squishTimer | integer | -| statusForCamera | [PlayerCameraState](#PlayerCameraState) | -| terrainSoundAddend | integer | -| twirlYaw | integer | -| unkB0 | integer | -| unkC4 | number | -| usedObj | [Object](#Object) | -| vel | [Vec3f](#Vec3f) | -| wall | [Surface](#Surface) | -| wallKickTimer | integer | -| wasNetworkVisible | integer | -| waterLevel | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| action | integer | | +| actionArg | integer | | +| actionState | integer | | +| actionTimer | integer | | +| angleVel | [Vec3s](#Vec3s) | read-only | +| animation | [MarioAnimation](#MarioAnimation) | read-only | +| area | [Area](#Area) | read-only | +| bubbleObj | [Object](#Object) | read-only | +| capTimer | integer | | +| ceil | [Surface](#Surface) | read-only | +| ceilHeight | number | | +| character | [Character](#Character) | read-only | +| collidedObjInteractTypes | integer | | +| controller | [Controller](#Controller) | read-only | +| curAnimOffset | number | | +| currentRoom | integer | | +| doubleJumpTimer | integer | | +| faceAngle | [Vec3s](#Vec3s) | read-only | +| fadeWarpOpacity | integer | | +| flags | integer | | +| floor | [Surface](#Surface) | read-only | +| floorAngle | integer | | +| floorHeight | number | | +| forwardVel | number | | +| framesSinceA | integer | | +| framesSinceB | integer | | +| freeze | integer | | +| healCounter | integer | | +| health | integer | | +| heldByObj | [Object](#Object) | read-only | +| heldObj | [Object](#Object) | read-only | +| hurtCounter | integer | | +| input | integer | | +| intendedMag | number | | +| intendedYaw | integer | | +| interactObj | [Object](#Object) | read-only | +| invincTimer | integer | | +| isSnoring | integer | | +| marioBodyState | [MarioBodyState](#MarioBodyState) | read-only | +| marioObj | [Object](#Object) | read-only | +| minimumBoneY | number | | +| nonInstantWarpPos | [Vec3f](#Vec3f) | read-only | +| numCoins | integer | | +| numKeys | integer | | +| numLives | integer | | +| numStars | integer | | +| particleFlags | integer | | +| peakHeight | number | | +| playerIndex | integer | read-only | +| pos | [Vec3f](#Vec3f) | read-only | +| prevAction | integer | | +| prevNumStarsForDialog | integer | | +| quicksandDepth | number | | +| riddenObj | [Object](#Object) | read-only | +| slideVelX | number | | +| slideVelZ | number | | +| slideYaw | integer | | +| spawnInfo | [SpawnInfo](#SpawnInfo) | read-only | +| splineKeyframeFraction | number | | +| splineState | integer | | +| squishTimer | integer | | +| statusForCamera | [PlayerCameraState](#PlayerCameraState) | read-only | +| terrainSoundAddend | integer | | +| twirlYaw | integer | | +| unkB0 | integer | | +| unkC4 | number | | +| usedObj | [Object](#Object) | read-only | +| vel | [Vec3f](#Vec3f) | read-only | +| wall | [Surface](#Surface) | read-only | +| wallKickTimer | integer | | +| wasNetworkVisible | integer | | +| waterLevel | integer | | [:arrow_up_small:](#) @@ -546,14 +546,14 @@ ## [ModeTransitionInfo](#ModeTransitionInfo) -| Field | Type | -| ----- | ---- | -| frame | integer | -| lastMode | integer | -| max | integer | -| newMode | integer | -| transitionEnd | [LinearTransitionPoint](#LinearTransitionPoint) | -| transitionStart | [LinearTransitionPoint](#LinearTransitionPoint) | +| Field | Type | Access | +| ----- | ---- | ------ | +| frame | integer | | +| lastMode | integer | | +| max | integer | | +| newMode | integer | | +| transitionEnd | [LinearTransitionPoint](#LinearTransitionPoint) | read-only | +| transitionStart | [LinearTransitionPoint](#LinearTransitionPoint) | read-only | [:arrow_up_small:](#) @@ -561,26 +561,26 @@ ## [NetworkPlayer](#NetworkPlayer) -| Field | Type | -| ----- | ---- | -| connected | bool | -| currActNum | integer | -| currAreaIndex | integer | -| currAreaSyncValid | bool | -| currCourseNum | integer | -| currLevelAreaSeqId | integer | -| currLevelNum | integer | -| currLevelSyncValid | bool | -| fadeOpacity | integer | -| globalIndex | integer | -| lastReceived | number | -| lastSent | number | -| localIndex | integer | -| modelIndex | integer | -| name | string | -| onRxSeqId | integer | -| paletteIndex | integer | -| type | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| connected | bool | read-only | +| currActNum | integer | read-only | +| currAreaIndex | integer | read-only | +| currAreaSyncValid | bool | read-only | +| currCourseNum | integer | read-only | +| currLevelAreaSeqId | integer | read-only | +| currLevelNum | integer | read-only | +| currLevelSyncValid | bool | read-only | +| fadeOpacity | integer | read-only | +| globalIndex | integer | read-only | +| lastReceived | number | read-only | +| lastSent | number | read-only | +| localIndex | integer | read-only | +| modelIndex | integer | read-only | +| name | string | read-only | +| onRxSeqId | integer | read-only | +| paletteIndex | integer | read-only | +| type | integer | read-only | [:arrow_up_small:](#) @@ -588,30 +588,30 @@ ## [Object](#Object) -| Field | Type | -| ----- | ---- | -| activeFlags | integer | -| areaTimer | integer | -| areaTimerDuration | integer | -| areaTimerType | integer | -| bhvDelayTimer | integer | -| bhvStackIndex | integer | -| collidedObjInteractTypes | integer | -| createdThroughNetwork | integer | -| globalPlayerIndex | integer | -| header | [ObjectNode](#ObjectNode) | -| heldByPlayerIndex | integer | -| hitboxDownOffset | number | -| hitboxHeight | number | -| hitboxRadius | number | -| hurtboxHeight | number | -| hurtboxRadius | number | -| numCollidedObjs | integer | -| parentObj | [Object](#Object) | -| platform | [Object](#Object) | -| prevObj | [Object](#Object) | -| respawnInfoType | integer | -| unused1 | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| activeFlags | integer | | +| areaTimer | integer | | +| areaTimerDuration | integer | | +| areaTimerType | integer | | +| bhvDelayTimer | integer | | +| bhvStackIndex | integer | | +| collidedObjInteractTypes | integer | | +| createdThroughNetwork | integer | | +| globalPlayerIndex | integer | | +| header | [ObjectNode](#ObjectNode) | read-only | +| heldByPlayerIndex | integer | | +| hitboxDownOffset | number | | +| hitboxHeight | number | | +| hitboxRadius | number | | +| hurtboxHeight | number | | +| hurtboxRadius | number | | +| numCollidedObjs | integer | | +| parentObj | [Object](#Object) | read-only | +| platform | [Object](#Object) | read-only | +| prevObj | [Object](#Object) | read-only | +| respawnInfoType | integer | | +| unused1 | integer | | [:arrow_up_small:](#) @@ -619,17 +619,17 @@ ## [ObjectHitbox](#ObjectHitbox) -| Field | Type | -| ----- | ---- | -| damageOrCoinValue | integer | -| downOffset | integer | -| health | integer | -| height | integer | -| hurtboxHeight | integer | -| hurtboxRadius | integer | -| interactType | integer | -| numLootCoins | integer | -| radius | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| damageOrCoinValue | integer | | +| downOffset | integer | | +| health | integer | | +| height | integer | | +| hurtboxHeight | integer | | +| hurtboxRadius | integer | | +| interactType | integer | | +| numLootCoins | integer | | +| radius | integer | | [:arrow_up_small:](#) @@ -637,11 +637,11 @@ ## [ObjectNode](#ObjectNode) -| Field | Type | -| ----- | ---- | -| gfx | [GraphNodeObject](#GraphNodeObject) | -| next | [ObjectNode](#ObjectNode) | -| prev | [ObjectNode](#ObjectNode) | +| Field | Type | Access | +| ----- | ---- | ------ | +| gfx | [GraphNodeObject](#GraphNodeObject) | read-only | +| next | [ObjectNode](#ObjectNode) | read-only | +| prev | [ObjectNode](#ObjectNode) | read-only | [:arrow_up_small:](#) @@ -649,11 +649,11 @@ ## [ObjectWarpNode](#ObjectWarpNode) -| Field | Type | -| ----- | ---- | -| next | [ObjectWarpNode](#ObjectWarpNode) | -| node | [WarpNode](#WarpNode) | -| object | [Object](#Object) | +| Field | Type | Access | +| ----- | ---- | ------ | +| next | [ObjectWarpNode](#ObjectWarpNode) | read-only | +| node | [WarpNode](#WarpNode) | read-only | +| object | [Object](#Object) | read-only | [:arrow_up_small:](#) @@ -661,10 +661,10 @@ ## [OffsetSizePair](#OffsetSizePair) -| Field | Type | -| ----- | ---- | -| offset | integer | -| size | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| offset | integer | | +| size | integer | | [:arrow_up_small:](#) @@ -672,12 +672,12 @@ ## [ParallelTrackingPoint](#ParallelTrackingPoint) -| Field | Type | -| ----- | ---- | -| distThresh | number | -| pos | [Vec3f](#Vec3f) | -| startOfPath | integer | -| zoom | number | +| Field | Type | Access | +| ----- | ---- | ------ | +| distThresh | number | | +| pos | [Vec3f](#Vec3f) | read-only | +| startOfPath | integer | | +| zoom | number | | [:arrow_up_small:](#) @@ -685,15 +685,15 @@ ## [PlayerCameraState](#PlayerCameraState) -| Field | Type | -| ----- | ---- | -| action | integer | -| cameraEvent | integer | -| faceAngle | [Vec3s](#Vec3s) | -| headRotation | [Vec3s](#Vec3s) | -| pos | [Vec3f](#Vec3f) | -| unused | integer | -| usedObj | [Object](#Object) | +| Field | Type | Access | +| ----- | ---- | ------ | +| action | integer | | +| cameraEvent | integer | | +| faceAngle | [Vec3s](#Vec3s) | read-only | +| headRotation | [Vec3s](#Vec3s) | read-only | +| pos | [Vec3f](#Vec3f) | read-only | +| unused | integer | | +| usedObj | [Object](#Object) | read-only | [:arrow_up_small:](#) @@ -701,21 +701,21 @@ ## [PlayerGeometry](#PlayerGeometry) -| Field | Type | -| ----- | ---- | -| currCeil | [Surface](#Surface) | -| currCeilHeight | number | -| currCeilType | integer | -| currFloor | [Surface](#Surface) | -| currFloorHeight | number | -| currFloorType | integer | -| prevCeil | [Surface](#Surface) | -| prevCeilHeight | number | -| prevCeilType | integer | -| prevFloor | [Surface](#Surface) | -| prevFloorHeight | number | -| prevFloorType | integer | -| waterHeight | number | +| Field | Type | Access | +| ----- | ---- | ------ | +| currCeil | [Surface](#Surface) | read-only | +| currCeilHeight | number | | +| currCeilType | integer | | +| currFloor | [Surface](#Surface) | read-only | +| currFloorHeight | number | | +| currFloorType | integer | | +| prevCeil | [Surface](#Surface) | read-only | +| prevCeilHeight | number | | +| prevCeilType | integer | | +| prevFloor | [Surface](#Surface) | read-only | +| prevFloorHeight | number | | +| prevFloorType | integer | | +| waterHeight | number | | [:arrow_up_small:](#) @@ -723,15 +723,15 @@ ## [SpawnInfo](#SpawnInfo) -| Field | Type | -| ----- | ---- | -| activeAreaIndex | integer | -| areaIndex | integer | -| behaviorArg | integer | -| next | [SpawnInfo](#SpawnInfo) | -| startAngle | [Vec3s](#Vec3s) | -| startPos | [Vec3s](#Vec3s) | -| unk18 | [GraphNode](#GraphNode) | +| Field | Type | Access | +| ----- | ---- | ------ | +| activeAreaIndex | integer | | +| areaIndex | integer | | +| behaviorArg | integer | | +| next | [SpawnInfo](#SpawnInfo) | read-only | +| startAngle | [Vec3s](#Vec3s) | read-only | +| startPos | [Vec3s](#Vec3s) | read-only | +| unk18 | [GraphNode](#GraphNode) | read-only | [:arrow_up_small:](#) @@ -739,24 +739,24 @@ ## [Surface](#Surface) -| Field | Type | -| ----- | ---- | -| flags | integer | -| force | integer | -| lowerY | integer | -| modifiedTimestamp | integer | -| normal | [Vec3f](#Vec3f) | -| object | [Object](#Object) | -| originOffset | number | -| prevVertex1 | [Vec3s](#Vec3s) | -| prevVertex2 | [Vec3s](#Vec3s) | -| prevVertex3 | [Vec3s](#Vec3s) | -| room | integer | -| type | integer | -| upperY | integer | -| vertex1 | [Vec3s](#Vec3s) | -| vertex2 | [Vec3s](#Vec3s) | -| vertex3 | [Vec3s](#Vec3s) | +| Field | Type | Access | +| ----- | ---- | ------ | +| flags | integer | | +| force | integer | | +| lowerY | integer | | +| modifiedTimestamp | integer | | +| normal | [Vec3f](#Vec3f) | read-only | +| object | [Object](#Object) | read-only | +| originOffset | number | | +| prevVertex1 | [Vec3s](#Vec3s) | read-only | +| prevVertex2 | [Vec3s](#Vec3s) | read-only | +| prevVertex3 | [Vec3s](#Vec3s) | read-only | +| room | integer | | +| type | integer | | +| upperY | integer | | +| vertex1 | [Vec3s](#Vec3s) | read-only | +| vertex2 | [Vec3s](#Vec3s) | read-only | +| vertex3 | [Vec3s](#Vec3s) | read-only | [:arrow_up_small:](#) @@ -764,17 +764,17 @@ ## [TransitionInfo](#TransitionInfo) -| Field | Type | -| ----- | ---- | -| focDist | number | -| focPitch | integer | -| focYaw | integer | -| framesLeft | integer | -| marioPos | [Vec3f](#Vec3f) | -| pad | integer | -| posDist | number | -| posPitch | integer | -| posYaw | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| focDist | number | | +| focPitch | integer | | +| focYaw | integer | | +| framesLeft | integer | | +| marioPos | [Vec3f](#Vec3f) | read-only | +| pad | integer | | +| posDist | number | | +| posPitch | integer | | +| posYaw | integer | | [:arrow_up_small:](#) @@ -782,11 +782,11 @@ ## [Vec3f](#Vec3f) -| Field | Type | -| ----- | ---- | -| x | float | -| y | float | -| z | float | +| Field | Type | Access | +| ----- | ---- | ------ | +| x | float | | +| y | float | | +| z | float | | [:arrow_up_small:](#) @@ -794,11 +794,11 @@ ## [Vec3s](#Vec3s) -| Field | Type | -| ----- | ---- | -| x | integer | -| y | integer | -| z | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| x | integer | | +| y | integer | | +| z | integer | | [:arrow_up_small:](#) @@ -806,12 +806,12 @@ ## [WallCollisionData](#WallCollisionData) -| Field | Type | -| ----- | ---- | -| numWalls | integer | -| offsetY | number | -| radius | number | -| unk14 | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| numWalls | integer | | +| offsetY | number | | +| radius | number | | +| unk14 | integer | | [:arrow_up_small:](#) @@ -819,12 +819,12 @@ ## [WarpNode](#WarpNode) -| Field | Type | -| ----- | ---- | -| destArea | integer | -| destLevel | integer | -| destNode | integer | -| id | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| destArea | integer | | +| destLevel | integer | | +| destNode | integer | | +| id | integer | | [:arrow_up_small:](#) @@ -832,13 +832,13 @@ ## [WarpTransition](#WarpTransition) -| Field | Type | -| ----- | ---- | -| data | [WarpTransitionData](#WarpTransitionData) | -| isActive | integer | -| pauseRendering | integer | -| time | integer | -| type | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| data | [WarpTransitionData](#WarpTransitionData) | read-only | +| isActive | integer | | +| pauseRendering | integer | | +| time | integer | | +| type | integer | | [:arrow_up_small:](#) @@ -846,18 +846,18 @@ ## [WarpTransitionData](#WarpTransitionData) -| Field | Type | -| ----- | ---- | -| blue | integer | -| endTexRadius | integer | -| endTexX | integer | -| endTexY | integer | -| green | integer | -| red | integer | -| startTexRadius | integer | -| startTexX | integer | -| startTexY | integer | -| texTimer | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| blue | integer | | +| endTexRadius | integer | | +| endTexX | integer | | +| endTexY | integer | | +| green | integer | | +| red | integer | | +| startTexRadius | integer | | +| startTexX | integer | | +| startTexY | integer | | +| texTimer | integer | | [:arrow_up_small:](#) @@ -865,10 +865,10 @@ ## [Waypoint](#Waypoint) -| Field | Type | -| ----- | ---- | -| flags | integer | -| pos | [Vec3s](#Vec3s) | +| Field | Type | Access | +| ----- | ---- | ------ | +| flags | integer | | +| pos | [Vec3s](#Vec3s) | read-only | [:arrow_up_small:](#) @@ -876,10 +876,10 @@ ## [Whirlpool](#Whirlpool) -| Field | Type | -| ----- | ---- | -| pos | [Vec3s](#Vec3s) | -| strength | integer | +| Field | Type | Access | +| ----- | ---- | ------ | +| pos | [Vec3s](#Vec3s) | read-only | +| strength | integer | | [:arrow_up_small:](#)