← Back to branch summary

~diresu/blender/blender-command-port

« back to all changes in this revision

Viewing changes to source/blender/python/api2_2x/doc/id_generics.py

  • Committer: theeth
  • Date: 2008-10-14 16:52:04 UTC
  • Revision ID: vcs-imports@canonical.com-20081014165204-r32w2gm6s0osvdhn
copy back trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/blender/python/api2_2x/doc/id_generics.py
 
1
attributes = """
 
2
        @ivar name: unique name within each blend file.
 
3
                
 
4
                The name is case sensitive and 21 characters maximum length.
 
5
 
 
6
                B{Note}: a blend file may have naming collisions when external library data is used,
 
7
                be sure to check the value of L{lib}.
 
8
 
 
9
                B{Note}: Setting a value longer then 21 characters will be shortened
 
10
        @type name: string
 
11
        @ivar lib: path to the blend file this datablock is stored in (readonly).
 
12
 
 
13
                lib will be None unless you are using external blend files with (File, Append/Link)
 
14
 
 
15
                B{Note}: the path may be relative, to get the full path use L{Blender.sys.expandpath<Sys.expandpath>}
 
16
        @type lib: string or None
 
17
        
 
18
        @ivar fakeUser: When set to True, this datablock wont be removed, even if nothing is using it.
 
19
                All data has this disabled by default except for Actions.       
 
20
        @type fakeUser: bool
 
21
        @ivar tag: A temporary tag that to flag data as being used within a loop.
 
22
                always set all tags to True or False before using since blender uses this flag for its own internal operations.
 
23
        @type tag: bool
 
24
        @ivar users: The number of users this datablock has. (readonly)
 
25
                Zero user datablocks are de-allocated after reloading and saving.
 
26
        @type users: int
 
27
        @ivar properties: Returns an L{IDGroup<IDProp.IDGroup>} reference to this 
 
28
        datablocks's ID Properties.
 
29
        @type properties: L{IDGroup<IDProp.IDGroup>}
 
30
"""
 
 
b'\\ No newline at end of file'