aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/SDK/ModiSDK.pas
blob: 7fc50bb872573d540a5bd89a5f48b9a356382793 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
unit ModiSDK;

interface

{$IFDEF FPC}
  {$MODE Delphi}
{$ENDIF}

type  // PluginInfo, for init
  TPluginInfo = record
    // Info
    Name:       array [0..32] of char;   // modi to register for the plugin
    Creator:    array [0..32] of char;   // name of the author
    PluginDesc: array [0..64] of char;   // plugin description

    // plugin type, atm: 8 only for partymode modi
    Case Typ: byte of
      8: (
        // Options
        LoadSong:      boolean; // Whether or not a song should be loaded
        // Only when song is loaded:
        ShowNotes:     boolean; // Whether the note lines should be displayed
        LoadVideo:     boolean; // Should the video be loaded?
        LoadBack:      boolean; // Should the background be loaded?

        ShowRateBar:   boolean; // Whether the bar that shows how good the player was sould be displayed
        ShowRateBar_O: boolean; // Load from ini whether the bar should be displayed

        EnLineBonus:   boolean; // Whether line bonus should be enabled
        EnLineBonus_O: boolean; // Load from ini whether line bonus should be enabled

        BGShowFull:    boolean; // Whether the background or the video should be shown full size
        BGShowFull_O:  boolean; // Whether the background or the video should be shown full size

        // Options -> everytime
        ShowScore:     boolean; // Whether or not the score should be shown
        ShowBars:      boolean; // Whether the white bars on top and bottom should be drawn
        TeamModeOnly:  boolean; // If true the plugin can only be played in team mode
        GetSoundData:  boolean; // If true the rdata procedure is called when new sound data is available
        Dummy:         boolean; // Should be set to false... for updateing plugin interface

        NumPlayers: byte   // Number of available players for modus
        // Set different bits
        // 1 -> one player
        // 2 -> two players
        // 4 -> three players
        // 8 -> four players
        // 16-> six players
        // e.g. : 10 -> playable with 2 and 4 players
        );

  end;

  TPlayerInfo = record
    NumPlayers: byte;
    Playerinfo: array[0..5] of record
      Name:       PChar; // Name of the player
      Score:      word;  // Players score
      Bar:        byte;  // Percentage of the singbar filled
      PosX:       real;  // PosX of players singbar
      PosY:       real;  // PosY "
      Enabled:    boolean; // Whether the player could get points
      Percentage: byte; // Percentage shown on the score screen
    end;
  end;

  TTeamInfo = record
    NumTeams: byte;
    Teaminfo: array[0..5] of record
      Name:       PChar;
      Score:      word;
      Joker:      byte;
      CurPlayer:  byte;
      NumPlayers: byte;
      Playerinfo: array[0..3] of record
        Name:        PChar;
        TimesPlayed: byte;
      end;
    end;
  end;

  TsmallTexture = record
    TexNum: integer;
    W:      real;
    H:      real;
  end;

  TSentences = record
    Current:     integer;      // aktualna czesc utworu do rysowania
    High:        integer;
    Number:      integer;
    Resolution:  integer;
    NotesGAP:    integer;
    TotalLength: integer;
    Sentence:    array of record
      Start:      integer;
      StartNote:  integer;
      Lyric:      string;
      LyricWidth: real;
      End_:       integer;
      BaseNote:   integer;
      HighNote:   integer;
      IlNut:      integer;
      TotalNotes: integer;
      Note:       array of record
        Color:     integer;
        Start:     integer;
        Length:    integer;
        Tone:      integer;
        //Text:      string;
        FreeStyle: boolean;
        Typ:      integer;    // zwykla nuta x1, zlota nuta x2
      end;
    end;
  end;

  dword = longword;
  hstream = dword;

  TTextureType = (
    TEXTURE_TYPE_PLAIN,        // Plain (alpha = 1)
    TEXTURE_TYPE_TRANSPARENT,  // Alpha is used
    TEXTURE_TYPE_COLORIZED     // Alpha is used; Hue of the HSV color-model will be replaced by a new value
  );

  // Routines to give to the plugin
  fModi_LoadTex = function (const Name: PChar; Typ: TTextureType): TsmallTexture; // Pointer to texture loader
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
  //fModi_Translate = function (const Name, Translation: AChar): integer; // Pointer to translator
  //  {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}

  fModi_Print = procedure (const Style, Size: byte; const X, Y: real; const Text: PChar); // Procedure to print text   // Now translated automatically
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
  fModi_LoadSound = function (const Name: PChar): cardinal; // Procedure that loads a custom sound
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
  pModi_PlaySound = procedure (const Index: cardinal); // Plays a custom sound
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}

  TMethodRec = record
    LoadTex:    fModi_LoadTex;
    Print:      fModi_Print;
    LoadSound:  fModi_LoadSound;
    PlaySound:  pModi_PlaySound;
  end;
  // DLL functions
  // Give the plugins info
  pModi_PluginInfo = procedure (var Info: TPluginInfo);
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
  // Executed on game start // if true game begins, else failure
  fModi_Init = function (const TeamInfo: TTeamInfo; var Playerinfo: TPlayerinfo; const Sentences: TSentences; const Methods: TMethodRec): boolean;
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
  // Executed everytime the screen is drawn // if false the game finishes
  fModi_Draw = function (var Playerinfo: TPlayerinfo; const CurSentence: cardinal): boolean;
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
  // Is executed on finish, returns the player num of the winner
  fModi_Finish = function (var Playerinfo: TPlayerinfo): byte;
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}
  // Procedure called when new sound data is available
  pModi_RData = procedure (handle: HSTREAM; buffer: Pointer; len: DWORD; user: DWORD);
    {$IFDEF MSWINDOWS} stdcall; {$ELSE} cdecl; {$ENDIF}

implementation

end.