Entity/ObjectCaps

From Garry's Mod
(Difference between revisions)
Jump to: navigation, search
(Added required arguments and type of returned value)
(Documented function, we don't have the Lau enums tho, so a link to the github will do.)
Line 2: Line 2:
 
|Name=ObjectCaps
 
|Name=ObjectCaps
 
|Parent=Entity
 
|Parent=Entity
 +
|Description=Returns the entity's capabilities as a bitfield.<br>
 +
In the engine this function is mostly used to check the use type, the save/restore system and level transitions flags.
 +
 +
Even though the function is defined shared, it is not guaranteed to return the same value across states.
 +
 +
'''NOTE:'''The enums for this are not currently implemented in Lua, however you can access the defines [https://github.com/ValveSoftware/source-sdk-2013/blob/55ed12f8d1eb6887d348be03aee5573d44177ffb/mp/src/game/shared/baseentity_shared.h#L21-L38 here].
 
|Realm=Shared
 
|Realm=Shared
 
|IsClass=Yes
 
|IsClass=Yes
Line 7: Line 13:
 
{{Ret
 
{{Ret
 
|type=number
 
|type=number
 +
|desc=The bitfield, a combination of the [https://github.com/ValveSoftware/source-sdk-2013/blob/55ed12f8d1eb6887d348be03aee5573d44177ffb/mp/src/game/shared/baseentity_shared.h#L21-L38 FCAP_] flags.
 
}}
 
}}

Revision as of 09:45, 28 January 2015

 Entity:ObjectCaps( )

Description

Returns the entity's capabilities as a bitfield.
In the engine this function is mostly used to check the use type, the save/restore system and level transitions flags.

Even though the function is defined shared, it is not guaranteed to return the same value across states.

NOTE:The enums for this are not currently implemented in Lua, however you can access the defines here.

Returns

number

The bitfield, a combination of the FCAP_ flags.
Personal tools
Navigation