Classes
Melee
A Melee represents an Entity which can be Pickable by a Character and can be used to melee attack, Characters can hold it with hands with pre-defined handling modes.
13 own 132 inherited
Constructors 1
Functions 11
- AddAnimationCharacterUse Sets an Animation when attacking
- ClearAnimationsCharacterUse Clears the Character Attack Animation list
- GetAnimationsCharacterUse Gets the Animations when Character uses it
- GetBaseDamage Gets the Base Damage
- GetCooldown Gets the Cooldown between usages
- GetSoundUse Gets the Sound when Character uses it
- SetBaseDamage Sets the Base Damage
- SetCooldown Sets the cooldown between attacking
- SetDamageSettings Sets the times when to start applying damage and when to end
- SetImpactSound Sets the Sound when hitting something
- SetSoundUse Sets the Sound when attacking
Events 1
Inherited members 132
Pickable 26
- AddSkeletalMeshAttached Attaches a Skeletal Mesh as master pose to this entity
- AddStaticMeshAttached Attaches a Static Mesh to this entity
- GetAllSkeletalMeshAttached Gets all Skeletal Meshes attached to this entity
- GetAllStaticMeshAttached Gets all Static Meshes attached to this entity
- GetHandler Gets the Character, if it exists, that's holding this Pickable
- GetHandlingMode Gets the Handling Mode of this Pickable
- GetMesh Gets the name of the asset this Pickable uses
- PullUse Pulls the usage of this Pickable (will start firing if this is a weapon)
- ReleaseUse Releases the usage of this Pickable (will stop firing if this is a weapon)
- RemoveAllSkeletalMeshesAttached Removes all SkeletalMeshes attached
- RemoveAllStaticMeshesAttached Removes all StaticMeshes attached
- RemoveSkeletalMeshAttached Removes, if it exists, a SkeletalMesh from this Pickable given its custom ID
- RemoveStaticMeshAttached Removes, if it exists, a StaticMesh from this Pickable given its custom ID
- SetAttachmentSettings Sets the Attachment Settings for this Pickable (how it attaches to the Character when Picking up)
- SetBuoyancyPontoons Sets the Buoyancy Pontoons used by the Water simulation
- SetBuoyancySettings Sets how this entity behaves on Water
- SetCanUse Sets if this Pickable can be used by the player when held
- SetCrosshairMaterial Sets the crosshair material for this Pickable
- SetPickable Sets if this Pickable can be picked up from ground by the player
- SetStaticMeshAttachedTransform Sets a Static Mesh Attached location and rotation
- Drop When a Character drops this Pickable
- Hit When this Pickable hits something
- Interact Triggered when a Character interacts with this Pickable (i.e. tries to pick it up)
- PickUp Triggered When a Character picks this up
- PullUse Triggered when a Character presses the use button for this Pickable (i.e. clicks left mouse button with this equipped)
- ReleaseUse Triggered when a Character releases the use button for this Pickable (i.e. releases left mouse button with this equipped)
Paintable 14
- GetMaterialColorParameter Gets a Color parameter from this Actor's material
- GetMaterialScalarParameter Gets a Scalar parameter from this Actor's material
- GetMaterialTextureParameter Gets a Texture parameter from this Actor's material
- GetMaterialVectorParameter Gets a Vector parameter from this Actor's material
- ResetMaterial Resets the material from the specified index to the original one
- SetMaterial Sets the material at the specified index of this Actor
- SetMaterialColorParameter Sets a Color parameter in this Actor's material
- SetMaterialFromCanvas Sets the material at the specified index of this Actor to a Canvas object
- SetMaterialFromSceneCapture Sets the material at the specified index of this Actor to a SceneCapture object
- SetMaterialFromWebUI Sets the material at the specified index of this Actor to a WebUI object
- SetMaterialScalarParameter Sets a Scalar parameter in this Actor's material
- SetMaterialTextureParameter Sets a texture parameter in this Actor's material to an image
- SetMaterialVectorParameter Sets a Vector parameter in this Actor's material
- SetPhysicalMaterial Overrides this Actor's Physical Material with a new one
Actor 57
- AddActorTag Adds an Unreal Actor Tag to this Actor
- AddAngularImpulse Add an angular impulse to this Actor. Good for one time instant burst
- AddImpulse Add an impulse to this Actor. Good for one time instant burst
- AttachTo Attaches this Actor to any other Actor, optionally at a specific bone
- Detach Detaches this Actor from AttachedTo Actor
- GetActorTags Gets all Unreal Actor Tags on this Actor
- GetAngularForce Gets this Actor's angular force (set by <code>SetAngularForce()</code>)
- GetAngularVelocity Returns the angular velocity of this Actor
- GetAttachedEntities Gets all Actors attached to this Actor
- GetAttachedTo Gets the Actor this Actor is attached to
- GetBounds Gets this Actor's bounds
- GetCollision Gets this Actor's collision type
- GetDimension Gets this Actor's dimension
- GetDistanceFromCamera Gets the distance of this Actor from the Camera
- GetForce Gets this Actor's force (set by <code>SetForce()</code>)
- GetLocation Gets this Actor's location in the game world
- GetMass Returns the mass of this Actor
- GetNetworkAuthority Gets this Actor's Network Authority Player
- GetRelativeLocation Gets this Actor's Relative Location if it's attached
- GetRelativeRotation Gets this Actor's Relative Rotation if it's attached
- GetRotation Gets this Actor's angle in the game world
- GetScale Gets this Actor's scale
- GetScreenPercentage Gets the percentage of this Actor size in the screen
- GetSocketTransform Gets a Socket Transform in world space given a bone or socket name
- GetVelocity Gets this Actor's current velocity
- HasNetworkAuthority Returns true if the local Player is currently the Network Authority of this Actor
- IsGravityEnabled Returns true if gravity is enabled on this Actor
- IsInWater Returns true if this Actor is in water
- IsNetworkDistributed Returns true if this Actor is currently network distributed
- IsVisible Returns true if this Actor is visible
- RemoveActorTag Removes an Unreal Actor Tag from this Actor
- RotateTo Smoothly rotates this actor to an angle over a certain time
- SetAngularForce Adds a permanent angular force to this Actor, set to Vector(0, 0, 0) to cancel
- SetCastShadow Sets this Actor's to cast shadows or not
- SetCollision Sets this Actor's collision type
- SetDimension Sets this Actor's Dimension
- SetDistanceOptimizationMultiplier Sets this Actor's distance optimization multiplier
- SetForce Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
- SetGravityEnabled Sets whether gravity is enabled on this Actor
- SetHighlightEnabled Sets whether the highlight is enabled on this Actor, and which highlight index to use
- SetLifeSpan Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
- SetLocation Sets this Actor's location in the game world
- SetNetworkAuthority Sets the Player to have network authority over this Actor
- SetNetworkAuthorityAutoDistributed Sets if this Actor will auto distribute the network authority between players
- SetOutlineEnabled Sets whether the outline is enabled on this Actor, and which outline index to use
- SetRelativeLocation Sets this Actor's relative location in local space (only if this actor is attached)
- SetRelativeRotation Sets this Actor's relative rotation in local space (only if this actor is attached)
- SetRenderCullDistance Sets this Actor's render cull distance
- SetRotation Sets this Actor's rotation in the game world
- SetScale Sets this Actor's scale
- SetVisibility Sets whether the actor is visible or not
- TranslateTo Smoothly moves this actor to a location over a certain time
- WasRecentlyRendered Gets if this Actor was recently rendered on screen
- DimensionChange Triggered when an Actor changes its dimension
- EnterWater Triggered when an Actor enters a water body
- LeaveWater Triggered when an Actor leaves a water body
- NetworkAuthorityChange Triggered when the local Player gets/loses network authority over this actor
Entity 35
- GetAll Returns a table containing all Entities of the class this is called on
- GetByIndex Returns a specific Entity of this class at an index
- GetCount Returns how many Entities of this class exist
- GetInheritedClasses Gets a list of all directly inherited classes from this Class created with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- GetPairs Returns an iterator with all Entities of this class to be used with <code>pairs()</code>
- GetParentClass Gets the parent class if this Class was created with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- Inherit Inherits this class with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- IsChildOf Gets if this Class is child of another class if this Class was created with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- Subscribe Subscribes to an <a href='/docs/core-concepts/scripting/events-guide'>Event</a> for all entities of this Class
- SubscribeRemote Subscribes to a custom event called from server
- Unsubscribe Unsubscribes all callbacks from this <a href='/docs/core-concepts/scripting/events-guide'>Event</a> in this Class within this Package, or only the callback passed
- BroadcastRemoteEvent Calls a custom remote event directly on this entity to all Players
- BroadcastRemoteInRadiusEvent Calls a custom remote event directly on this entity to all Players in a radius
- CallRemoteEvent Calls a custom remote event directly on this entity
- CallRemotePlayersEvent Calls a custom remote event directly on this entity to a list of Players
- Destroy Destroys this Entity
- FinishSpawn Finish the spawning process and send the entity to clients if it was spawned with a deferred <code>spawn_mode</code>
- GetAllValuesKeys Gets a list of all values keys
- GetClass Gets the class of this entity
- GetID Gets the universal network ID of this Entity (same on both client and server)
- GetValue Gets a <a href='/docs/core-concepts/scripting/entity-values'>Value</a> stored on this Entity at the given key
- HasAuthority Gets if the local context has authority over this Entity (true if spawned by the client, false if spawned by the server)
- IsA Recursively checks if this entity is <a href='/docs/core-concepts/scripting/inheriting-classes'>inherited</a> from a Class
- IsBeingDestroyed Returns true if this Entity is being destroyed
- IsSpawned Gets if this Entity finished spawning
- IsValid Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
- SetSpawnMode Overrides when this Entity finishes spawning, from the Constructor of an Inherited Class
- SetValue Sets a <a href='/docs/core-concepts/scripting/entity-values'>Value</a> in this Entity
- Subscribe Subscribes to an <a href='/docs/core-concepts/scripting/events-guide'>Event</a> on this specific entity
- SubscribeRemote Subscribes to a custom event called from server on this specific entity
- Unsubscribe Unsubscribes all callbacks from this <a href='/docs/core-concepts/scripting/events-guide'>Event</a> in this Entity within this Package, or only the callback passed
- ClassRegister Triggered when a new Class is registered with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- Destroy Triggered when an Entity is destroyed
- Spawn Triggered when an Entity is spawned/created
- ValueChange Triggered when an Entity has a value changed with <code>:SetValue()</code>