Enfusion Script API
Loading...
Searching...
No Matches
Visual

Classes

interface  Animation
 
interface  Color
 
interface  Material
 
interface  Particles
 Script API to Particle Effect Component. More...
 

Enumerations

enum  CameraLensFlareSetType {
  CameraLensFlareSetType.None , CameraLensFlareSetType.User , CameraLensFlareSetType.FirstPerson , CameraLensFlareSetType.ThirdPerson ,
  CameraLensFlareSetType.COUNT
}
 Type of the camera lens flare set. More...
 
enum  EmitterParam {
  EmitterParam.SHAPE_SIZE , EmitterParam.CONEANGLE , EmitterParam.EMITOFFSET , EmitterParam.VELOCITY ,
  EmitterParam.VELOCITY_AFFECT , EmitterParam.VELOCITY_RND , EmitterParam.AVELOCITY , EmitterParam.SIZE ,
  EmitterParam.SIZE_RND , EmitterParam.STRETCH , EmitterParam.RANDOM_ANGLE , EmitterParam.RANDOM_ROT ,
  EmitterParam.LOCAL_TRANSFORM , EmitterParam.AIR_RESISTANCE , EmitterParam.AIR_RESISTANCE_RND , EmitterParam.GRAVITY_SCALE ,
  EmitterParam.GRAVITY_SCALE_RND , EmitterParam.BIRTH_RATE , EmitterParam.BIRTH_RATE_RND , EmitterParam.LIFETIME ,
  EmitterParam.LIFETIME_RND , EmitterParam.LIFETIME_BY_ANIM , EmitterParam.ANIM_ONCE , EmitterParam.RAND_FRAME ,
  EmitterParam.EMITTING_TIME , EmitterParam.REPEAT , EmitterParam.CURRENT_TIME , EmitterParam.ACTIVE_PARTICLES ,
  EmitterParam.WIND , EmitterParam.SPRING , EmitterParam.SCALE_X , EmitterParam.SCALE_Y ,
  EmitterParam.CENTER_X , EmitterParam.CENTER_Y , EmitterParam.MAX_LV
}
 Emitter param enumeration for GetParam and SetParam methods. More...
 
enum  LightFlags {
  LightFlags.CHEAP , LightFlags.CASTSHADOW , LightFlags.LOOKUP , LightFlags.DIFFUSE_ONLY ,
  LightFlags.SKY , LightFlags.DYNAMIC
}
 
enum  LightLensFlareType { LightLensFlareType.Automatic , LightLensFlareType.Manual , LightLensFlareType.Disabled }
 Type of the light lens flare. More...
 
enum  LightType {
  LightType.NONE , LightType.AMBIENT , LightType.POINT , LightType.SPOT ,
  LightType.DIRECTIONAL , LightType.PROBE
}
 
enum  MeshObjectFlags { MeshObjectFlags.CUSTOM , MeshObjectFlags.DYNAMIC_VERTEXES , MeshObjectFlags.DUMMY_TANGENTS , MeshObjectFlags.UPDATE_BOUNDBOX }
 
enum  VCFlags {
  VCFlags.NOFILTER , VCFlags.INHERIT_PARENT_VISIBILITY , VCFlags.NOSHADOW , VCFlags.NOLIGHT ,
  VCFlags.DYNAMICBBOX , VCFlags.WINDRECEIVER , VCFlags.INHERIT_PARENT_SKELETON , VCFlags.NO_FAR_SHADOW ,
  VCFlags.NO_RAIN_OCCLUDER , VCFlags.NO_WETNESS_OCCLUDER , VCFlags.CLUTTER_MASK , VCFlags.WETNESS_ADDER
}
 VObjectComponent flags. More...
 

Detailed Description

Enumeration Type Documentation

◆ CameraLensFlareSetType

Type of the camera lens flare set.

Enumerator
None 

No lens flare set (lens flares are disabled)

User 

User lens flare set identified by the string.

FirstPerson 

Use first person lens flare set.

ThirdPerson 

Use third person lens flare set.

COUNT 

◆ EmitterParam

Emitter param enumeration for GetParam and SetParam methods.

Enumerator
SHAPE_SIZE 

Vector3.

CONEANGLE 

Vector3.

EMITOFFSET 

Vector3.

VELOCITY 

Float.

VELOCITY_AFFECT 

Float.

VELOCITY_RND 

Float.

AVELOCITY 

Float.

SIZE 

Float.

SIZE_RND 

Float.

STRETCH 

Float.

RANDOM_ANGLE 

Bool.

RANDOM_ROT 

Bool.

LOCAL_TRANSFORM 

Bool.

AIR_RESISTANCE 

Float.

AIR_RESISTANCE_RND 

Float.

GRAVITY_SCALE 

Float.

GRAVITY_SCALE_RND 

Float.

BIRTH_RATE 

Float.

BIRTH_RATE_RND 

Float.

LIFETIME 

Float.

LIFETIME_RND 

Float.

LIFETIME_BY_ANIM 

Bool.

ANIM_ONCE 

Bool.

RAND_FRAME 

Bool.

EMITTING_TIME 

Float.

REPEAT 

Bool.

CURRENT_TIME 

Float, Read only: incompatible with GetParamOrig() and MultParam()

ACTIVE_PARTICLES 

Int, Read only: incompatible with GetParamOrig() and MultParam()

WIND 

Bool.

SPRING 

Float.

SCALE_X 

Float.

SCALE_Y 

Float.

CENTER_X 

Float.

CENTER_Y 

Float.

MAX_LV 

Float.

◆ LightFlags

enum LightFlags
Enumerator
CHEAP 

Cheap hint for explosion, muzzles etc.

CASTSHADOW 

Casts shadows.

LOOKUP 

Light does lookup to cubic texture.

DIFFUSE_ONLY 

Light contributes to diffuse component only (has disabled specular component)

SKY 

Special type of light from sky. It's used as directional+ambient light for ambient pass.

DYNAMIC 

Is it dynamic light.

◆ LightLensFlareType

Type of the light lens flare.

Enumerator
Automatic 

Lens flare is determined automatically by the light type.

Manual 

Lens flare is determined manually by lens flare index.

Disabled 

Lens flare is disabled.

◆ LightType

enum LightType
Enumerator
NONE 
AMBIENT 
POINT 
SPOT 
DIRECTIONAL 
PROBE 

◆ MeshObjectFlags

Enumerator
CUSTOM 

Mesh created through MeshObject.Create.

DYNAMIC_VERTEXES 

Hint for dynamic HW buffers.

DUMMY_TANGENTS 
UPDATE_BOUNDBOX 

Geometry has changed. Bound-box is dirty.

◆ VCFlags

enum VCFlags

VObjectComponent flags.

Enumerator
NOFILTER 

Don't filter too small objects.

INHERIT_PARENT_VISIBILITY 

Inherit visibility from parent.

NOSHADOW 

This instance do not cast shadows.

NOLIGHT 

This instance ignore light interactions.

DYNAMICBBOX 

Dynamic bounding box.

WINDRECEIVER 

Receives wind emitters.

INHERIT_PARENT_SKELETON 

Animated by parent entity.

NO_FAR_SHADOW 

This instance does not cast far shadows.

NO_RAIN_OCCLUDER 

This instance should not occlude rain.

NO_WETNESS_OCCLUDER 

This instance should not occlude wetness.

CLUTTER_MASK 

This instance should occlude clutter.

WETNESS_ADDER 

This instance should add wetness.