Weapon Caching

FOR MOD USERS:

This mod itself does not do anything to the game, install only if another mod requires this.

Change configs under Script Generated UI -> !Weapon Caching

• []Frames per Attempt: Number of frames to wait between attempts. Increasing it slows down caching, but may prevent disconnects/crashes.

  []Cache Function Attempts: Number of attempts for each caching function. Increase will make caching slower, but may improve success rate.

  FOR MOD AUTHORS:

  For some modding purpose you might need to cache instances related to weapons that are destroied when the weapon is changed. This mod does the caching by first change the player's weapon to the corresponding weapon type, then run a customizable caching function to perform the caching.

  To use this functionality, put this code in your lua script:

  -- init cache

  local TARGET_WP_TYPE = 0 -- 0~13

  local cache = nil

  local cache_task_submitted = false

  local function cache_func()

  -- this is a function that stores the cache and returns true if success

  -- cache = blablabla

  return cache ~= nil

  -- wait until _WEAPON_CACHING is loaded

  if _WEAPON_CACHING then

  _WEAPON_CACHING.register_cache_task(TARGET_WP_TYPE, cache_func)

  cache_task_submitted = true

  re.on_frame(function()

  if not cache_task_submitted and _WEAPON_CACHING then

  _WEAPON_CACHING.register_cache_task(TARGET_WP_TYPE, cache_func)

  cache_task_submitted = true

  -- mod function

  local function use_cache()

  if not cache then return end

  --blablabla

  For more examples, check "Mods requiring this file" above in the "Requirements" tab.

  致 mod 用户：

  本 mod 自身没有任何对游戏的修改，你只需要在其他 mod 要求此 mod 时安装。

  在 Script Generated UI -> !Weapon Caching 下修改配置

  • []Frames per Attempt: 增加会让 caching 变慢，但可以防止掉线或闪退

    []Cache Function Attempts: 每个 caching function 的尝试次数，增加会让 caching 变慢，但可以增加成功率

    致 mod 作者：见上文英文