Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for engine modules and permissions #5264

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Added documentation for engine modules and permissions

83c23bc
Select commit
Loading
Failed to load commit list.
Draft

Added documentation for engine modules and permissions #5264

Added documentation for engine modules and permissions
83c23bc
Select commit
Loading
Failed to load commit list.
Terasology Jenkins.io / SpotBugs succeeded Dec 16, 2024 in 0s

27 new issues, 1021 total

Total New Outstanding Fixed Trend
1021 27 994 0 👎

Reference build: Terasology » engine » develop #78

Details

Severity distribution of new issues

Error Warning High Warning Normal Warning Low
0 0 0 27

Annotations

Check warning on line 49 in engine/src/main/java/org/terasology/engine/audio/events/AbstractPlaySoundEvent.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.audio.events.AbstractPlaySoundEvent.getSound() may expose internal representation by returning AbstractPlaySoundEvent.sound
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 92 in engine/src/main/java/org/terasology/engine/audio/openAL/staticSound/OpenALSoundSource.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.audio.openAL.staticSound.OpenALSoundSource.getAudio() may expose internal representation by returning OpenALSoundSource.audio
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 48 in engine/src/main/java/org/terasology/engine/audio/openAL/streamingSound/OpenALStreamingSoundSource.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.audio.openAL.streamingSound.OpenALStreamingSoundSource.getAudio() may expose internal representation by returning OpenALStreamingSoundSource.audio
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 70 in engine/src/main/java/org/terasology/engine/entitySystem/entity/EntityStore.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.entitySystem.entity.EntityStore.getPrefab() may expose internal representation by returning EntityStore.prefab
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 31 in engine/src/main/java/org/terasology/engine/entitySystem/entity/lifecycleEvents/BeforeEntityCreated.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.entitySystem.entity.lifecycleEvents.BeforeEntityCreated.getPrefab() may expose internal representation by returning BeforeEntityCreated.prefab
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 90 in engine/src/main/java/org/terasology/engine/entitySystem/prefab/PrefabData.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.entitySystem.prefab.PrefabData.getParent() may expose internal representation by returning PrefabData.parent
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 33 in engine/src/main/java/org/terasology/engine/entitySystem/prefab/internal/PojoPrefab.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.entitySystem.prefab.internal.PojoPrefab.getParent() may expose internal representation by returning PojoPrefab.parent
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 75 in engine/src/main/java/org/terasology/engine/logic/behavior/CollectiveInterpreter.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.logic.behavior.CollectiveInterpreter.getTree() may expose internal representation by returning CollectiveInterpreter.tree
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 62 in engine/src/main/java/org/terasology/engine/logic/behavior/DefaultBehaviorTreeRunner.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.logic.behavior.DefaultBehaviorTreeRunner.getTree() may expose internal representation by returning DefaultBehaviorTreeRunner.tree
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 64 in engine/src/main/java/org/terasology/engine/logic/behavior/DefaultCollectiveBehaviorTreeRunner.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.logic.behavior.DefaultCollectiveBehaviorTreeRunner.getTree() may expose internal representation by returning DefaultCollectiveBehaviorTreeRunner.tree
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 73 in engine/src/main/java/org/terasology/engine/logic/behavior/Interpreter.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.logic.behavior.Interpreter.getTree() may expose internal representation by returning Interpreter.tree
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 116 in engine/src/main/java/org/terasology/engine/logic/behavior/nui/BehaviorEditor.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.logic.behavior.nui.BehaviorEditor.getTree() may expose internal representation by returning BehaviorEditor.tree
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 29 in engine/src/main/java/org/terasology/engine/logic/health/BeforeDestroyEvent.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.logic.health.BeforeDestroyEvent.getDamageType() may expose internal representation by returning BeforeDestroyEvent.damageType
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 33 in engine/src/main/java/org/terasology/engine/logic/health/DestroyEvent.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.logic.health.DestroyEvent.getDamageType() may expose internal representation by returning DestroyEvent.damageType
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 33 in engine/src/main/java/org/terasology/engine/logic/health/DoDestroyEvent.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.logic.health.DoDestroyEvent.getDamageType() may expose internal representation by returning DoDestroyEvent.damageType
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 69 in engine/src/main/java/org/terasology/engine/rendering/assets/font/FontCharacter.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.rendering.assets.font.FontCharacter.getPage() may expose internal representation by returning FontCharacter.page
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 27 in engine/src/main/java/org/terasology/engine/rendering/assets/material/MaterialData.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.rendering.assets.material.MaterialData.getShader() may expose internal representation by returning MaterialData.shader
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 27 in engine/src/main/java/org/terasology/engine/rendering/assets/texture/BasicTextureRegion.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.rendering.assets.texture.BasicTextureRegion.getTexture() may expose internal representation by returning BasicTextureRegion.texture
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 47 in engine/src/main/java/org/terasology/engine/rendering/assets/texture/subtexture/Subtexture.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.rendering.assets.texture.subtexture.Subtexture.getTexture() may expose internal representation by returning Subtexture.texture
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 19 in engine/src/main/java/org/terasology/engine/rendering/assets/texture/subtexture/SubtextureData.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.rendering.assets.texture.subtexture.SubtextureData.getTexture() may expose internal representation by returning SubtextureData.texture
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 17 in engine/src/main/java/org/terasology/engine/rendering/logic/AnimEndEvent.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.rendering.logic.AnimEndEvent.getAnimation() may expose internal representation by returning AnimEndEvent.animation
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 57 in engine/src/main/java/org/terasology/engine/rendering/primitives/BlockMeshShapeGenerator.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.rendering.primitives.BlockMeshShapeGenerator.getStandaloneMesh() may expose internal representation by returning BlockMeshShapeGenerator.mesh
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 206 in engine/src/main/java/org/terasology/engine/world/block/Block.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.world.block.Block.getSounds() may expose internal representation by returning Block.sounds
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 33 in engine/src/main/java/org/terasology/engine/world/block/entity/CreateBlockDropsEvent.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.world.block.entity.CreateBlockDropsEvent.getDamageType() may expose internal representation by returning CreateBlockDropsEvent.damageType
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>

Check warning on line 22 in engine/src/main/java/org/terasology/engine/world/block/loader/EntityData.java

See this annotation in the file changed.

@terasology-jenkins-io terasology-jenkins-io / SpotBugs

EI_EXPOSE_REP

LOW:
org.terasology.engine.world.block.loader.EntityData.getPrefab() may expose internal representation by returning EntityData.prefab
Raw output
<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object.&nbsp; If instances are accessed by untrusted code, and unchecked changes to the mutable object would compromise security or other important properties, you will need to do something different. Returning a new copy of the object is better approach in many situations.</p>