Skip to content

Commit 9f3411e

Browse files
ffsPLASMAffsPLASMA
committed
add more elements
1 parent 48a60b0 commit 9f3411e

23 files changed

+285
-0
lines changed

‎assets/server_console_help.jpg

46.9 KB
Loading

‎elements/blip.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: 'blip'
2+
description: |
3+
The blip class represents small icons or blips that can be shown on a player's radar.
4+
5+
The element type of this class is **"blip"**.
6+
7+
The list of blip icons are available on the [Radar Blips](/radar_blips) page.
8+
9+
TODO
10+
see_also:
11+
- 'category:Blip functions'
12+
- 'category:Blip events'

‎elements/building.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: 'building'
2+
description: |
3+
The building class represents static 3D models in the GTA world.
4+
5+
The element type of this class is **"building"**.
6+
7+
TODO
8+
notes:
9+
- |
10+
There is a distinction in GTA: San Andreas between static and dynamic models (these use a separate streaming system). Examples of buildings include building models, roads, and terrain. Objects created as [Buildings](/building) can contain **glass** and **shadows**, unlike those created as [Objects](/building) (which are missing these features).
11+
- |
12+
Buildings can be created with dynamic object model IDs, but they won't have any physical interaction. For example, [object ID 1502 (Gen_doorINT04)](https://dev.prineside.com/en/gtasa_samp_model_id/model/1502-Gen_doorINT04/) is a door that can only be opened if created with [createObject](/createObject).
13+
- |
14+
Using buildings for mapping is more optimized than using objects. Gains in FPS can be noticed in areas where a lot of objects were replaced with buildings of this new system.
15+
- |
16+
Buildings can only be created inside regular GTA:SA Map Boundaries (X between -3000 and 3000; Y between -3000 and 3000). Use [createObject](/createObject) to spawn objects outside these normal limits. **This limitation is probably going to stop existing in the near future.**
17+
- |
18+
Created buildings can have **LOD models**. The procedure is as follows: spawn the LOD building using [createBuilding](/createBuilding), then use [setLowLODElement](/setLowLODElement) to associate it with the non-LOD building element you created beforehand. LOD model distance changed with [engineSetModelLODDistance](/engineSetModelLODDistance) works for buildings.
19+
- |
20+
Buildings cannot appear in certain a [dimension](/dimension), and not show in others. Function [setElementDimension](/setElementDimension) returns false on any building. A building is created in a specific [interior world](/interior) (such as 0, the main world), like the default GTA:SA landscape objects. **All buildings appear in EVERY DIMENSION.**
21+
see_also:
22+
- 'category:Building functions'
23+
- 'category:Building events'

‎elements/camera.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'camera'
2+
description: |
3+
The camera class represents the local player camera rendering the game to the screen.
4+
5+
The element type of this class is **"camera"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Camera functions'
10+
- 'category:Camera events'

