Classes de elemento
As 34 classes abaixo cobrem todos os tipos de elemento — 667 métodos e 205 propriedades. Elas não acrescentam comportamento próprio: cada linha nomeia a nativa para a qual o membro encaminha, e é a página daquela nativa que documenta os argumentos e os retornos.
A coluna Acessores lista primeiro o getter da propriedade, depois o setter. Quando só um aparece, as Notas dizem qual é. A coluna Lado é onde o membro realmente existe; ambos significa os dois lados. Membros herdados de uma classe-pai aparecem listados apenas nela. Quando um método remodela o resultado da nativa, as Notas dizem como.
Veja o guia de OOP para entender como métodos, propriedades e construtores são montados.
Element
Seção intitulada “Element”A classe base. Todas as outras herdam dela, e qualquer elemento cujo tipo não tenha classe própria é atendido por Element.
Referência: Elementos (compartilhadas) · Elementos (servidor) · Elementos (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
addDataSubscriber | addElementDataSubscriber | servidor | — |
attach | attachElements | ambos | — |
clearVisibility | clearElementVisibleTo | servidor | — |
clone | cloneElement | servidor | — |
create | createElement | ambos | — |
destroy | destroyElement | ambos | — |
detach | detachElements | ambos | — |
getAllByType | getElementsByType | ambos | — |
getAllData | getAllElementData | ambos | — |
getAlpha | getElementAlpha | ambos | — |
getAngularVelocity | getElementAngularVelocity | ambos | — |
getAttachedElements | getAttachedElements | ambos | — |
getAttachedOffsets | getElementAttachedOffsets | ambos | — |
getAttachedTo | getElementAttachedTo | ambos | — |
getBoundingBox | getElementBoundingBox | cliente | devolve dois Vector3, ou seis números quando seis resultados são recebidos |
getByID | getElementByID | ambos | — |
getByIndex | getElementByIndex | ambos | — |
getByType | getElementsByType | ambos | — |
getChild | getElementChild | ambos | — |
getChildren | getElementChildren | ambos | — |
getChildrenCount | getElementChildrenCount | ambos | — |
getCollisionsEnabled | getElementCollisionsEnabled | ambos | — |
getColShape | getElementColShape | ambos | — |
getData | getElementData | ambos | — |
getDimension | getElementDimension | ambos | — |
getDistanceFromCentreOfMassToBaseOfModel | getElementDistanceFromCentreOfMassToBaseOfModel | cliente | — |
getHealth | getElementHealth | ambos | — |
getID | getElementID | ambos | — |
getInterior | getElementInterior | ambos | — |
getLighting | getElementLighting | cliente | — |
getLowLOD | getLowLODElement | ambos | — |
getMatrix | getElementMatrix | ambos | — |
getModel | getElementModel | ambos | — |
getParent | getElementParent | ambos | — |
getPosition | getElementPosition | ambos | — |
getRadius | getElementRadius | cliente | — |
getRotation | getElementRotation | ambos | — |
getType | getElementType | ambos | — |
getVelocity | getElementVelocity | ambos | — |
getWithinColShape | getElementsWithinColShape | ambos | — |
getWithinRange | getElementsWithinRange | ambos | — |
getZoneName | getElementZoneName | servidor | — |
hasData | hasElementData | ambos | — |
hasDataSubscriber | hasElementDataSubscriber | servidor | — |
isAttached | isElementAttached | ambos | — |
isCallPropagationEnabled | isElementCallPropagationEnabled | ambos | — |
isCollidableWith | isElementCollidableWith | cliente | — |
isDoubleSided | isElementDoubleSided | ambos | — |
isFrozen | isElementFrozen | ambos | — |
isInWater | isElementInWater | ambos | — |
isLocal | isElementLocal | cliente | — |
isLowLOD | isElementLowLOD | ambos | — |
isOnFire | isElementOnFire | ambos | — |
isOnScreen | isElementOnScreen | cliente | — |
isStreamable | isElementStreamable | cliente | — |
isStreamedIn | isElementStreamedIn | cliente | — |
isSyncer | isElementSyncer | cliente | — |
isVisibleTo | isElementVisibleTo | servidor | — |
isWaitingForGroundToLoad | isElementWaitingForGroundToLoad | cliente | — |
isWithinColShape | isElementWithinColShape | ambos | — |
isWithinMarker | isElementWithinMarker | ambos | — |
removeData | removeElementData | servidor | — |
removeDataSubscriber | removeElementDataSubscriber | servidor | — |
setAlpha | setElementAlpha | ambos | — |
setAngularVelocity | setElementAngularVelocity | ambos | — |
setAttachedOffsets | setElementAttachedOffsets | ambos | — |
setCallPropagationEnabled | setElementCallPropagationEnabled | ambos | — |
setCollidableWith | setElementCollidableWith | cliente | — |
setCollisionsEnabled | setElementCollisionsEnabled | ambos | — |
setData | setElementData | ambos | — |
setDimension | setElementDimension | ambos | — |
setDoubleSided | setElementDoubleSided | ambos | — |
setFrozen | setElementFrozen | ambos | — |
setHealth | setElementHealth | ambos | — |
setID | setElementID | ambos | — |
setInterior | setElementInterior | ambos | — |
setLighting | setElementLighting | cliente | — |
setLowLOD | setLowLODElement | ambos | — |
setMatrix | setElementMatrix | ambos | — |
setModel | setElementModel | ambos | — |
setOnFire | setElementOnFire | ambos | — |
setParent | setElementParent | ambos | — |
setPosition | setElementPosition | ambos | — |
setRotation | setElementRotation | ambos | — |
setStreamable | setElementStreamable | cliente | — |
setVelocity | setElementVelocity | ambos | — |
setVisibleTo | setElementVisibleTo | servidor | — |
Propriedades
Personagens não jogáveis. Também é a base de Player, então todo método de ped funciona em jogadores.
Herda de Element.
Referência: Peds (compartilhadas) · Peds (servidor) · Peds (cliente)
Métodos
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
armor | getPedArmor · setPedArmor | ambos | — |
bleeding | isPedBleeding · setPedBleeding | cliente | — |
cameraRotation | getPedCameraRotation · setPedCameraRotation | cliente | — |
canBeKnockedOffBike | canPedBeKnockedOffBike · setPedCanBeKnockedOffBike | cliente | leitura sombreada pelo método de mesmo nome |
choking | isPedChoking · setPedChoking | ambos | setter só no servidor |
contactElement | getPedContactElement | ambos | somente leitura |
dead | isPedDead · killPed | ambos | age apenas com valor verdadeiro |
doingGangDriveby | isPedDoingGangDriveby · setPedDoingGangDriveby | ambos | — |
ducked | isPedDucked | ambos | somente leitura |
fightingStyle | getPedFightingStyle · setPedFightingStyle | ambos | — |
footBlood | setPedFootBloodEnabled | cliente | somente escrita |
gravity | getPedGravity · setPedGravity | servidor | — |
hasJetPack | isPedWearingJetpack | ambos | somente leitura |
headless | isPedHeadless · setPedHeadless | ambos | — |
inVehicle | isPedInVehicle | ambos | somente leitura |
jetpack | isPedWearingJetpack · setPedWearingJetpack | ambos | setter só no servidor |
moveState | getPedMoveState | cliente | somente leitura |
onGround | isPedOnGround | ambos | somente leitura |
oxygenLevel | getPedOxygenLevel · setPedOxygenLevel | cliente | — |
reloadingWeapon | isPedReloadingWeapon | ambos | somente leitura |
simplestTask | getPedSimplestTask | cliente | somente leitura |
target | getPedTarget | ambos | somente leitura |
targetingMarker | isPedTargetingMarkerEnabled · setPedTargetingMarkerEnabled | cliente | — |
vehicle | getPedOccupiedVehicle · warpPedIntoVehicle | ambos | — |
vehicleSeat | getPedOccupiedVehicleSeat | ambos | somente leitura |
walkingStyle | getPedWalkingStyle · setPedWalkingStyle | ambos | — |
weaponSlot | getPedWeaponSlot · setPedWeaponSlot | ambos | — |
Jogadores conectados. Herda toda a API de ped, além da própria.
Herda de Ped.
Referência: Jogadores (compartilhadas) · Jogadores (servidor) · Jogadores (cliente)
Métodos
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
blurLevel | getPlayerBlurLevel · setPlayerBlurLevel | servidor | — |
crosshairVisible | isPlayerCrosshairVisible | cliente | somente leitura, ignora o self |
idleTime | getPlayerIdleTime | servidor | somente leitura |
ip | getPlayerIP | servidor | somente leitura |
muted | isPlayerMuted · setPlayerMuted | servidor | — |
name | getPlayerName · setPlayerName | ambos | setter só no servidor |
nametagShowing | isPlayerNametagShowing · setPlayerNametagShowing | ambos | — |
nametagText | getPlayerNametagText · setPlayerNametagText | ambos | — |
ping | getPlayerPing | ambos | somente leitura |
talking | isPlayerTalking | cliente | somente leitura |
version | getPlayerVersion | servidor | somente leitura |
voiceBroadcastTo | setPlayerVoiceBroadcastTo | servidor | somente escrita |
voiceIgnoreFrom | setPlayerVoiceIgnoreFrom | servidor | somente escrita |
Vehicle
Seção intitulada “Vehicle”Veículos — a maior classe da API.
Herda de Element.
Referência: Veículos (compartilhadas) · Veículos (servidor) · Veículos (cliente)
Métodos
Propriedades
Objetos do mundo, incluindo os que se movem e os que quebram.
Herda de Element.
Referência: Objetos (compartilhadas) · Objetos (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
break | breakObject | ambos | — |
clearFractureProfile | clearObjectFractureProfile | servidor | — |
create | createObject | ambos | — |
fracture | createObjectFracture | servidor | — |
getFractureProfile | getObjectFractureProfile | servidor | — |
getGravity | isObjectGravityEnabled | ambos | — |
getMass | getObjectMass | ambos | — |
getProperties | getObjectProperty | ambos | passa "all" |
getProperty | getObjectProperty | ambos | — |
getScale | getObjectScale | cliente | devolve Vector3, a menos que três resultados sejam recebidos |
getScale | getObjectScale | servidor | — |
isBreakable | isObjectBreakable | ambos | — |
isDynamicPhysics | isElementDynamicPhysics | ambos | — |
isGravityEnabled | isObjectGravityEnabled | ambos | — |
isMoving | isObjectMoving | ambos | — |
isRespawnable | isObjectRespawnable | ambos | — |
move | moveObject | ambos | — |
respawn | respawnObject | ambos | — |
setBreakable | setObjectBreakable | ambos | — |
setDynamicPhysics | setElementDynamicPhysics | ambos | — |
setFractureProfile | setObjectFractureProfile | servidor | — |
setGravity | setObjectGravity | ambos | — |
setMass | setObjectMass | ambos | — |
setProperty | setObjectProperty | ambos | — |
setScale | setObjectScale | ambos | — |
stop | stopObject | ambos | — |
toggleObjectRespawn | toggleObjectRespawn | ambos | — |
toggleRespawn | toggleObjectRespawn | ambos | — |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
breakable | isObjectBreakable · setObjectBreakable | ambos | — |
dynamicPhysics | isElementDynamicPhysics · setElementDynamicPhysics | ambos | — |
fractureProfile | getObjectFractureProfile · setObjectFractureProfile | servidor | — |
gravity | isObjectGravityEnabled · setObjectGravity | ambos | — |
mass | getObjectMass · setObjectMass | ambos | — |
moving | isObjectMoving | ambos | somente leitura |
properties | getObjectProperty | ambos | somente leitura, passa "all" |
respawnable | isObjectRespawnable | ambos | somente leitura |
scale | getObjectScale · setObjectScale | ambos | devolve Vector3 |
Marcadores: checkpoints, cilindros, setas e coronas.
Herda de Element.
Referência: Marcadores (compartilhadas) · Marcadores (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
create | createMarker | ambos | — |
getColor | getMarkerColor | ambos | — |
getCount | getMarkerCount | ambos | — |
getIcon | getMarkerIcon | ambos | — |
getMarkerType | getMarkerType | ambos | — |
getSize | getMarkerSize | ambos | — |
getTarget | getMarkerTarget | ambos | devolve Vector3 |
isCoronaReflectionEnabled | isCoronaReflectionEnabled | cliente | — |
setColor | setMarkerColor | ambos | — |
setCoronaReflectionEnabled | setCoronaReflectionEnabled | cliente | — |
setIcon | setMarkerIcon | ambos | — |
setSize | setMarkerSize | ambos | — |
setTarget | setMarkerTarget | ambos | — |
setType | setMarkerType | ambos | — |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
icon | getMarkerIcon · setMarkerIcon | ambos | — |
markerType | getMarkerType · setMarkerType | ambos | — |
size | getMarkerSize · setMarkerSize | ambos | — |
target | getMarkerTarget · setMarkerTarget | ambos | devolve Vector3 |
Blips do radar.
Herda de Element.
Referência: Blips (compartilhadas)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | createBlip | ambos |
createAttachedTo | createBlipAttachedTo | ambos |
getColor | getBlipColor | ambos |
getIcon | getBlipIcon | ambos |
getOrdering | getBlipOrdering | ambos |
getSize | getBlipSize | ambos |
getVisibleDistance | getBlipVisibleDistance | ambos |
setColor | setBlipColor | ambos |
setIcon | setBlipIcon | ambos |
setOrdering | setBlipOrdering | ambos |
setSize | setBlipSize | ambos |
setVisibleDistance | setBlipVisibleDistance | ambos |
Propriedades
| Propriedade | Acessores | Lado |
|---|---|---|
icon | getBlipIcon · setBlipIcon | ambos |
ordering | getBlipOrdering · setBlipOrdering | ambos |
size | getBlipSize · setBlipSize | ambos |
visibleDistance | getBlipVisibleDistance · setBlipVisibleDistance | ambos |
Pickups de armas, vida, colete e modelos personalizados.
Herda de Element.
Referência: Pickups (compartilhadas) · Pickups (servidor)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | createPickup | ambos |
getAmmo | getPickupAmmo | ambos |
getAmount | getPickupAmount | ambos |
getPickupType | getPickupType | ambos |
getRespawnInterval | getPickupRespawnInterval | servidor |
getType | getPickupType | ambos |
getWeapon | getPickupWeapon | ambos |
isSpawned | isPickupSpawned | servidor |
setRespawnInterval | setPickupRespawnInterval | servidor |
setType | setPickupType | ambos |
use | usePickup | servidor |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
ammo | getPickupAmmo | ambos | somente leitura |
amount | getPickupAmount | ambos | somente leitura |
pickupType | getPickupType · setPickupType | ambos | — |
respawnInterval | getPickupRespawnInterval · setPickupRespawnInterval | servidor | — |
spawned | isPickupSpawned | servidor | somente leitura |
type | getPickupType · setPickupType | servidor | no cliente, quem responde é Element.type |
weapon | getPickupWeapon | ambos | somente leitura |
ColShape
Seção intitulada “ColShape”Formas de colisão. No lugar de um único create, expõe um construtor por forma: Circle, Cuboid, Polygon, Rectangle, Sphere e Tube.
Herda de Element.
Referência: Colshapes (compartilhadas) · Colshapes (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
Circle | createColCircle | ambos | — |
Cuboid | createColCuboid | ambos | — |
Polygon | createColPolygon | ambos | — |
Rectangle | createColRectangle | ambos | — |
Sphere | createColSphere | ambos | — |
Tube | createColTube | ambos | — |
addPoint | addColPolygonPoint | ambos | — |
getElementsWithin | getElementsWithinColShape | ambos | — |
getHeight | getColPolygonHeight | ambos | — |
getPointPosition | getColPolygonPointPosition | ambos | devolve Vector2 |
getPoints | getColPolygonPoints | ambos | devolve uma tabela de Vector2 |
getRadius | getColShapeRadius | ambos | — |
getShapeType | getColShapeType | ambos | — |
getSize | getColShapeSize | ambos | devolve Vector2, Vector3 ou um número, conforme a forma |
isInside | isInsideColShape | ambos | — |
removePoint | removeColPolygonPoint | ambos | — |
setHeight | setColPolygonHeight | ambos | — |
setPointPosition | setColPolygonPointPosition | ambos | — |
setRadius | setColShapeRadius | ambos | — |
setSize | setColShapeSize | ambos | — |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
elementsWithin | getElementsWithinColShape | ambos | somente leitura |
points | getColPolygonPoints | ambos | somente leitura, devolve uma tabela de Vector2 |
radius | getColShapeRadius · setColShapeRadius | ambos | — |
shapeType | getColShapeType | ambos | somente leitura |
size | getColShapeSize · setColShapeSize | ambos | devolve Vector2, Vector3 ou um número, conforme a forma |
Building
Seção intitulada “Building”Construções carregadas pelo streaming do cliente.
Herda de Element.
Referência: Construções (compartilhadas)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | createBuilding | ambos |
Planos de água. Vários membros agem sobre o mundo e não sobre o plano, por isso ignoram o elemento em que foram chamados.
Herda de Element.
Referência: Água (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
create | createWater | ambos | — |
getColor | getWaterColor | ambos | — |
getLevel | getWaterLevel | cliente | — |
getVertexPosition | getWaterVertexPosition | ambos | — |
getWaveHeight | getWaveHeight | ambos | ignora o self |
isDrawnLast | isWaterDrawnLast | cliente | ignora o self |
resetColor | resetWaterColor | ambos | — |
resetLevel | resetWaterLevel | ambos | — |
setColor | setWaterColor | ambos | — |
setDrawnLast | setWaterDrawnLast | cliente | ignora o self |
setLevel | setWaterLevel | ambos | — |
setVertexPosition | setWaterVertexPosition | ambos | — |
setWaveHeight | setWaveHeight | ambos | ignora o self |
testLineAgainst | testLineAgainstWater | cliente | ignora o self |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
height | getWaveHeight · setWaveHeight | ambos | ignora o self |
level | getWaterLevel · setWaterLevel | ambos | getter só no cliente |
Foliage
Seção intitulada “Foliage”Manchas de vegetação — gramas e arbustos plantáveis sobre as superfícies do mundo.
Herda de Element.
Referência: Vegetação (compartilhadas) · Vegetação (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
create | createFoliage | ambos | — |
getDensity | getFoliageDensity | ambos | — |
getLight | getFoliageLight | ambos | — |
getPoolUsage | getFoliagePoolUsage | cliente | ignora o self |
getSurface | getFoliageSurface | ambos | — |
getTriangleCounts | getFoliageTriangleCounts | cliente | — |
getVertexPosition | getFoliageVertexPosition | ambos | — |
getVertices | getFoliageVertices | ambos | — |
isVisible | isFoliageVisible | ambos | — |
setDensity | setFoliageDensity | ambos | — |
setLight | setFoliageLight | ambos | — |
setSurface | setFoliageSurface | ambos | — |
setVertexPosition | setFoliageVertexPosition | ambos | — |
setVertices | setFoliageVertices | ambos | — |
setVisible | setFoliageVisible | ambos | — |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
density | getFoliageDensity · setFoliageDensity | ambos | — |
light | getFoliageLight · setFoliageLight | ambos | — |
surface | getFoliageSurface · setFoliageSurface | ambos | — |
visible | isFoliageVisible · setFoliageVisible | ambos | — |
Fracture
Seção intitulada “Fracture”Uma simulação de fratura — os fragmentos em que um objeto se quebra.
Herda de Element.
Referência: Fratura (compartilhadas) · Fratura (servidor) · Fratura (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
getFragmentCount | getFractureFragmentCount | ambos | — |
getFragments | getFractureFragments | ambos | — |
getSleepingFragmentCount | getFractureSleepingFragmentCount | ambos | — |
getSource | getObjectFractureSource | ambos | — |
getSourceTriangleCount | getFractureSourceTriangleCount | ambos | — |
isPaused | isFracturePaused | ambos | — |
restore | restoreObjectFracture | servidor | — |
setPaused | setFracturePaused | ambos | — |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
fragmentCount | getFractureFragmentCount | ambos | somente leitura |
paused | isFracturePaused | ambos | somente leitura |
source | getObjectFractureSource | ambos | somente leitura |
Elementos de som — 2D com create e 3D com create3D. No cliente, um som 3D é atendido por Sound3D.
Herda de Element.
Referência: Som (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | playSound | cliente |
create3D | playSound3D | cliente |
getBPM | getSoundBPM | cliente |
getBufferLength | getSoundBufferLength | cliente |
getEffectParameters | getSoundEffectParameters | cliente |
getEffects | getSoundEffects | cliente |
getFFTData | getSoundFFTData | cliente |
getLength | getSoundLength | cliente |
getLevelData | getSoundLevelData | cliente |
getMaxDistance | getSoundMaxDistance | cliente |
getMetaTags | getSoundMetaTags | cliente |
getMinDistance | getSoundMinDistance | cliente |
getPan | getSoundPan | cliente |
getPlaybackPosition | getSoundPosition | cliente |
getProperties | getSoundProperties | cliente |
getSpeed | getSoundSpeed | cliente |
getVolume | getSoundVolume | cliente |
getWaveData | getSoundWaveData | cliente |
isLooped | isSoundLooped | cliente |
isPanningEnabled | isSoundPanningEnabled | cliente |
isPaused | isSoundPaused | cliente |
playFrontEnd | playSoundFrontEnd | ambos |
setEffectEnabled | setSoundEffectEnabled | cliente |
setEffectParameter | setSoundEffectParameter | cliente |
setLooped | setSoundLooped | cliente |
setMaxDistance | setSoundMaxDistance | cliente |
setMinDistance | setSoundMinDistance | cliente |
setPan | setSoundPan | cliente |
setPanningEnabled | setSoundPanningEnabled | cliente |
setPaused | setSoundPaused | cliente |
setPlaybackPosition | setSoundPosition | cliente |
setProperties | setSoundProperties | cliente |
setSpeed | setSoundSpeed | cliente |
setVolume | setSoundVolume | cliente |
stop | stopSound | cliente |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
bufferLength | getSoundBufferLength | cliente | somente leitura |
length | getSoundLength | cliente | somente leitura |
looped | isSoundLooped · setSoundLooped | cliente | — |
maxDistance | getSoundMaxDistance · setSoundMaxDistance | cliente | — |
minDistance | getSoundMinDistance · setSoundMinDistance | cliente | — |
pan | getSoundPan · setSoundPan | cliente | — |
panningEnabled | isSoundPanningEnabled · setSoundPanningEnabled | cliente | — |
paused | isSoundPaused · setSoundPaused | cliente | — |
playbackPosition | getSoundPosition · setSoundPosition | cliente | — |
speed | getSoundSpeed · setSoundSpeed | cliente | — |
volume | getSoundVolume · setSoundVolume | cliente | — |
Sound3D
Seção intitulada “Sound3D”Sons 3D. No cliente, um som tocado com playSound3D resolve para esta classe em vez de Sound, então ele atende a tudo o que está abaixo além de toda a API de Sound. Os membros de distância repetem os que Sound já tem, com as mesmas nativas.
Herda de Sound.
Referência: Som (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | playSound3D | cliente |
getMaxDistance | getSoundMaxDistance | cliente |
getMinDistance | getSoundMinDistance | cliente |
setMaxDistance | setSoundMaxDistance | cliente |
setMinDistance | setSoundMinDistance | cliente |
Propriedades
| Propriedade | Acessores | Lado |
|---|---|---|
maxDistance | getSoundMaxDistance · setSoundMaxDistance | cliente |
minDistance | getSoundMinDistance · setSoundMinDistance | cliente |
Efeitos de partículas.
Herda de Element.
Referência: Efeitos visuais (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
addBlood | fxAddBlood | cliente |
addBulletImpact | fxAddBulletImpact | cliente |
addBulletSplash | fxAddBulletSplash | cliente |
addDebris | fxAddDebris | cliente |
addFootSplash | fxAddFootSplash | cliente |
addGlass | fxAddGlass | cliente |
addGunshot | fxAddGunshot | cliente |
addPunchImpact | fxAddPunchImpact | cliente |
addSparks | fxAddSparks | cliente |
addTankFire | fxAddTankFire | cliente |
addTyreBurst | fxAddTyreBurst | cliente |
addWaterHydrant | fxAddWaterHydrant | cliente |
addWaterSplash | fxAddWaterSplash | cliente |
addWood | fxAddWood | cliente |
create | createEffect | cliente |
createParticle | fxCreateParticle | cliente |
getDensity | getEffectDensity | cliente |
getSpeed | getEffectSpeed | cliente |
setDensity | setEffectDensity | cliente |
setSpeed | setEffectSpeed | cliente |
Propriedades
| Propriedade | Acessores | Lado |
|---|---|---|
density | getEffectDensity · setEffectDensity | cliente |
speed | getEffectSpeed · setEffectSpeed | cliente |
Luzes dinâmicas.
Herda de Element.
Referência: Luzes (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
create | createLight | cliente | — |
getColor | getLightColor | cliente | — |
getDirection | getLightDirection | cliente | devolve Vector3, a menos que três resultados sejam recebidos |
getLightType | getLightType | cliente | — |
getRadius | getLightRadius | cliente | — |
getType | getLightType | cliente | — |
setColor | setLightColor | cliente | — |
setDirection | setLightDirection | cliente | — |
setRadius | setLightRadius | cliente | — |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
direction | getLightDirection · setLightDirection | cliente | devolve Vector3 |
lightType | getLightType | cliente | somente leitura |
radius | getLightRadius · setLightRadius | cliente | — |
type | getLightType | cliente | somente leitura |
SearchLight
Seção intitulada “SearchLight”Holofotes.
Herda de Element.
Referência: Luzes (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
create | createSearchLight | cliente | — |
getEndPosition | getSearchLightEndPosition | cliente | devolve Vector3 |
getEndRadius | getSearchLightEndRadius | cliente | — |
getStartPosition | getSearchLightStartPosition | cliente | devolve Vector3 |
getStartRadius | getSearchLightStartRadius | cliente | — |
setEndPosition | setSearchLightEndPosition | cliente | — |
setEndRadius | setSearchLightEndRadius | cliente | — |
setStartPosition | setSearchLightStartPosition | cliente | — |
setStartRadius | setSearchLightStartRadius | cliente | — |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
endPosition | getSearchLightEndPosition · setSearchLightEndPosition | cliente | devolve Vector3 |
endRadius | getSearchLightEndRadius · setSearchLightEndRadius | cliente | — |
startPosition | getSearchLightStartPosition · setSearchLightStartPosition | cliente | devolve Vector3 |
startRadius | getSearchLightStartRadius · setSearchLightStartRadius | cliente | — |
Projectile
Seção intitulada “Projectile”Projéteis: foguetes, granadas, gás lacrimogêneo e coquetéis molotov.
Herda de Element.
Referência: Projéteis (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | createProjectile | cliente |
getCounter | getProjectileCounter | cliente |
getCreator | getProjectileCreator | cliente |
getForce | getProjectileForce | cliente |
getProjectileType | getProjectileType | cliente |
getTarget | getProjectileTarget | cliente |
getType | getProjectileType | cliente |
setCounter | setProjectileCounter | cliente |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
counter | getProjectileCounter · setProjectileCounter | cliente | — |
creator | getProjectileCreator | cliente | somente leitura |
projectileType | getProjectileType | cliente | somente leitura |
target | getProjectileTarget | cliente | somente leitura |
type | getProjectileType | cliente | somente leitura |
Elementos de arma personalizada, criados com createWeapon.
Herda de Element.
Referência: Armas (compartilhadas) · Armas (servidor) · Armas (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | createWeapon | cliente |
fire | fireWeapon | cliente |
getAmmo | getWeaponAmmo | cliente |
getClipAmmo | getWeaponClipAmmo | cliente |
getFiringRate | getWeaponFiringRate | cliente |
getFlags | getWeaponFlags | cliente |
getOwner | getWeaponOwner | cliente |
getProperty | getWeaponProperty | cliente |
getState | getWeaponState | cliente |
getTarget | getWeaponTarget | cliente |
isRenderEnabled | isWeaponRenderEnabled | cliente |
resetFiringRate | resetWeaponFiringRate | cliente |
setAmmo | setWeaponAmmo | cliente |
setClipAmmo | setWeaponClipAmmo | cliente |
setFiringRate | setWeaponFiringRate | cliente |
setFlags | setWeaponFlags | cliente |
setProperty | setWeaponProperty | cliente |
setRenderEnabled | setWeaponRenderEnabled | cliente |
setState | setWeaponState | cliente |
setTarget | setWeaponTarget | cliente |
Propriedades
| Propriedade | Acessores | Lado |
|---|---|---|
ammo | getWeaponAmmo · setWeaponAmmo | cliente |
clipAmmo | getWeaponClipAmmo · setWeaponClipAmmo | cliente |
firingRate | getWeaponFiringRate · setWeaponFiringRate | cliente |
state | getWeaponState · setWeaponState | cliente |
Elementos SVG que renderizam documentos vetoriais em uma textura.
Herda de Element.
Referência: SVG (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | svgCreate | cliente |
getDocumentXML | svgGetDocumentXML | cliente |
getSize | svgGetSize | cliente |
setDocumentXML | svgSetDocumentXML | cliente |
setSize | svgSetSize | cliente |
setUpdateCallback | svgSetUpdateCallback | cliente |
Connection
Seção intitulada “Connection”Conexões ao banco de dados devolvidas por dbConnect.
Herda de Element.
Referência: Banco de dados (servidor)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | dbConnect | servidor |
exec | dbExec | servidor |
prepareString | dbPrepareString | servidor |
query | dbQuery | servidor |
DxMaterial
Seção intitulada “DxMaterial”A base de todo material desenhável. Não é criada diretamente.
Herda de Element.
Referência: Texturas, shaders e render targets (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
getSize | dxGetMaterialSize | cliente |
DxTexture
Seção intitulada “DxTexture”Texturas carregadas de arquivo ou criadas em branco.
Herda de DxMaterial.
Referência: Texturas, shaders e render targets (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | dxCreateTexture | cliente |
getPixels | dxGetTexturePixels | cliente |
setEdge | dxSetTextureEdge | cliente |
setPixels | dxSetTexturePixels | cliente |
DxRenderTarget
Seção intitulada “DxRenderTarget”Render targets em que você pode desenhar.
Herda de DxTexture.
Referência: Texturas, shaders e render targets (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | dxCreateRenderTarget | cliente |
setAsTarget | dxSetRenderTarget | cliente |
DxScreenSource
Seção intitulada “DxScreenSource”Capturas de tela que podem ser usadas como textura.
Herda de DxTexture.
Referência: Texturas, shaders e render targets (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | dxCreateScreenSource | cliente |
update | dxUpdateScreenSource | cliente |
DxShader
Seção intitulada “DxShader”Shaders HLSL.
Herda de DxMaterial.
Referência: Texturas, shaders e render targets (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
applyToWorldTexture | engineApplyShaderToWorldTexture | cliente |
create | dxCreateShader | cliente |
removeFromWorldTexture | engineRemoveShaderFromWorldTexture | cliente |
setTessellation | dxSetShaderTessellation | cliente |
setTransform | dxSetShaderTransform | cliente |
setValue | dxSetShaderValue | cliente |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
tessellation | dxSetShaderTessellation | cliente | somente escrita |
Fontes personalizadas.
Herda de Element.
Referência: Texturas, shaders e render targets (cliente)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
create | dxCreateFont | cliente | — |
getHeight | dxGetFontHeight | cliente | self é o argumento 2 |
getTextWidth | dxGetTextWidth | cliente | self é o argumento 3 |
Navegadores Direct UI renderizados em uma textura.
Herda de Element.
Referência: DUI e texturas runtime (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | createDui | cliente |
destroy | destroyDui | cliente |
getHandle | getDuiHandle | cliente |
isAvailable | isDuiAvailable | cliente |
sendMessage | sendDuiMessage | cliente |
sendMouseDown | sendDuiMouseDown | cliente |
sendMouseMove | sendDuiMouseMove | cliente |
sendMouseUp | sendDuiMouseUp | cliente |
sendMouseWheel | sendDuiMouseWheel | cliente |
setUrl | setDuiUrl | cliente |
EngineCOL
Seção intitulada “EngineCOL”Modelos de colisão — o elemento col que engineLoadCOL devolve.
Herda de Element.
Referência: Engine e modelos (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | engineLoadCOL | cliente |
replace | engineReplaceCOL | cliente |
restore | engineRestoreCOL | cliente |
EngineDFF
Seção intitulada “EngineDFF”Modelos — o elemento dff que engineLoadDFF devolve.
Herda de Element.
Referência: Engine e modelos (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | engineLoadDFF | cliente |
replace | engineReplaceModel | cliente |
restore | engineRestoreModel | cliente |
EngineTXD
Seção intitulada “EngineTXD”Dicionários de textura — o elemento txd que engineLoadTXD devolve.
Herda de Element.
Referência: Engine e modelos (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
create | engineLoadTXD | cliente |
free | engineFreeTXD | cliente |
import | engineImportTXD | cliente |
EngineIMG
Seção intitulada “EngineIMG”Arquivos IMG — o elemento img que engineLoadIMG devolve.
Herda de Element.
Referência: Engine e modelos (cliente)
Métodos
| Método | Nativa | Lado |
|---|---|---|
add | engineAddImage | cliente |
create | engineLoadIMG | cliente |
getFile | engineImageGetFile | cliente |
getFiles | engineImageGetFiles | cliente |
getFilesCount | engineImageGetFilesCount | cliente |
linkDFF | engineImageLinkDFF | cliente |
linkTXD | engineImageLinkTXD | cliente |
remove | engineRemoveImage | cliente |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
files | engineImageGetFiles | cliente | somente leitura |
filesCount | engineImageGetFilesCount | cliente | somente leitura |
Arquivos dentro da pasta do resource. No cliente, fileOpen e fileCreate devolvem um elemento file atendido por esta classe. No servidor eles devolvem um número simples, então ali os membros só funcionam chamados de forma plana na tabela da classe — File.read(handle, 16) — e as propriedades ficam fora de alcance.
File não tem classe-pai: um arquivo atende aos membros abaixo e a nada de Element. File.create(caminho), e portanto File(caminho), abre o arquivo para leitura e escrita quando ele existe e o cria quando não existe; open e new são fileOpen e fileCreate puros. exists, copy, rename e delete recebem caminhos, não um arquivo, então chame-os na classe: File.exists("dados.json").
Referência: Arquivos (compartilhadas)
Métodos
| Método | Nativa | Lado | Notas |
|---|---|---|---|
close | fileClose | ambos | — |
copy | fileCopy | ambos | — |
create | fileOpen | ambos | abre ou cria — veja acima |
delete | fileDelete | ambos | — |
exists | fileExists | ambos | — |
flush | fileFlush | ambos | — |
getContents | fileGetContents | ambos | — |
getHash | fileGetHash | ambos | — |
getPath | fileGetPath | ambos | — |
getPos | fileGetPos | ambos | — |
getSize | fileGetSize | ambos | — |
isEOF | fileIsEOF | ambos | — |
new | fileCreate | ambos | — |
open | fileOpen | ambos | — |
read | fileRead | ambos | — |
rename | fileRename | ambos | — |
setPos | fileSetPos | ambos | — |
write | fileWrite | ambos | — |
Propriedades
| Propriedade | Acessores | Lado | Notas |
|---|---|---|---|
eof | fileIsEOF | ambos | somente leitura |
path | fileGetPath | ambos | somente leitura |
pos | fileGetPos · fileSetPos | ambos | — |
size | fileGetSize | ambos | somente leitura |