LuaDocs/Magazine

From Data Realms Wiki

(Difference between revisions)
Jump to: navigation, search
(Magazine - Automatically generated by LuaBot)
(Magazine - Automatically generated by LuaBot)
 
(3 intermediate revisions not shown)
Line 11: Line 11:
===ClassName===
===ClassName===
The class name of this Entity.A string with the friendly-formatted type name of this object.
The class name of this Entity.A string with the friendly-formatted type name of this object.
 +
 +
===NextRound===
 +
Read-only property. The next Round preset of ammo in this Magazine, without removing it. Ownership IS NOT transferred!A pointer to the next Round preset of ammo, or 0 if this Magazine is empty.
===RoundCount===
===RoundCount===
-
Returns how many rounds are left in this Magazine.The number of rounds left.
+
Returns how many rounds are left in this Magazine.The number of rounds left. Negative value means infinite ammo left!
===IsEmpty===
===IsEmpty===

Latest revision as of 08:57, 15 May 2014

Contents

Parent: Attachable

Concrete Class. An Attachable ammo magazine that can hold rounds that can be fired by HDFirearm:s.

Go back to Class Index


Properties

ClassName

The class name of this Entity.A string with the friendly-formatted type name of this object.

NextRound

Read-only property. The next Round preset of ammo in this Magazine, without removing it. Ownership IS NOT transferred!A pointer to the next Round preset of ammo, or 0 if this Magazine is empty.

RoundCount

Returns how many rounds are left in this Magazine.The number of rounds left. Negative value means infinite ammo left!

IsEmpty

Read-only property. Returns whether this Magazine is out of rounds.Whether this Magazine is out of rounds or not.

IsFull

Read-only property. Returns whether this Magazine has not used up any rounds yet.Whether this Magazine has not used any rounds yet.

IsOverHalfFull

Read-only property. Returns whether this Magazine has not used up half of the rounds yet.Whether this Magazine has not used half of its rounds yet.

Capacity

Read-only property. Returns teh number of rounds this can hold when it's full.The number of rounds this can hold. Negative value means infinite ammo.

Discardable

Read-only property. Whether this Magazine should be released into the scene when discarded or just deleted.Whether this Magazine should be relesed into scene or deleted when released.


Go back to Class Index

Personal tools