ImageBank.h

Go to the documentation of this file.

/*
  Cavestory Multiplayer API
  Copyright (C) 2021 Johnny Ledger
 
  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.
 
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
 
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
 
#ifndef CAVESTORY_MOD_API_H_
#error "Please include CavestoryModAPI.h before including sub-classes."
#endif
 
#include <CSMAPI_begincode.h>
 
#pragma once
 
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
struct CSM_BANK_TILE
{
    unsigned int* solid_pixel_list;
 
    unsigned char* solid_pixel_map;
 
    unsigned short solid_count;
 
    bool done;
};
 
struct CSM_BANK_IMAGE
{
    unsigned int file_name_crc;
 
    int bank_no;
 
    int entry_no;
 
    char* name;
 
    GUI_POINT img_size;
 
    GUI_POINT tile_size;
 
    GUI_POINT tile_count;
 
    int tile_total_count;
 
    Surface_Ids surf_id;
 
    CSM_BANK_TILE* tile_list;
 
    CSM_BANK_IMAGE* next;
 
    BOOL(*solid_func)(Surface_Ids surf_id, int x, int y);
};
 
struct CSM_BANK_RECT
{
    int left;
 
    int top;
 
    int right;
 
    int bottom;
 
    int width;
 
    int height;
 
    int center_x;
 
    int center_y;
};
 
struct CSM_BANK_COLLISION_INFO
{
    CSM_BANK_IMAGE* bank;
 
    void* object;
 
    int pass_count;
 
    int tile_index_0;
 
    int tile_index_1;
 
    GUI_POINT map_tile_pos;
 
    // METADATA //
 
    GUI_POINT bank_hit_pixel_subpos;
 
    CSM_BANK_RECT bank_subrect;
 
    GUI_POINT object_hit_pixel_subpos;
 
    CSM_BANK_RECT object_subrect;
 
    int object_old_xm;
    
    int object_old_ym;
};
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API int CSM_ImageBank_Load(
    int iBankNo,
    int iEntryNo,
    CSM_BANK_IMAGE** pOut = NULL,
    const char* pInternalName = NULL,
    int iTileSizeW = 16,
    int iTileSizeH = 16,
    BOOL(*pSolidFunc)(Surface_Ids surf_id, int x, int y) = NULL,
    bool* bAlreadyExists = NULL
);
 
extern CAVESTORY_MOD_API Surface_Ids CSM_ImageBank_LoadAndGetSurfaceId(
    int iBankNo,
    int iEntryNo,
    CSM_BANK_IMAGE** pOut = NULL,
    const char* pInternalName = NULL,
    int iTileSizeW = 16,
    int iTileSizeH = 16,
    BOOL(*pSolidFunc)(Surface_Ids surf_id, int x, int y) = NULL
);
 
extern CAVESTORY_MOD_API void CSM_ImageBank_Free(
    CSM_BANK_IMAGE* pBank
);
 
extern CAVESTORY_MOD_API void CSM_ImageBank_FreeAll(
);
 
extern CAVESTORY_MOD_API BOOL CSM_ImageBank_FindBySurfaceId(
    Surface_Ids iSurfId,
    CSM_BANK_IMAGE** pOut = NULL
);
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API void CSM_ImageBank_SetTileSize(
    CSM_BANK_IMAGE* pBank,
    int iTileW,
    int iTileH
);
 
extern CAVESTORY_MOD_API int CSM_ImageBank_GetTileIndex(
    CSM_BANK_IMAGE* pBank,
    int iTileX,
    int iTileY
);
 
extern CAVESTORY_MOD_API int CSM_ImageBank_GetTileIndexByPixel(
    CSM_BANK_IMAGE* pBank,
    int iPixelX,
    int iPixelY
);
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API BOOL CSM_ImageBank_ScanTile(
    CSM_BANK_IMAGE* pBank,
    int iTileIndex,
    bool bForce = false
);
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API BOOL CSM_ImageBank_IsPixelSolid(
    CSM_BANK_IMAGE* pBank,
    int iTileIndex,
    int iX,
    int iY,
    float fAngle = 0.f,
    int iCenterX = 0,
    int iCenterY = 0
);
 
extern CAVESTORY_MOD_API int CSM_ImageBank_GetFloorPosition(
    CSM_BANK_IMAGE* pBank,
    int iTileIndex,
    int iX,
    int iY,
    float fAngle = 0.f,
    int iCenterX = 0,
    int iCenterY = 0,
    GUI_POINT debug_bank_sub_pos = GUI_POINT(0, 0)
);
 
extern CAVESTORY_MOD_API int CSM_ImageBank_TestPixelCollision_MYCHAR(
    CSM_BANK_IMAGE* pBank,
    MYCHAR* pMC,
    int iTileIndex,
    GUI_POINT pBankPos,
    int(*pCollideFunc)(const CSM_BANK_COLLISION_INFO* pInfo),
    float fAngle = 0.f,
    int iCenterX = 0,
    int iCenterY = 0,
    char iDebugLevel = 0
);
 
extern CAVESTORY_MOD_API BOOL CSM_ImageBank_TestPixelCollision_NPCHAR(
    CSM_BANK_IMAGE* pBank,
    NPCHAR* pNpc,
    int iTileIndex,
    GUI_POINT pBankPos,
    int(*pCollideFunc)(const CSM_BANK_COLLISION_INFO* pInfo),
    float fAngle = 0.f,
    int iCenterX = 0,
    int iCenterY = 0,
    char iDebugLevel = 0
);
 
extern CAVESTORY_MOD_API BOOL CSM_ImageBank_TestPixelCollision_BANK(
    CSM_BANK_IMAGE* pBank,
    CSM_BANK_IMAGE* pOther,
    int iTileIndex1,
    int iTileIndex2,
    GUI_POINT pBankPos1,
    GUI_POINT pBankPos2,
    void(*pCollideFunc)(const CSM_BANK_COLLISION_INFO* pInfo),
    float fAngle = 0.f,
    int iCenterX = 0,
    int iCenterY = 0,
    char iDebugLevel = 0
);
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API CSM_BANK_IMAGE* sz_pFirstImageBank;
 
#include <CSMAPI_endcode.h>
 
///