‎elements/col.yaml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: 'col'
2+
description: |
3+
The COL class represents a RenderWare Collision File (.col) loaded by the client, which can be imported into a custom model to define its collisions.
4+
5+
A .col file can contain one or more collision models. Normally, San Andreas assigns each collision model in a file to a geometry model through the model name that is embedded in the collision model.
6+
However in MTA, you can assign any .col file to any model ID; the names are ignored. To prevent loading multiple collision models into one model ID, MTA only loads the first collision model of a .col file and ignores the rest.
7+
Therefore, if you have a .col file containing multiple collision models, you will need to split it into multiple files, with one model per file, and then load and import each of those files using the appropriate scripting functions.
8+
To split a .col file into multiple files, you can use [CollEditor2](http://www.steve-m.com/downloads/tools/colleditor2/).
9+
10+
Collision data can also be embedded in DFF files. At the moment, vehicle collision replacement works with DFF embedded collisions only.
11+
12+
The element type of this class is **"col"**.
13+
14+
TODO
15+
see_also:
16+
- 'category:Col functions'
17+
- 'category:Col events'

‎elements/collision_shape.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'collision_shape'
2+
description: |
3+
The collision shape class represents invisible collision detection shapes that can be created in the GTA world. Collision shapes are typically used to detect physical entities moving through them and perform actions when they do.
4+
5+
The element type for this class is **"colshape"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Collision_shape functions'
10+
- 'category:Collision_shape events'

‎elements/console.yaml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: 'console'
2+
description: |
3+
The Server Console class represents the server console.
4+
5+
The element type of this class is **"console"**.
6+
7+
In the server console you can use many different commands, affecting the players using the server. Please note that only console commands can be used, and that some commands can not be used through the in-game client console, only through the Server Console.
8+
9+
You can view all latest available server console commands by entering **"help"** into the server console window.
10+
11+
TODO
12+
preview_images:
13+
- path: '/assets/server_console_help.jpg'
14+
description: 'Help output inside server console:'
15+
see_also:
16+
- 'category:Console functions'
17+
- 'category:Console events'

‎elements/dff.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: 'dff'
2+
description: |
3+
The DFF class represents a RenderWare Model File (DFF) loaded by the client, which can be used to replace the model associated to a certain model ID. After this has been done, the custom model is applied to all newly created entities from that ID.
4+
5+
Collision data can also be embedded in DFF files. At the moment, vehicle collision replacement works with DFF embedded collisions only.
6+
7+
The element type of this class is **"dff"**.
8+
9+
TODO
10+
see_also:
11+
- 'category:Dff functions'
12+
- 'category:Dff events'

‎elements/effect.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'effect'
2+
description: |
3+
The Effect class represents custom effect elements in the game world such as smoke, sparks, fire etc.
4+
5+
The element type of this class is **"effect"**.
6+
7+
TODO: add all the effects as a table...
8+
see_also:
9+
- 'category:Effect functions'
10+
- 'category:Effect events'

‎elements/light.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'light'
2+
description: |
3+
The light class represents colored, 3D lights in the GTA world. There are a couple different types of lights, which are point lights, spot lights and dark lights.
4+
5+
The element type of this class is **"light"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Light functions'
10+
- 'category:Light events'

‎elements/marker.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'marker'
2+
description: |
3+
The marker class represents colored, 3D shapes in the GTA world. There are several types of markers, including cylinders and checkpoints. In scripts, markers are often used to mark spots and trigger some sort of action when a player goes into them.
4+
5+
The element type of this class is **"marker"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Marker functions'
10+
- 'category:Marker events'

‎elements/object.yaml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: 'object'
2+
description: |
3+
The object class represents dynamic and static 3D models placed in the GTA world.
4+
5+
The element type of this class is **"object"**.
6+
7+
TODO
8+
notes:
9+
- |
10+
Objects only represent models **created by a script**, they do not represent objects that are part of GTA's default landscape (these belong to the "building pool").
11+
- |
12+
There is a distinction in GTA: San Andreas between static and dynamic models. The alternative [createBuilding](/createBuilding) function allows you to create objects that are non-dynamic, utilizing the GTA Building pool, which makes better use of memory.
13+
- |
14+
The [createObject](/createObject) function can also create non-dynamic objects, but for optimization reasons **it is recommended to spawn [Buildings](/building) when creating static objects that don't rely on the [Dimension](/dimension) system** (buildings don't use the same MTA object-streaming system).
15+
see_also:
16+
- 'category:Object functions'
17+
- 'category:Object events'

