VScript API

[rtldg]

NOTE: completely untested (but it compiles!)

Requirements (which are very incompatible with 64-bit):

• sourcescramble
• this vscript plugin

Before vscript, checkpoints only saved these because maps couldn't do much:

• targetname
• classname
• events (from FireInput & whatever)

(note the lack of player_speedmod disabled-buttons in there! I still need to add that TODO!)

Since you can do a lot of funky stuff with vscript (and a mapper is already asking for vscript checkpoint support), these are the vscript/squirrel API I think should be enough.

And thank gosh I added StringMap cp_cache_t::customdata for this kind of thing a million years ago!

// Timer provided functions:
// - function Timer_SetCheckpointCustomData(player, key, value)
//   (only usable from Timer_OnCheckpointSave)
// - function Timer_GetCheckpointCustomData(player, key)
//   (only usable from Timer_OnCheckpointLoadPre & Timer_OnCheckpointLoadPost)

// Functions that maps can implement (with examples):
::Timer_OnCheckpointSave <- function(player)
{
    Timer_SetCheckpointCustomData(player, "mystate", "floating")
}
::Timer_OnCheckpointLoadPre <- function(player)
{
    local mystate = Timer_GetCheckpointCustomData(player, "mystate")
}
::Timer_OnCheckpointLoadPost <- function(player)
{
    local mystate = Timer_GetCheckpointCustomData(player, "mystate")
}

TODO:

• Add a way to get the player's time... Timer_GetTime? lol
• Add Timer_OnStart and Timer_OnEnd?
• Indicate in OnCheckpointLoad if it's like a Segmented style checkpoint or like a kz checkpoint.
• Figure out a good way to indicate that a checkpoint is actually from a bot or something idk...
  • Maybe let the mapper find it out in OnCheckpointLoad when parsing the custom data and finding it empty?