Modding analyzers

[BadMagic100]

We should create a set of analyzers to promote silksong specific best practices, such as accessing PlayerData through the getters and setters rather than direct field access (this analyzer+fix is the initial scope but more analyzers may obviously be added later)

[flibber-hk]

For the purposes of collecting stuff in one place: if possible, telling people not to hook certain types such as Language, or look for the saves filepath, in Awake, would be nice. Although it does sound harder than the pd suggestion

[BadMagic100]

I don't think it's much harder tbh

[flibber-hk]

Since I just thought of it:

A warning when people do Constants.GAME_VERSION when they mean (string)(typeof(Constants).GetField(nameof(Constants.GAME_VERSION)).GetRawConstantValue())

[BadMagic100]

Seems reasonable (other than the gross reflection code)

[flibber-hk]

Since I just thought of it:

An analyzer to emit a warning if people use a literal int as the index parameter for remove/replace methods in FsmUtil, since that can be brittle to other people making modifications. Obviously computed ints should be fine, as should remove/replace by type

[BadMagic100]

Another: prefer GameManager.GetSceneNameString (or just scene.name) to GameManager.sceneName

[flibber-hk]

Another (in view of the existing bug in FsmUtil): emit a warning if people try to access a publicized field when it’s backing a public property. I think this would be hard to do properly but you could get a decent pass just by checking if the capitalized version exists (E.g. actions -> Actions).