‎elements/ped.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: 'ped'
2+
description: |
3+
The word "ped" is short for "pedestrian" and describes any person in GTA, be it a player or an NPC character. (And even though "pedestrian" doesn't technically apply to people that drive, they still fall under this name)
4+
5+
The [createPed](/createPed) function specifically creates an NPC, but all other ped functions work on both players and NPC's as they're pretty much the same thing to San Andreas.
6+
7+
The element type of a NPC is **"ped"**.
8+
9+
TODO
10+
see_also:
11+
- 'category:Ped functions'
12+
- 'category:Ped events'

‎elements/pickup.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'pickup'
2+
description: |
3+
The pickup class represents weapon, health, or armor pickups in the GTA world. Pickups can be picked up by players when they are walked over. Players will not be given health or armor pickups if their health or armor is already full.
4+
5+
The element type of this class is **"pickup"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Pickup functions'
10+
- 'category:Pickup events'

‎elements/projectile.yaml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: 'projectile'
2+
description: |
3+
The projectile class represents the projectiles of certain weapons that are created when the weapon is fired. Alternatively these can be created using [createProjectile](/createProjectile).
4+
5+
The element type of this class is **"projectile"**.
6+
7+
TODO
8+
notes:
9+
- |
10+
**16: Grenade**
11+
- |
12+
**17: Tear Gas Grenade**
13+
- |
14+
**18: Molotov**
15+
- |
16+
**19: Rocket (simple)**
17+
- |
18+
**20: Rocket (heat seeking)**
19+
- |
20+
**21: Air Bomb**
21+
- |
22+
**39: Satchel Charge**
23+
- |
24+
**58: Flare from Hydra**
25+
see_also:
26+
- 'category:Projectile functions'
27+
- 'category:Projectile events'

‎elements/radar_area.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'radar_area'
2+
description: |
3+
The radar area class represents coloured areas that can be displayed on a player's radar.
4+
5+
The element type of this class is **"radararea"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Radar_area functions'
10+
- 'category:Radar_area events'

‎elements/searchlight.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'searchlight'
2+
description: |
3+
The searchlight class represents special spotlights in the GTA world. They are different to common spotlights because their visual effects.
4+
5+
The element type of this class is **"searchlight"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Searchlight functions'
10+
- 'category:Searchlight events'

‎elements/sound.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: 'sound'
2+
description: |
3+
The sound element represents a custom sound sent to the client via the use of the file parameter inside the meta file and created either by [playSound](/playSound) or [playSound3D](/playSound3D).
4+
5+
A sound element can be manipulated in the GTA 3D world via [setElementPosition](/setElementPosition) and [setElementDimension](/setElementDimension).
6+
7+
Sound elements can also be manipulated using the other [Client audio functions](/client_audio_functions).
8+
9+
The element type of this class is **"sound"**.
10+
11+
TODO
12+
see_also:
13+
- 'category:Sound functions'
14+
- 'category:Sound events'

‎elements/team.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: 'team'
2+
description: |
3+
The team class represents player teams. Players on the same team can use team features such as teamchat or friendly fire.
4+
5+
A common misconception is that players would be child elements of team elements. This is wrong. Being part of a team is merely a relational connection rather than a change in element hierarchy. To perform logic on all the players of a team you have to use the [getPlayersInTeam](/getPlayersInTeam) function.
6+
7+
The element type of this class is **"team"**.
8+
9+
TODO
10+
see_also:
11+
- 'category:Team functions'
12+
- 'category:Team events'

‎elements/txd.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'txd'
2+
description: |
3+
The TXD class represents a RenderWare Texture Dictionary (TXD) loaded by the client, which can be imported into a custom model to texture it.
4+
5+
The element type of this class is **"txd"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Txd functions'
10+
- 'category:Txd events'

‎elements/vehicle.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'vehicle'
2+
description: |
3+
The vehicle class represents vehicles in the GTA world. Vehicles can be occupied and controlled by players and peds.
4+
5+
The element type of this class is **"vehicle"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Vehicle functions'
10+
- 'category:Vehicle events'

‎elements/water.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: 'water'
2+
description: |
3+
In San Andreas, the water in the game world (rivers, lakes, seas) is defined through a large number of water polygons, which can be quadrilateral or triangular.
4+
5+
A water element represents one such polygon. You can create water elements using [createWater](/createWater).
6+
7+
The element type of this class is **"water"**.
8+
9+
TODO
10+
see_also:
11+
- 'category:Water functions'
12+
- 'category:Water events'

‎elements/weapon.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 'weapon'
2+
description: |
3+
The Weapon class represents a custom static weapon. Weapon elements created by [createWeapon](/createWeapon) can be manipulated with the following scripting functions.
4+
5+
The element type of this class is **"weapon"**.
6+
7+
TODO
8+
see_also:
9+
- 'category:Weapon functions'
10+
- 'category:Weapon events'

0 commit comments

Comments
 (0)